maven详解五、maven mvn 命令行的操作和使用

maven的操作有两种方式，一种是通过mvn命令行命令，一种是使用maven的eclipse插件。因为使用eclipse的maven插件操作起来比较容易，这里就只介绍使用mvn命令行的操作。

5.1 maven的配置文件

         maven的主执行程序为mvn.bat，linux下为mvn.sh，这两个程序都很简单，它们的共同用途就是收集一些参数，然后用 java.exe来运行maven的Main函数。maven同样需要有配置文件，名字叫做settings.xml，它放在两个地方，一个是maven 安装目录的conf目录下，对所有使用该maven的用户都起作用，我们称为主配置文件，另外一个放在 %USERPROFILE%/.m2/settings.xml下，我们成为用户配置文件，只对当前用户有效，且可以覆盖主配置文件的参数内容。还有就是项目级别的配置信息了，它存放在每一个maven管理的项目目录下，叫pom.xml，主要用于配置项目相关的一些内容，当然，如果有必要，用户也可以在 pom中写一些配置，覆盖住配置文件和用户配置文件的设置参数内容。

 

         一般来说，settings文件配置的是比如repository库路径之类的全局信息，具体可以参考官方网站的文章 。

5.2 创建新工程

 

         要创建一个新的maven工程，我们需要给我们的工程指定几个必要的要素，就是maven产品坐标的几个要素：groupId, artifactId，如果愿意，你也可以指定version和package名称。我们先看一个简单的创建命令：

 

d:\work\temp>mvn archetype:create-DgroupId=com.abc -DartifactId=product1-DarchetypeArtifactId=maven-archetype-webapp

 

首先看这里的命令行参数的传递结构，怪异的 -D参数=值的方式是 java.exe 要求的方式。这个命令创建一个web工程，目录结构是一个标准的maven结构，如下：

D:. └─mywebapp     │  pom.xml     │     └─src         └─main             ├─resources             └─webapp                 │  index.jsp                 │                 └─WEB-INF                     web.xml

 

 

         大家要注意，这里目录结构的布局实际上是由参数 archetype ArtifactId 来决定的，因为这里传入的是 maven-archetype-webapp 如果我们传入其他的就会创建不同的结构，默认值为 maven-archetype-quickstart ，有兴趣的读者可以参考更详细的列表 ，我把部分常用的列表在这里：

Artifact Group Version RepositoryDescription

maven-archetype-j2ee-simpleorg.apache.maven.archetypes     A simpleJ2EE Java application

maven-archetype-marmalade-mojoorg.apache.maven.archetypes     A Mavenplugin development project using marmalade

maven-archetype-pluginorg.apache.maven.archetypes     A MavenJava plugin development project

maven-archetype-portletorg.apache.maven.archetypes     A simpleportlet application

maven-archetype-profilesorg.apache.maven.archetypes    

maven-archetype-quickstartorg.apache.maven.archetypes    

maven-archetype-simpleorg.apache.maven.archetypes    

maven-archetype-site-simpleorg.apache.maven.archetypes     A simplesite generation project

maven-archetype-siteorg.apache.maven.archetypes     A morecomplex site project

maven-archetype-webapporg.apache.maven.archetypes     A simpleJava web application

maven-archetype-har net.sf.maven-har0.9   Hibernate Archive

maven-archetype-sar net.sf.maven-sar 0.9   JBoss Service Archive

 

         大家可以参考更详细的archetype:create 帮助和 archtype参考信息。

5.3 maven的多项目管理

 

         多项目管理是maven的主要特色之一，对于一个大型工程，用maven来管理他们之间复杂的依赖关系，是再好不过了。maven的项目配置之间的关系有两种：继承关系和引用关系。

         maven默认根据目录结构来设定pom的继承关系，即下级目录的pom默认继承上级目录的pom。要设定两者之间的关系很简单，上级pom如下设置：

<modules>     <module>ABCCommon</module>     <module>ABCCore</module>     <module>ABCTools</module> </modules>

 

 

 

要记住的是，这里的module是目录名，不是子工程的artifactId。子工程如下设置：

<parent>     <groupId>com.abc.product1</groupId>     <artifactId>abc-product1</artifactId>     <version>1.0.0-SNAPSHOT</version> </parent> <artifactId>abc-my-module2</artifactId> <packaging>jar</packaging>

 

 

         这样两者就相互关联起来了，继承关系就设定完毕，所有父工程的配置内容都会自动在子工程中生效，除非子工程有相同的配置覆盖。如果你不喜欢层层递进的目录结构来实现继承，也可以在parent中加入<relativePath>../a-parent/pom.xml</relativePath> 来制定parent项目的相对目录。继承关系通常用在项目共同特性的抽取上，通过抽取公共特性，可以大幅度减少子项目的配置工作量。

 

         引用关系是另外一种复用的方式，maven中配置引用关系也很简单，加入一个 type 为 pom 的依赖即可。

<dependency>     <groupId>org.sonatype.mavenbook</groupId>     <artifactId>persistence-deps</artifactId>     <version>1.0</version>     <type>pom</type> </dependency>

 

         但是无论是父项目还是引用项目，这些工程都必须用 mvn install 或者 mvn deploy 安装到本地库才行，否则会报告依赖没有找到，eclipse编译时候也会出错。

 

         需要特别提出的是复用过程中，父项目的pom中可以定义 dependencyManagement 节点，其中存放依赖关系，但是这个依赖关系只是定义，不会真的产生效果，如果子项目想要使用这个依赖关系，可以在本身的 dependency 中添加一个简化的引用

<dependency>     <groupId>org.springframework</groupId>     <artifactId>spring</artifactId> </dependency>

 

 

这种方法可以避免版本号满天飞的情况。

5.4 安装库文件到maven库中

 

         在maven中一般都会用到安装库文件的功能，一则是我们常用的hibernate要使用jmx库，但是因为sun的license限制，所以无法将其直接包含在repository中。所以我们使用mvn命令把jar安装到我们本地的repository中

mvn install:install-file -DgroupId=com.sun.jdmk -DartifactId=jmxtools -Dversion=1.2.1 -Dpackaging=jar -Dfile=/path/to/file

 

 

如果我们想把它安装到公司的repository中，需要使用命令

mvn deploy:deploy-file -DgroupId=com.sun.jdmk -DartifactId=jmxtools -Dversion=1.2.1 -Dpackaging=jar -Dfile=/path/to/file -Durl=http://xxx.ss.com/sss.xxx -DrepositoryId=release-repo

 

 

对于我们的工程输出，如果需要放置到公司的repository中的话，可以通过配置pom来实现

<distributionManagement>     <repository>         <id>mycompany-repository</id>         <name>MyCompany Repository</name>         <url>scp://repository.mycompany.com/repository/maven2</url>     </repository> </distributionManagement>

 

 

 

这里使用的scp方式提交库文件，还有其他方式可以使用，请参考faq部分。然后记得在你的settings.xml中加入这一内容

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"           xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0           http://maven.apache.org/xsd/settings-1.0.0.xsd">     ...     <servers>         <server>             <id>mycompany-repository</id>             <username>jvanzyl</username>             <!-- Default value is ~/.ssh/id_dsa -->             <privateKey>/path/to/identity</privateKey>             <passphrase>my_key_passphrase</passphrase>         </server>     </servers>     ... </settings>

 

5.5 maven的变量

 

maven定义了很多变量属性,参考这里

http://docs.codehaus.org/display/MAVENUSER/MavenPropertiesGuide

 

5.5.1. 内置属性

       ${basedir } represents the directory containing pom.xml

       ${version } equivalent to ${project.version } or ${pom.version }

5.5.2. Pom/Project properties

    所有pom中的元素都可以用project. 前缀进行引用,以下是部分常用的

       ${project.build.directory } results in the path to your"target" dir, this is the same as ${pom.project.build.directory }

       ${project.build. outputD irectory } results in the path to your"target/classes" dir

       ${project.name } refers to the name of the project.

       ${project.version } refers to the version of the project.

       ${project.build.finalName } refers to the final name of the file createdwhen the built project is packaged

5.5.3. 本地用户设定

    所有用的的settings.xml 中的设定都可以通过 settings. 前缀进行引用

       ${settings.localRepository } refers to the path of the user's localrepository.

       ${maven.repo.local } also works for backward compatibility with maven1??

5.5.4.  环境变量

    系统的环境变量通过env. 前缀引用

       ${env.M2_HOME } returns the Maven2 installation path.

       ${java.home } specifies the path to the current JRE_HOME environment usewith relative paths to get for example:

       <jvm>${java.home}../bin/java.exe</jvm>

5.5.5. java系统属性

    所有JVM中定义的java系统属性.

    用户在pom中定义的自定义属性

   <project>

       ...

       <properties>

           <my.filter.value>hello</my.filter.value>

       </properties>

       ...

   </project>

    则引用${my.filter.value } 就会得到值 hello

5.5.6. 上级工程的变量

    上级工程的pom中的变量用前缀${project.parent } 引用. 上级工程的版本也可以这样引用:${parent.version }.

 

5.6 maven的使用

 

         我们已经知道maven预定义了许多的阶段（phase），每个插件都依附于这些阶段，并且在进入某个阶段的时候，调用运行这些相关插件的功能。我们先来看完整的maven生命周期：

5.6.1.生命周期

生命周期	阶段描述
validate	验证项目是否正确，以及所有为了完整构建必要的信息是否可用
generate-sources	生成所有需要包含在编译过程中的源代码
process-sources	处理源代码，比如过滤一些值
generate-resources	生成所有需要包含在打包过程中的资源文件
process-resources	复制并处理资源文件至目标目录，准备打包
compile	编译项目的源代码
process-classes	后处理编译生成的文件，例如对Java类进行字节码增强（bytecode enhancement）
generate-test-sources	生成所有包含在测试编译过程中的测试源码
process-test-sources	处理测试源码，比如过滤一些值
generate-test-resources	生成测试需要的资源文件
process-test-resources	复制并处理测试资源文件至测试目标目录
test-compile	编译测试源码至测试目标目录
test	使用合适的单元测试框架运行测试。这些测试应该不需要代码被打包或发布
prepare-package	在真正的打包之前，执行一些准备打包必要的操作。这通常会产生一个包的展开的处理过的版本（将会在Maven 2.1+中实现）
package	将编译好的代码打包成可分发的格式，如JAR，WAR，或者EAR
pre-integration-test	执行一些在集成测试运行之前需要的动作。如建立集成测试需要的环境
integration-test	如果有必要的话，处理包并发布至集成测试可以运行的环境
post-integration-test	执行一些在集成测试运行之后需要的动作。如清理集成测试环境。
verify	执行所有检查，验证包是有效的，符合质量规范
install	安装包至本地仓库，以备本地的其它项目作为依赖使用
deploy	复制最终的包至远程仓库，共享给其它开发人员和项目（通常和一次正式的发布相关）

 

5.6.2. maven核心插件

         maven核心的插件列表可以参考http://maven.apache.org/plugins/index.html 。这里仅列举几个常用的插件及其配置参数：

 

Ø  clean插件

    只包含一个goal叫做clean:clean ，负责清理构建时候创建的文件。默认清理的位置是如下几个变量指定的路径

project.build.directory, project.build.outputDirectory,project.build.testOutputDirectory, and project.reporting.outputDirectory 。

Ø  compiler插件

    包含2个goal，分别是compiler:compile 和 compiler:testCompile 。可以到这里查看两者的具体参数设置：compile , testCompile 。

Ø  surefire插件

    运行单元测试用例的插件，并且能够生成报表。包含一个goal为 surefire:test 。主要参数testSourceDirectory用来指定测试用例目录，参考完整用法帮助

Ø  jar

    负责将工程输出打包到jar文件中。包含两个goal，分别是 jar:jar, jar:test-jar 。两个goal负责从classesDirectory或testClassesDirectory中获取所有资源，然后输出jar文件到outputDirectory中。

Ø  war

    负责打包成war文件。常用goal有 war:war ，负责从warSourceDirectory（默认${basedir}/src/main/webapp）打包所有资源到outputDirectory中。

Ø  resources

    负责复制各种资源文件，常用goal有resources:resources ，负责将资源文件复制到outputDirectory中，默认为${project.build.outputDirectory}。

Ø  install

    负责将项目输出(install:install)或者某个指定的文件(install:install-file)加入到本机库%USERPROFILE%/.m2/repository中。可以用install:help 寻求帮助。

Ø  deploy

    负责将项目输出(deploy:deploy)或者某个指定的文件(deploy:deploy-file)加入到公司库中。

Ø  site

    将工程所有文档生成网站，生成的网站界面默认和apache的项目站点类似，但是其文档用doxia格式写的，目前不支持docbook，需要用其他插件配合才能支持。需要指出的是，在maven 2.x系列中和maven3.x的site命令处理是不同的，在旧版本中，用 mvn site 命令可以生成reporting节点中的所有报表，但是在maven3中，reporting过时了，要把这些内容作为 maven-site-plugin的configuration的内容才行。详细内容可以参考http://www.wakaleo.com/blog/292-site-generation-in-maven-3