{"id":4348,"date":"2012-02-20T17:18:19","date_gmt":"2012-02-20T22:18:19","guid":{"rendered":"http:\/\/jianmingli.com\/wp\/?p=4348"},"modified":"2020-11-05T12:59:22","modified_gmt":"2020-11-05T17:59:22","slug":"maven-2","status":"publish","type":"post","link":"https:\/\/jianmingli.com\/wp\/?p=4348","title":{"rendered":"Maven 2 Overview"},"content":{"rendered":"
\n

Contents<\/h2>\n
    \n\t
  1. \n\t\tInstall<\/a>\n\t<\/li>\n\t
  2. \n\t\tOverview<\/a>\n\t\t
      \n\t\t\t
    1. \n\t\t\t\tDefault Local Repository<\/a>\n\t\t\t<\/li>\n\t\t\t
    2. \n\t\t\t\tLife Cycle Phases<\/a>\n\t\t\t<\/li>\n\t\t\t
    3. \n\t\t\t\tMaven Plugins<\/a>\n\t\t\t<\/li>\n\t\t\t
    4. \n\t\t\t\tGenerate a List of Archetypes<\/a>\n\t\t\t<\/li>\n\t\t\t
    5. \n\t\t\t\tCopy a Jar File to Local Repository<\/a>\n\t\t\t<\/li>\n\t\t\t
    6. \n\t\t\t\tMaven Help<\/a>\n\t\t\t<\/li>\n\t\t\t
    7. \n\t\t\t\tSite Report<\/a>\n\t\t\t<\/li>\n\t\t\t
    8. \n\t\t\t\tResources<\/a>\n\t\t\t<\/li>\n\t\t<\/ol>\n\t
    9. \n\t\tProject Dependencies<\/a>\n\t\t
        \n\t\t\t
      1. \n\t\t\t\tProject Scope<\/a>\n\t\t\t<\/li>\n\t\t\t
      2. \n\t\t\t\tDependency Version Range<\/a>\n\t\t\t<\/li>\n\t\t\t
      3. \n\t\t\t\tdependencyManagement<\/a>\n\t\t\t<\/li>\n\t\t\t
      4. \n\t\t\t\tProject Coordinates<\/a>\n\t\t\t<\/li>\n\t\t\t
      5. \n\t\t\t\tProject Inheritance<\/a>\n\t\t\t<\/li>\n\t\t\t
      6. \n\t\t\t\tGroup Dependencies<\/a>\n\t\t\t<\/li>\n\t\t\t
      7. \n\t\t\t\tInheritance or Multi-Module Composition<\/a>\n\t\t\t<\/li>\n\t\t<\/ol>\n\t
      8. \n\t\tThe Build Lifecycle<\/a>\n\t\t
          \n\t\t\t
        1. \n\t\t\t\tClean Lifecycle<\/a>\n\t\t\t<\/li>\n\t\t\t
        2. \n\t\t\t\tDefault Lifecycle<\/a>\n\t\t\t\t
            \n\t\t\t\t\t
          1. \n\t\t\t\t\t\tSources<\/a>\n\t\t\t\t\t<\/li>\n\t\t\t\t\t
          2. \n\t\t\t\t\t\tResources<\/a>\n\t\t\t\t\t<\/li>\n\t\t\t\t\t
          3. \n\t\t\t\t\t\tTest<\/a>\n\t\t\t\t\t<\/li>\n\t\t\t\t\t
          4. \n\t\t\t\t\t\tPackage<\/a>\n\t\t\t\t\t<\/li>\n\t\t\t\t\t
          5. \n\t\t\t\t\t\tIntegration Test<\/a>\n\t\t\t\t\t<\/li>\n\t\t\t\t\t
          6. \n\t\t\t\t\t\tInstall and Deploy<\/a>\n\t\t\t\t\t<\/li>\n\t\t\t\t<\/ol>\n\t\t\t
          7. \n\t\t\t\tSite Lifecycle<\/a>\n\t\t\t<\/li>\n\t\t\t
          8. \n\t\t\t\tPackaging Specific Lifecycles<\/a>\n\t\t\t<\/li>\n\t\t<\/ol>\n\t
          9. \n\t\tCommon Lifecycle Goals<\/a>\n\t\t
              \n\t\t\t
            1. \n\t\t\t\tProcess Resources<\/a>\n\t\t\t\t
                \n\t\t\t\t\t
              1. \n\t\t\t\t\t\tResource Filtering (Token Replacement)<\/a>\n\t\t\t\t\t<\/li>\n\t\t\t\t\t
              2. \n\t\t\t\t\t\tMultiple Resource Directories<\/a>\n\t\t\t\t\t<\/li>\n\t\t\t\t<\/ol>\n\t\t\t
              3. \n\t\t\t\tCompile<\/a>\n\t\t\t<\/li>\n\t\t<\/ol>\n\t
              4. \n\t\tSample Webapp Project<\/a>\n\t<\/li>\n\t
              5. \n\t\tReferences<\/a>\n\t<\/li>\n<\/ol>\n<\/ol>\n<\/div>\n
                 <\/div>\n

                Install<\/h2><\/span>\n

                * Download Maven, e.g. apache-maven-2.2.1-bin.zip<\/a>, from Maven download site: http:\/\/maven.apache.org\/download.html<\/a>
                \n* Unzip content into a local directory, e.g. C:\\prog<\/em>
                \n* Create an environment variable called MAVEN_HOME<\/strong> and point it to where maven was unzipped, e.g. C:\\prog\\apache-maven-2.2.1<\/em>
                \n* Add %MAVEN_HOME%\\bin<\/strong> to PATH<\/em>
                \n* Run mvn -v<\/strong> to verify install<\/p>\n

                \r\nmvn -v\r\nApache Maven 2.2.1 (r801777; 2009-08-06 15:16:01-0400)\r\nJava version: 1.6.0_25\r\nJava home: C:\\Program Files\\Java\\jdk1.6.0_25\\jre\r\nDefault locale: en_US, platform encoding: Cp1252\r\nOS name: \"windows 7\" version: \"6.1\" arch: \"amd64\" Family: \"windows\"\r\n<\/pre>\n
                Overview<\/h2><\/span>\n
                Default Local Repository<\/h3><\/span>\n
                * Default local repository: home_dir\/.m2\/repository<\/em>, e.g. C:\\Users\\jli\\.m2\\repository<\/em><\/p>\n
                \"\"<\/a><\/h6><\/span>\n
                * Local repository can be configured in conf\/settings.xml<\/em> file:<\/p>\n
                \r\n  \r\n<\/pre>\n
                Life Cycle Phases<\/h3><\/span>\n
                validate, generate-sources, process-sources, generate-resources, process- resources, compile, process-classes, generate-test-sources, process-test- sources, generate-test-resources, process-test-resources, test-compile, test, prepare-package, package, integration-test, verify, install, deploy.<\/strong>
                \n* Commonly used: validate, compile, test, package, install, deploy, clean, site<\/strong><\/p>\n
                Maven Plugins<\/h3><\/span>\n
                * Phases are made of plugins which contain goals.
                \n* Maven is a framework of orderly execution of plugin goals.
                \n* See                 this post<\/a><\/p>\n
                Generate a List of Archetypes<\/h3><\/span>\n
                Archetype list could be long. Here is simple way to get a list of all archetypes:
                \n* Redirect output to a file<\/p>\n
                \r\nmvn archetype:generate > mvn_archetypes.txt\r\nctr-c to terminate\r\n<\/pre>\n
                * Browse mvn_archetypes.txt for archetypes
                \n* For example, sample Maven Webapp project archetype:<\/p>\n
                \r\n174: remote -> org.apache.maven.archetypes:maven-archetype-webapp (An archetype which contains a sample Maven Webapp project.)\r\n<\/pre>\n
                Copy a Jar File to Local Repository<\/h3><\/span>\n
                * For example, copy Oracle ojdbc6.jar<\/em> file to local repository:<\/p>\n
                \r\nmvn install:install-file -DgroupId=com.oracle -DartifactId=ojdbc6 -Dversion=11.2.0.2.0 -Dpackaging=jar -Dfile=\"C:\\downloads\\jdbc\\ojdbc6.jar\"\r\n<\/pre>\n
                Maven Help<\/h3><\/span>\n
                \r\n# List help goals\r\nmvn help:help\r\n\r\n# Print plugin info\r\nmvn help:describe -Dplugin=compiler\r\n\r\n# Print plugin info defail\r\nmvn help:describe -Dplugin=compiler -Ddetail\r\n<\/pre>\n
                Site Report<\/h3><\/span>\n
                \r\nmvn site\r\n<\/pre>\n
                Resources<\/h3><\/span>\n
                * A resource is a file that is used at run time but does not require compilation. For example, log4j.properties<\/em> file.<\/p>\n
                Project Dependencies<\/h2><\/span>\n
                * Can manage both internal (i.e. your projects) and external dependencies<\/p>\n
                Project Scope<\/h3><\/span>\n
                * compile<\/em>:
                \n– default scope
                \n– available in all<\/strong> (compilation, runtime, test) classpaths
                \n– packaged
                \n* provided<\/em>:
                \n– available in compilation<\/strong> classpath only<\/strong>
                \n– not<\/strong> packaged
                \n* runtime<\/em>:
                \n– available in runtime<\/strong> classpath only<\/strong>
                \n– not needed for compilation
                \n– not<\/strong> packaged
                \n* test<\/em>:
                \n– available in test<\/strong> classpath only<\/strong>
                \n– not needed for either compilation nor runtime
                \n* system<\/em>:
                \n– like provided but you must<\/strong> provide systempath<\/em> element<\/p>\n
                Dependency Version Range<\/h3><\/span>\n
                * (,)<\/em> exclusive
                \n* [,]<\/em> inclusive
                \n* Greater or equal to 3.8 but less than 4.0<\/p>\n
                \r\n[3.8,4.0)<\/version>\r\n<\/pre>\n
                * No higher than 3.8, lower versions are ok: <\/p>\n
                \r\n[,3.8]<\/version>\r\n<\/pre>\n
                dependencyManagement<\/h3><\/span>\n
                * Different from dependencies<\/em> element.
                \n* Used in parent project to specify a version number (like an env variable)
                \n* Allows child project to omit specifying version. For example:
                \n– Parent pom:<\/p>\n
                \r\n\r\n    4.0.0<\/modelVersion>\r\n    org.sonatype.mavenbook<\/groupId>\r\n    a-parent<\/artifactId>\r\n    1.0.0<\/version>\r\n    ...\r\n    \r\n        \r\n            \r\n                mysql<\/groupId>\r\n                mysql-connector-java<\/artifactId>\r\n                5.1.2<\/version>\r\n                runtime<\/scope>\r\n            <\/dependency>\r\n            ...\r\n            \r\n<\/pre>\n
                – Child pom:<\/p>\n
                \r\n\r\n    4.0.0<\/modelVersion>\r\n    \r\n        org.sonatype.mavenbook<\/groupId>\r\n        a-parent<\/artifactId>\r\n        1.0.0<\/version>\r\n    <\/parent>\r\n    project-a<\/artifactId>\r\n    ...\r\n    \r\n        \r\n            mysql<\/groupId>\r\n            mysql-connector-java<\/artifactId>\r\n        <\/dependency>\r\n    <\/dependencies>\r\n<\/project>\r\n<\/pre>\n
                Project Coordinates<\/h3><\/span>\n
                * groupId<\/em>:
                \n– Similar to Java package
                \n– Uses dot notation
                \n– For example: org.apache.maven
                \n* artifactId<\/em>:
                \n– Similar to Java class
                \n– Do not use dot notation
                \n* version<\/em>
                \n* classifier<\/em>:
                \n– Less used
                \n– Used to differentiate different builds (e.g. Java 1.4 build vs Java 6 build) based on same codes<\/p>\n
                Project Inheritance<\/h3><\/span>\n
                * Child project inherits all<\/strong> properties from parent project:
                \n– identifiers (at least one of groupId or artifactId must be overridden.)
                \n– dependencies
                \n– developers and contributors
                \n– plugin lists
                \n– reports lists
                \n– plugin executions (executions with matching ids are merged)
                \n– plugin configuration
                \n* Child pom can override parent pom
                \n* To view an effective, i.e. merged, pom:<\/p>\n
                \r\nmvn help:effective-pom\r\n<\/pre>\n
                Group Dependencies<\/h3><\/span>\n
                * Group common dependencies into a shared<\/strong> project
                \n* For example, put shared dependencies, e.g. hiberntae, spring, and mysql, in a single POM project:<\/p>\n
                \r\n\r\n    org.sonatype.mavenbook<\/groupId>\r\n    persistence-deps<\/artifactId>\r\n    1.0<\/version>\r\n    pom<\/packaging>\r\n    \r\n        \r\n            org.hibernate<\/groupId>\r\n            hibernate<\/artifactId>\r\n            ${hibernateVersion}<\/version>\r\n        <\/dependency>\r\n        \r\n            org.hibernate<\/groupId>\r\n            hibernate-annotations<\/artifactId>\r\n            ${hibernateAnnotationsVersion}<\/version>\r\n        <\/dependency>\r\n        \r\n            org.springframework<\/groupId>\r\n            spring-hibernate3<\/artifactId>\r\n            ${springVersion}<\/version>\r\n        <\/dependency>\r\n        \r\n            mysql<\/groupId>\r\n            mysql-connector-java<\/artifactId>\r\n            ${mysqlVersion}<\/version>\r\n        <\/dependency>\r\n    <\/dependencies>\r\n    \r\n        (5.1,)<\/mysqlVersion>\r\n        (2.0.6,)<\/springVersion>\r\n        3.2.5.ga<\/hibernateVersion>\r\n        3.3.0.ga<\/hibernateAnnotationsVersion>\r\n    <\/properties>\r\n<\/project>\r\n<\/pre>\n
                * Now declare a shared project dependency in project POM:<\/p>\n
                \r\n\r\n    This is a project requiring JDBC<\/description>\r\n    ...\r\n    \r\n        ...\r\n        \r\n            org.sonatype.mavenbook<\/groupId>\r\n            persistence-deps<\/artifactId>\r\n            1.0<\/version>\r\n            pom<\/type>\r\n        <\/dependency>\r\n    <\/dependencies>\r\n<\/project>\r\n<\/pre>\n
                Inheritance or Multi-Module Composition<\/h3><\/span>\n
                * In inheritance, child project inherits all<\/strong> values from parent.
                \n* In multi-moduel, projects are simply grouped together. No parent-child relationship implied.
                \n* See this post<\/a> on how to setup multi-module projects.<\/p>\n
                The Build Lifecycle<\/h2><\/span>\n
                * Consists of a sequence of named phases to produce a set of goals
                \n* Default goals
                \n– clean
                \n– default (aka build)
                \n– site: produce a web site files<\/p>\n
                Clean Lifecycle<\/h3><\/span>\n
                * pre-clean
                \n* clean: deletes build directory
                \n* post-clean<\/p>\n
                Default Lifecycle<\/h3><\/span>\n
                * validate: Validate the project is correct and all necessary information is available to complete a build<\/p>\n
                Sources<\/h4><\/span>\n
                * generate-sources: Generate any source code for inclusion in compilation
                \n* process-sources: Process the source code, for example to filter any values<\/p>\n
                Resources<\/h4><\/span>\n
                * generate-resources: Generate resources for inclusion in the package
                \n* process-resources: Copy and process the resources into the destination directory, ready for packaging <\/p>\n
                * compile: Compile the source code of the project
                \n* process-classes: Post-process the generated files from compilation, for example to do bytecode enhancement on Java classes<\/p>\n
                Test<\/h4><\/span>\n
                * generate-test-sources: Generate any test source code for inclusion in compilation
                \n* process-test-sources: Process the test source code, for example to filter any values
                \n* generate-test-resources: Create resources for testing
                \n* process-test-resources: Copy and process the resources into the test destination directory
                \n* test-compile: Compile the test source code into the test destination directory
                \n* test: Run tests using a suitable unit testing framework. These tests should not require the code be packaged or deployed<\/p>\n
                Package<\/h4><\/span>\n
                * prepare-package: Perform any operations necessary to prepare a package before the actual packaging. This often results in an unpacked, processed version of the package (coming in Maven 2.1+)
                \n* package: Take the compiled code and package it in its distributable format, such as a JAR, WAR, or EAR<\/p>\n
                Integration Test<\/h4><\/span>\n
                * pre-integration-test: Perform actions required before integration tests are executed. This may involve things such as setting up the required environment
                \n* integration-test: Process and deploy the package if necessary into an environment where integration tests can be run
                \n* post-integration-test: Perform actions required after integration tests have been executed. This may include cleaning up the environment
                \n* verify: Run any checks to verify the package is valid and meets quality criteria<\/p>\n
                Install and Deploy<\/h4><\/span>\n
                * install: Install the package into the local repository, for use as a dependency in other projects locally
                \n* deploy: Copies the final package to the remote repository for sharing with other developers and projects (usually only relevant during a formal release)<\/p>\n
                Site Lifecycle<\/h3><\/span>\n
                * pre-site
                \n* site
                \n* post-site
                \n* site-deploy<\/p>\n
                Packaging Specific Lifecycles<\/h3><\/span>\n
                * pom: simplest packaging type
                \n* jar: default packaging type
                \n* maven-plugin: generate a descriptor file and perform some modifications to the repository data in addition to jar<\/em>:
                \n– plugin:descriptor,
                \n– plugin:addPluginArtifactMetadata
                \n– plugin:updateRegistry
                \n* ejb
                \n* war
                \n* ear
                \n* Others<\/p>\n
                Common Lifecycle Goals<\/h2><\/span>\n
                Process Resources<\/h3><\/span>\n
                * Process resources in the ${basedir}\/src\/main\/resources<\/em> directory
                \n* Perform token replacement
                \n* Copy resource to output directory as defined by the ${project.build.outputDirectory}<\/em>, which defaults to ${basedir}\/target\/classes<\/em> directory<\/p>\n
                Resource Filtering (Token Replacement)<\/h4><\/span>\n
                * File to be filtered: src\/main\/resources\/service.xml<\/em><\/p>\n
                \r\n\r\n    \r\n    ${jdbc.url}<\/url>\r\n    ${jdbc.username}<\/user>\r\n    ${jdbc.password}<\/password>\r\n<\/service>\r\n<\/pre>\n
                * Property file: src\/main\/filters\/default.properties<\/em><\/p>\n
                \r\njdbc.url=jdbc:oracle:thin:@\/\/myhost:1521\/orcl\r\njdbc.username=scott\r\njdbc.password=tiger\r\n<\/pre>\n
                * Specify filters in pom.xml<\/em>:<\/p>\n
                \r\n\r\n    \r\n        src\/main\/filters\/default.properties<\/filter>\r\n    <\/filters>\r\n    \r\n        \r\n            src\/main\/resources<\/directory>\r\n            true<\/filtering>\r\n        <\/resource>\r\n    <\/resources>\r\n<\/build>\r\n<\/pre>\n
                * Run: mvn process-resources<\/strong><\/em> command
                \n* Check service.xml in target\\classes\\META-INF<\/em> directory: <\/p>\n
                \r\n\r\n    \r\n    jdbc:oracle:thin:@\/\/myhost:1521\/orcl<\/url>\r\n    scott<\/user>\r\n    tiger<\/password>\r\n<\/service>\r\n<\/pre>\n
                Multiple Resource Directories<\/h4><\/span>\n
                * Create a separate directory to contain command files:
                \nsrc\/main\/command<\/em>
                \n* Create a command file in that directory:<\/p>\n
                \r\n@echo off\r\njava -jar ${project.build.finalName}.jar %*\r\n<\/pre>\n
                * Define a new resource:<\/p>\n
                \r\n        \r\n            true<\/filtering>\r\n            ${basedir}\/src\/main\/command<\/directory>\r\n            \r\n                run.bat<\/include>\r\n                run.sh<\/include>\r\n            <\/includes>\r\n            ${basedir}<\/targetPath>\r\n        <\/resource>\r\n<\/pre>\n
                * Run: mvn process-resources<\/strong><\/em> command
                \n* Check run.bat in the project root directory:<\/p>\n
                \r\n@echo off\r\njava -jar guide-ide-eclipse-1.0-SNAPSHOT.jar %*\r\n<\/pre>\n
                Compile<\/h3><\/span>\n
                * Compile everything from src\/main\/java<\/em> to target\/classes<\/em>
                \n* Defaults to compliance with Java 1.3 source code and Java 1.1 JVM.
                \n* Use specific source and target Java versions:<\/p>\n
                \r\n\r\n    ...\r\n    \r\n        ...\r\n        \r\n            \r\n                maven-compiler-plugin<\/artifactId>\r\n                \r\n                    1.5<\/source>\r\n                    1.5<\/target>\r\n                <\/configuration>\r\n            <\/plugin>\r\n        <\/plugins>\r\n        ...\r\n    <\/build>\r\n    ...\r\n<\/project>\r\n<\/pre>\n
                * Overriding default source diretory<\/p>\n
                \r\n\r\n    ...\r\n    src\/java<\/sourceDirectory>\r\n    classes<\/outputDirectory>\r\n    ...\r\n<\/build>\r\n<\/pre>\n
                Sample Webapp Project<\/h2><\/span>\n
                * Sample Maven webapp project<\/a><\/p>\n
                References<\/h2><\/span>\n
                * Maven Getting Started Guide<\/a>
                \n*                 Maven: The Complete Reference<\/a>
                \n* Apache Maven 2 Effective Implementation By: Brett Porter; Maria Odea Ching<\/p>\n","protected":false},"excerpt":{"rendered":"
                Install * Download Maven, e.g. apache-maven-2.2.1-bin.zip, from Maven download site: http:\/\/maven.apache.org\/download.html * Unzip content into a local directory, e.g. C:\\prog * Create an environment variable called MAVEN_HOME and point it to where maven was unzipped, e.g. C:\\prog\\apache-maven-2.2.1 * Add %MAVEN_HOME%\\bin … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_exactmetrics_skip_tracking":false,"_exactmetrics_sitenote_active":false,"_exactmetrics_sitenote_note":"","_exactmetrics_sitenote_category":0,"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":true,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[128],"tags":[],"class_list":["post-4348","post","type-post","status-publish","format-standard","hentry","category-maven"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/p8cRUO-188","_links":{"self":[{"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=\/wp\/v2\/posts\/4348","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=4348"}],"version-history":[{"count":5,"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=\/wp\/v2\/posts\/4348\/revisions"}],"predecessor-version":[{"id":12575,"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=\/wp\/v2\/posts\/4348\/revisions\/12575"}],"wp:attachment":[{"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=4348"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=4348"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=4348"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}