Maven入门教程

Maven是一个采用纯Java编写的开 源项目管理工具。Maven采用了一种被称之为project object model (POM)概念来管理项目，所有的项目配置信息都被定义在一个叫做POM.xml的文件中，通过该文件，Maven可以管理项目的整个声明周期，包括编 译，构建，测试，发布，报告等等。目前Apache下绝大多数项目都已经采用Maven进行管理。而Maven本身还支持多种插件，可以方便更灵活的控制 项目。 

1：http://maven.apache.org/download.html 下载最新版本 Maven 3.0.2 (Binary zip) 
 

2：解压到 D: 
 

3：配置环境变量 
   MAVEN_HOME : D:\apache-maven-3.0.2 
   MAVEN : %MAVEN_HOME%\bin 
  (可选） MAVEN_OPTS : -Xms256m -Xmx512m 

   在path 前面 加上 %MAVEN%; 
 

4：验证安装是否成功 
在命令行上输入 ： mvn -version; 回车，如看到下面信息表示安装成功： 

 

5：创建项目 
在命令行上输入 ：mvn archetype:create -DgroupId=com.mycompany.app -DartifactId=my-app 回车， 

 

如果你是首次运行该命令(goal)，maven将要花一些时间去把最新的工具包(Maven 把它叫作artifacts)下载到你的本地仓库。 

 

命令执行完后你将看到maven生成了一个名为my-app的目录，这个名字就是你在命令中指定的artifactId,进入该目录，你将发现以下标准的项目结构： 

 

其中:src/main/java 目录包含了项目的源代码，src/test/java 目录包含了项目的测试代码，pom.xml是项目的项目对象模型（Project Object Model or POM）。 

6：POM 
pom.xml 文件是maven对一个项目的核心配置，这个文件将包含你希望如何构建项目的大多数配置信息。POM大而复杂，但你不用全部去了解，只要使用一些常用的配置就可以了。下面列出这个POM的内容： 

引用

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 
  <modelVersion>4.0.0</modelVersion> 

  <groupId>com.mycompany.app</groupId> 
  <artifactId>my-app</artifactId> 
  <version>1.0-SNAPSHOT</version> 
  <packaging>jar</packaging> 

  <name>my-app</name> 
  <url>http://maven.apache.org</url> 

  <properties> 
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 
  </properties> 

  <dependencies> 
    <dependency> 
      <groupId>junit</groupId> 
      <artifactId>junit</artifactId> 
      <version>3.8.1</version> 
      <scope>test</scope> 
    </dependency> 
  </dependencies> 
</project> 

7：第5步我们做了什么 

引用

mvn archetype:create -DgroupId=com.mycompany.app -DartifactId=my-app

执行Maven 命令（goal）archetype:create，并且设置了一些参数( -DgroupId=com.mycompany.app -DartifactId=my-app) 

在这个命令中，前缀 archetype 是包含create命令的一个maven的plugin。这个goal命令根据项目原型（符合maven标准的项目模板）建立了一个简单的项目。 

现在可以确定地说，一个maven plugin 就是一些有着相同目的的goals命令的集合，例如 jboss-maven-plugin 这个插件，就是为了处理各种和jboss相关的任务。 

8：Build 项目 
在命令行上 输入 ： cd my-app 回车，进入到 项目路径下 

 

再输入 mvn package 回车这时命令行将会打印出各种动作，并且以下面一段信息结束： 

 

与首次执行的命令(那是一个goal) 

引用

archetype:create

不同,这次执行的只是一个简单的命令---package。不同于goal,这是一个phase(阶段)，一个phase是指构建生命周期的一个阶段，构建生命周期是指有序的一系列phase。当给出一个phase，Maven将执行所有的在此阶段前的phase及其自身，例如，如果我们执行compile阶段，实际上执行的阶段有： 

引用

validate 
generate-sources 
process-sources 
generate-resources 
process-resources 
compile

你可以使用以下的命令来测试新编译和打包出来的jar包， 

引用

java -cp target/my-app-1.0-SNAPSHOT.jar com.mycompany.app.App

这时将打印出最经典的： 

引用

Hello World!

 

9：运行Maven工具 

虽然很难列出一张非常全面的表，但在此可先列出最普通的默认的生命周期阶段: 

引用

validate：验证工程是否正确，所有需要的资源是否可用。 
compile：编译项目的源代码。   
test：使用合适的单元测试框架来测试已编译的源代码。这些测试不需要已打包和布署。 
Package：把已编译的代码打包成可发布的格式，比如jar。 
integration-test：如有需要，将包处理和发布到一个能够进行集成测试的环境。 
verify：运行所有检查，验证包是否有效且达到质量标准。 
install：把包安装在本地的repository中，可以被其他工程作为依赖来使用。 
Deploy：在集成或者发布环境下执行，将最终版本的包拷贝到远程的repository，使得其他的开发者或者工程可以共享。 
clean：清除先前构建的artifacts（在maven中，把由项目生成的包都叫作artifact）。 
site：为项目生成文档站点。 

  
上面列出的各个Phases（阶段）实际上对应着潜在的goals，特殊的每个阶段执行的特殊的goals由项目的类型所决定，例如：如果项目的类型是jar,package阶段将默认执行jar:jar的goals,如果项目类型是war,那么package阶段执行的goals将是war:war。 
有件有趣的事情需要注意，那就是phases和goals需要按一定的顺序来执行。 
mvn clean dependency:copy-dependencies package 
这个命令将先清除项目，然后拷贝依赖，最后把项目打包，当然，在打包之前，会先执行此阶段之前的阶段.如compile,test等. 
生成站点 
mvn site 
这个阶段生成基于pom.xml配置的项目信息。你可以在target/site目录下看到生成的文档。

一：编写POM 

引用

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 

  <modelVersion>4.0.0</modelVersion> 
  <groupId>com.mycompany.app</groupId> 
  <artifactId>my-app</artifactId> 
  <version>1.0-SNAPSHOT</version> 
  <packaging>jar</packaging> 

  <name>my-app</name> 
  <url>http://maven.apache.org</url> 

  <properties> 
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 
  </properties> 

  <dependencies> 
    <dependency> 
      <groupId>junit</groupId> 
      <artifactId>junit</artifactId> 
      <version>4.7</version> 
      <scope>test</scope> 
    </dependency> 
  </dependencies> 
</project> 

1：project是所有pom.xml的根元素： 

引用

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 


</project> 

它还声明了一些POM相关的命名空间及xsd元素，虽然这些属性不是必须的，但使用这些属性能够让第三方工具（如IDE中的XML编辑器）帮助我们快速编辑POM。 

2：<modelVersion>4.0.0</modelVersion> 
根元素下的第一个子元素modelVersion指定了当前POM模型的版本，对于Maven2及Maven 3来说，它只能是4.0.0。 

3：groupId，artifactId和version三行 
pom.xml中最重要的是groupId，artifactId和version三行。这三个元素定义了一个项目基本的坐标，在Maven的世界，任何的jar、pom或者war都是以基于这些基本的坐标进行区分的。 

3.1：groupId 
定义了项目属于哪个组，这个组往往和项目所在的组织或公司存在关联，譬如你的公司是mycom，有一个项目为myapp，那么groupId就应该是com.mycom.myapp。 

3.2：artifactId 
定义了当前Maven项目在组中唯一的ID，在前面的groupId为com.mycompany.app的例子中，你可能会为不同的子项目（模块）分配artifactId，如：myapp-util、myapp-domain、myapp-web等等。本例中artifactId 为 my-app 

3.3：version 
顾名思义，version指定了项目当前的版本。 

引用

<version>1.0-SNAPSHOT</version>

SNAPSHOT意为快照，说明该项目还处于开发中，是不稳定的版本。随着项目的发展，version会不断更新，如升级为1.1-SNAPSHOT、1.0、1.1、2.0等等。本书的6.5小节会详细介绍SNAPSHOT，第13章介绍如何使用Maven管理项目版本的升级发布。 

4：name元素 
声明了一个对于用户更为友好的项目名称，虽然这不是必须的，但我还是推荐为每个POM声明name，以方便信息交流。 


没有任何实际的Java代码，我们就能够定义一个Maven项目的POM，这体现了Maven的一大优点，它能让项目对象模型最大程度地与实际代码相独立，我们可以称之为解耦，或者正交性，这在很大程度上避免了Java代码和POM代码的相互影响。比如当项目需要升级版本时，只需要修改POM，而不需要更改Java代码；而在POM稳定之后，日常的Java代码开发工作基本不涉及POM的修改。 

二：编写主代码 

1：主代码的位置： 
项目主代码和测试代码不同，项目的主代码会被打包到最终的构件中（比如jar），而测试代码只在运行测试时用到，不会被打包。默认情况下，Maven假设项目主代码位于src/main/java目录。我们遵循Maven的约定，创建该目录，然后在该目录下创建文件com/mycompany/app/App.java 

引用

package com.mycompany.app; 

/** 
* Hello world! 
* 
*/ 
public class App 
{ 
    public static void main( String[] args ) 
    { 
        System.out.println( "Hello World!" ); 
    } 
}

2：注意事项： 
关于该Java代码有两点需要注意。首先，在95%以上的情况下，我们应该把项目主代码放到src/main/java/目录下（遵循Maven的约定），而无须额外的配置，Maven会自动搜寻该目录找到项目主代码。其次，该Java类的包名是com.mycompany.app 或者 com.mycompany.app.my-app，这与我们之前在POM中定义的groupId和artifactId相吻合。一般来说，项目中Java类的包都应该基于项目的groupId和artifactId，这样更加清晰，更加符合逻辑，也方便搜索构件或者Java类。 

3：编译主代码： 
代码编写完毕后，我们使用Maven进行编译，在项目根目录下运行命令 mvn clean compile ，我们会得到如下输出： 

 

clean告诉Maven清理输出目录target/，compile告诉Maven编译项目主代码，从输出中我们看到Maven： 

引用

首先执行了clean:clean任务，删除target/目录，默认情况下Maven构建的所有输出都在target/目录中； 
接着执行resources:resources任务（未定义项目资源，暂且略过）； 
最后执行compiler:compile任务，将项目主代码编译至target/classes目录

    上文提到的clean:clean、resources:resources，以及compiler:compile对应了一些Maven插件及插件目标，比如clean:clean是clean插件的clean目标，compiler:compile是compiler插件的compile目标，后文会详细讲述Maven插件及其编写方法。 

    至此，Maven在没有任何额外的配置的情况下就执行了项目的清理和编译任务，接下来，我们编写一些单元测试代码并让Maven执行自动化测试。 

三：编写测试代码 

1：在pom.xml中增加junit依赖 
Maven项目中默认的测试代码目录是src/test/java，在Java世界中，由Kent Beck和Erich Gamma建立的JUnit是事实上的单元测试标准。要使用JUnit，pom.xml中要有下列代码： 

引用

  <dependencies> 
    <dependency> 
      <groupId>junit</groupId> 
      <artifactId>junit</artifactId> 
      <version>4.7</version> 
      <scope>test</scope> 
    </dependency> 
  </dependencies>

dependencies元素下可以包含多个dependency元素以声明项目的依赖，这里我们有一个依赖groupId是junit，artifactId是junit，version是4.7。前面我们提到groupId、artifactId和version是任何一个Maven项目最基本的坐标，JUnit也不例外，有了这段声明，Maven就能够自动下载junit-4.7.jar。也许你会问，Maven从哪里下载这个jar呢？在Maven之前，我们可以去JUnit的官网下载分发包。而现在有了Maven，它会自动访问中央仓库（http://repo1.maven.org/maven2/），下载需要的文件。读者也可以自己访问该仓库，打开路径junit/junit/4.7/，就能看到junit-4.7.pom和junit-4.7.jar。本书第6章会详细介绍Maven仓库及中央仓库。 

上述POM代码中还有一个值为test的元素scope，scope为依赖范围，若依赖范围为test则表示该依赖只对测试有效，换句话说，测试代码中的import JUnit代码是没有问题的，但是如果我们在主代码中用import JUnit代码，就会造成编译错误。如果不声明依赖范围，那么默认值就是compile，表示该依赖对主代码和测试代码都有效。 

2：编写测试代码 

略 

3：调用Maven执行测试 
运行 mvn clean test ： 

 

四：打包和运行 

将项目进行编译、测试之后，下一个重要步骤就是打包（package）。POM中没有指定打包类型，使用默认打包类型jar，我们可以简单地执行命令 mvn clean package 进行打包。类似地，Maven会在打包之前执行编译、测试等操作。这里我们看到jar:jar任务负责打包，实际上就是jar插件的jar目标将项目主代码打包成一个名为hello-world-1.0-SNAPSHOT.jar的文件，该文件也位于target/输出目录中，它是根据artifact-version.jar规则进行命名的，如有需要，我们还可以使用finalName来自定义该文件的名称，这里暂且不展开，本书后面会详细解释。