MAVEN的一个简单例子

MAVEN的一个简单例子

1 编写POM 

就像Make的Makefile，Ant的build.xml一样，Maven项目的核心是pom.xml。POM（Project Object Model，项目对象模型）定义了项目的基本信息，用于描述项目如何构建，声明项目依赖，等等。现在我们先为Hello World项目编写一个最简单的pom.xml。

首先创建一个名为hello-world的文件夹（本书中各章的代码都会对应一个以ch开头的项目），打开该文件夹，新建一个名为pom.xml的文件，输入其内容如代码清单3-1：

代码清单3-1：Hello World的POM

1. <span style="font-size: small;"><?xml version="1.0" encoding="UTF-8"?>  

2. <project xmlns="http://maven.apache.org/POM/4.0.0"  

3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  

4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0  

5. http://maven.apache.org/maven-v4_0_0.xsd">  

6.   <modelVersion>4.0.0</modelVersion>  

7.   <groupId>com.juvenxu.mvnbook</groupId>  

8.   <artifactId>hello-world</artifactId>  

9.   <version>1.0-SNAPSHOT</version>  

10.   <name>Maven Hello World Project</name>  

11. </project>   

12. </span>  

     代码的第一行是XML头，指定了该xml文档的版本和编码方式。紧接着是project元素，project是所有pom.xml的根元素，它还声明了一些POM相关的命名空间及xsd元素，虽然这些属性不是必须的，但使用这些属性能够让第三方工具（如IDE中的XML编辑器）帮助我们快速编辑POM。

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

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

groupId定义了项目属于哪个组，这个组往往和项目所在的组织或公司存在关联，譬如你在googlecode上建立了一个名为myapp的项目，那么groupId就应该是com.googlecode.myapp，如果你的公司是mycom，有一个项目为myapp，那么groupId就应该是com.mycom.myapp。本书中所有的代码都基于groupId com.juvenxu.mvnbook。

artifactId定义了当前Maven项目在组中唯一的ID，我们为这个Hello World项目定义artifactId为hello-world，本书其他章节代码会被分配其他的artifactId。而在前面的groupId为com.googlecode.myapp的例子中，你可能会为不同的子项目（模块）分配artifactId，如：myapp-util、myapp-domain、myapp-web等等。

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

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

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

2 编写主代码 

项目主代码和测试代码不同，项目的主代码会被打包到最终的构件中（比如jar），而测试代码只在运行测试时用到，不会被打包。默认情况下，Maven假设项目主代码位于src/main/java目录，我们遵循Maven的约定，创建该目录，然后在该目录下创建文件com/juvenxu/mvnbook/helloworld/HelloWorld.java，其内容如代码清单3-2：

代码清单3-2：Hello World的主代码

1. <span style="font-size: small;">package com.juvenxu.mvnbook.helloworld;  

2.    

3. public class HelloWorld  

4. {  

5.    public String sayHello()  

6.    {  

7.      return "Hello Maven";  

8.    }  

9.   

10.   public static void main(String[] args)  

11.    {  

12.      System.out.print( new HelloWorld().sayHello() );  

13.    }  

14. }  

15. </span>  

       这是一个简单的Java类，它有一个sayHello()方法，返回一个String。同时这个类还带有一个main方法，创建一个HelloWorld实例，调用sayHello()方法，并将结果输出到控制台。

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

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

 

1. <span style="font-size: small;">[INFO] Scanning for projects...  

2. [INFO] ------------------------------------------------------------------------  

3. [INFO] Building Maven Hello World Project  

4. [INFO]    task-segment: [clean, compile]  

5. [INFO] ------------------------------------------------------------------------  

6. [INFO] [clean:clean {execution: default-clean}]  

7. [INFO] Deleting directory D:\code\hello-world\target  

8. [INFO] [resources:resources {execution: default-resources}]  

9. [INFO] skip non existing resourceDirectory D: \code\hello-world\src\main\resources  

10. [INFO] [compiler:compile {execution: default-compile}]  

11. [INFO] Compiling 1 source file to D: \code\hello-world\target\classes  

12. [INFO] ------------------------------------------------------------------------  

13. [INFO] BUILD SUCCESSFUL  

14. [INFO] ------------------------------------------------------------------------  

15. [INFO] Total time: 1 second  

16. [INFO] Finished at: Fri Oct 09 02:08:09 CST 2009  

17. [INFO] Final Memory: 9M/16M  

18. [INFO] ------------------------------------------------------------------------  

19. </span>  

 

clean告诉Maven清理输出目录target/，compile告诉Maven编译项目主代码，从输出中我们看到Maven首先执行了clean:clean任务，删除target/目录，默认情况下Maven构建的所有输出都在target/目录中；接着执行resources:resources任务（未定义项目资源，暂且略过）；最后执行compiler:compile任务，将项目主代码编译至target/classes目录(编译好的类为com/juvenxu/mvnbook/helloworld/HelloWorld.Class）。

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

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

3 编写测试代码 

为了使项目结构保持清晰，主代码与测试代码应该分别位于独立的目录中。3.2节讲过Maven项目中默认的主代码目录是src/main/java，对应地，Maven项目中默认的测试代码目录是src/test/java。因此，在编写测试用例之前，我们先创建该目录。

在Java世界中，由Kent Beck和Erich Gamma建立的JUnit是事实上的单元测试标准。要使用JUnit，我们首先需要为Hello World项目添加一个JUnit依赖，修改项目的POM如代码清单3-3：

代码清单3-3：为Hello World的POM添加依赖

1. <?xml version="1.0" encoding="UTF-8"?>  

2. <project xmlns="http://maven.apache.org/POM/4.0.0"  

3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  

4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0  

5. http://maven.apache.org/maven-v4_0_0.xsd">  

6.   <modelVersion>4.0.0</modelVersion>  

7.   <groupId>com.juvenxu.mvnbook</groupId>  

8.   <artifactId>hello-world</artifactId>  

9.   <version>1.0-SNAPSHOT</version>  

10.   <name>Maven Hello World Project</name>  

11.   <dependencies>  

12.     <dependency>  

13.        <groupId>junit</groupId>  

14.        <artifactId>junit</artifactId>  

15.        <version>4.7</version>  

16.        <scope>test</scope>  

17.     </dependency>  

18.   </dependencies>  

19. </project>    

     代码中添加了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，表示该依赖对主代码和测试代码都有效。

配置了测试依赖，接着就可以编写测试类，回顾一下前面的HelloWorld类，现在我们要测试该类的sayHello()方法，检查其返回值是否为“Hello Maven”。在src/test/java目录下创建文件，其内容如代码清单3-4：

代码清单3-4：Hello World的测试代码

1. package com.juvenxu.mvnbook.helloworld;  

2. import static org.junit.Assert.assertEquals;  

3. import org.junit.Test;  

4.   

5. public class HelloWorldTest  

6. {  

7.     @Test  

8.     public void testSayHello()  

9.     {  

10.         HelloWorld helloWorld = new HelloWorld();  

11.   

12.         String result = helloWorld.sayHello();  

13.   

14.         assertEquals( "Hello Maven", result );  

15.     }  

16. }   

一个典型的单元测试包含三个步骤：一，准备测试类及数据；二，执行要测试的行为；三，检查结果。上述样例中，我们首先初始化了一个要测试的HelloWorld实例，接着执行该实例的sayHello()方法并保存结果到result变量中，最后使用JUnit框架的Assert类检查结果是否为我们期望的”Hello Maven”。在JUnit 3中，约定所有需要执行测试的方法都以test开头，这里我们使用了JUnit 4，但我们仍然遵循这一约定，在JUnit 4中，需要执行的测试方法都应该以@Test进行标注。

测试用例编写完毕之后就可以调用Maven执行测试，运行 mvn clean test ：

1. [INFO] Scanning for projects...  

2. [INFO] ------------------------------------------------------------------------  

3. [INFO] Building Maven Hello World Project  

4. [INFO]    task-segment: [clean, test]  

5. [INFO] ------------------------------------------------------------------------  

6. [INFO] [clean:clean {execution: default-clean}]  

7. [INFO] Deleting directory D:\git-juven\mvnbook\code\hello-world\target  

8. [INFO] [resources:resources {execution: default-resources}]  

9. …  

10. Downloading: http://repo1.maven.org/maven2/junit/junit/4.7/junit-4.7.pom  

11. 1K downloaded  (junit-4.7.pom)  

12. [INFO] [compiler:compile {execution: default-compile}]  

13. [INFO] Compiling 1 source file to D: \code\hello-world\target\classes  

14. [INFO] [resources:testResources {execution: default-testResources}]  

15. …  

16. Downloading: http://repo1.maven.org/maven2/junit/junit/4.7/junit-4.7.jar  

17. 226K downloaded  (junit-4.7.jar)  

18. [INFO] [compiler:testCompile {execution: default-testCompile}]  

19. [INFO] Compiling 1 source file to D:\ code\hello-world\target\test-classes  

20. [INFO] ------------------------------------------------------------------------  

21. [ERROR] BUILD FAILURE  

22. [INFO] ------------------------------------------------------------------------  

23. [INFO] Compilation failure  

24. D:\code\hello-world\src\test\java\com\juvenxu\mvnbook\helloworld\HelloWorldTest.java:[8,5] -source 1.3 中不支持注释  

25. （请使用 -source 5 或更高版本以启用注释）  

26.     @Test  

27. [INFO] ------------------------------------------------------------------------  

28. [INFO] For more information, run Maven with the -e switch  

29.   …  

 

不幸的是构建失败了，不过我们先耐心分析一下这段输出（为了本书的简洁，一些不重要的信息我用省略号略去了）。命令行输入的是mvn clean test，而Maven实际执行的可不止这两个任务，还有clean:clean、resources:resources、compiler:compile、resources:testResources以及compiler:testCompile。暂时我们需要了解的是，在Maven执行测试（test）之前，它会先自动执行项目主资源处理，主代码编译，测试资源处理，测试代码编译等工作，这是Maven生命周期的一个特性，本书后续章节会详细解释Maven的生命周期。

从输出中我们还看到：Maven从中央仓库下载了junit-4.7.pom和junit-4.7.jar这两个文件到本地仓库（~/.m2/repository）中，供所有Maven项目使用。

构建在执行compiler:testCompile任务的时候失败了，Maven输出提示我们需要使用-source 5或更高版本以启动注释，也就是前面提到的JUnit 4的@Test注解。这是Maven初学者常常会遇到的一个问题。由于历史原因，Maven的核心插件之一compiler插件默认只支持编译Java 1.3，因此我们需要配置该插件使其支持Java 5，见代码清单3-5：

代码清单3-5：配置maven-compiler-plugin支持Java 5

1. <project>  

2. …  

3.   <build>  

4.     <plugins>  

5.        <plugin>  

6.          <groupId>org.apache.maven.plugins</groupId>  

7.          <artifactId>maven-compiler-plugin</artifactId>  

8.          <configuration>  

9.            <source>1.5</source>  

10.            <target>1.5</target>  

11.          </configuration>  

12.        </plugin>  

13.     </plugins>  

14.   </build>  

15. …  

16. </project>    

该POM省略了除插件配置以外的其他部分，我们暂且不去关心插件配置的细节，只需要知道compiler插件支持Java 5的编译。现在再执行mvn clean test，输出如下：

1. …  

2. [INFO] [compiler:testCompile {execution: default-testCompile}]  

3. [INFO] Compiling 1 source file to D: \code\hello-world\target\test-classes  

4. [INFO] [surefire:test {execution: default-test}]  

5. [INFO] Surefire report directory: D:\code\hello-world\target\surefire-reports  

6. -------------------------------------------------------  

7.  T E S T S  

8. -------------------------------------------------------  

9. Running com.juvenxu.mvnbook.helloworld.HelloWorldTest  

10. Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.055 sec  

11. Results :  

12. Tests run: 1, Failures: 0, Errors: 0, Skipped: 0  

13. [INFO] ------------------------------------------------------------------------  

14. [INFO] BUILD SUCCESSFUL  

15. [INFO] ------------------------------------------------------------------------  

16. …  

我们看到compiler:testCompile任务执行成功了，测试代码通过编译之后在target/test-classes下生成了二进制文件，紧接着surefire:test任务运行测试，surefire是Maven世界中负责执行测试的插件，这里它运行测试用例HelloWorldTest，并且输出测试报告，显示一共运行了多少测试，失败了多少，出错了多少，跳过了多少。显然，我们的测试通过了——BUILD SUCCESSFUL。

4 打包和运行 

将项目进行编译、测试之后，下一个重要步骤就是打包（package）。Hello World的POM中没有指定打包类型，使用默认打包类型jar，我们可以简单地执行命令 mvn clean package 进行打包，可以看到如下输出：

1. …  

2. Tests run: 1, Failures: 0, Errors: 0, Skipped: 0  

3.   

4. [INFO] [jar:jar {execution: default-jar}]  

5. [INFO] Building jar: D:\code\hello-world\target\hello-world-1.0-SNAPSHOT.jar  

6. [INFO]   

7. --------------------------------------------------------------------  

8. [INFO] BUILD SUCCESSFUL  

9. …  

 

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

至此，我们得到了项目的输出，如果有需要的话，就可以复制这个jar文件到其他项目的Classpath中从而使用HelloWorld类。但是，如何才能让其他的Maven项目直接引用这个jar呢？我们还需要一个安装的步骤，执行 mvn clean install：

1.    …  

2.    [INFO] [jar:jar {execution: default-jar}]  

3.    [INFO] Building jar: D: \code\hello-world\target\hello-world-1.0-SNAPSHOT.jar  

4.    [INFO] [install:install {execution: default-install}]  

5.    [INFO] Installing D:\code\hello-world\target\hello-world-1.0-SNAPSHOT.jar to C:\Users\juven\.m2\repository\com\juvenxu\mvnbook\hello-world\1.0-SNAPSHOT\hello-world-1.0-SNAPSHOT.jar  

6.    [INFO]  

7. ------------------------------------------------------------------------  

8.    [INFO] BUILD SUCCESSFUL  

9.    …  

在打包之后，我们又执行了安装任务install:install，从输出我们看到该任务将项目输出的jar安装到了Maven本地仓库中，我们可以打开相应的文件夹看到Hello World项目的pom和jar。之前讲述JUnit的POM及jar的下载的时候，我们说只有构件被下载到本地仓库后，才能由所有Maven项目使用，这里是同样的道理，只有将Hello World的构件安装到本地仓库之后，其他Maven项目才能使用它。

我们已经将体验了Maven最主要的命令：mvn clean compile、mvn clean test、mvn clean package、mvn clean install。执行test之前是会先执行compile的，执行package之前是会先执行test的，而类似地，install之前会执行package。我们可以在任何一个Maven项目中执行这些命令，而且我们已经清楚它们是用来做什么的。

到目前为止，我们还没有运行Hello World项目，不要忘了HelloWorld类可是有一个main方法的。默认打包生成的jar是不能够直接运行的，因为带有main方法的类信息不会添加到manifest中(我们可以打开jar文件中的META-INF/MANIFEST.MF文件，将无法看到Main-Class一行)。为了生成可执行的jar文件，我们需要借助maven-shade-plugin，配置该插件如下：

1. <plugin>  

2. <groupId>org.apache.maven.plugins</groupId>  

3.   <artifactId>maven-shade-plugin</artifactId>  

4.   <version>1.2.1</version>  

5.   <executions>  

6.     <execution>  

7.       <phase>package</phase>  

8.       <goals>  

9.         <goal>shade</goal>  

10.       </goals>  

11.       <configuration>  

12.         <transformers>  

13.           <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">            <mainClass>com.juvenxu.mvnbook.helloworld.HelloWorld</mainClass>  

14.          </transformer>  

15.        </transformers>  

16.      </configuration>  

17.      </execution>  

18.   </executions>  

19. </plugin>  

 

plugin元素在POM中的相对位置应该在<project><build><plugins>下面。我们配置了mainClass为com.juvenxu.mvnbook.helloworld.HelloWorld，项目在打包时会将该信息放到MANIFEST中。现在执行 mvn clean install ，待构建完成之后打开target/目录，我们可以看到hello-world-1.0-SNAPSHOT.jar和original-hello-world-1.0-SNAPSHOT.jar，前者是带有Main-Class信息的可运行jar，后者是原始的jar，打开hello-world-1.0-SNAPSHOT.jar的META-INF/MANIFEST.MF，可以看到它包含这样一行信息：

Main-Class: com.juvenxu.mvnbook.helloworld.HelloWorld

现在，我们在项目根目录中执行该jar文件：

D: \code\hello-world>java -jar target\hello-world-1.0-SNAPSHOT.jar

Hello Maven

控制台输出为Hello Maven，这正是我们所期望的。

本小节介绍了Hello World项目，侧重点是Maven而非Java代码本身，介绍了POM、Maven项目结构、以及如何编译、测试、打包，等等。

5 使用Archetype生成项目骨架 

Hello World项目中有一些Maven的约定：在项目的根目录中放置pom.xml，在src/main/java目录中放置项目的主代码，在src/test/java中放置项目的测试代码。我之所以一步一步地展示这些步骤，是为了能让可能是Maven初学者的你得到最实际的感受。我们称这些基本的目录结构和pom.xml文件内容称为项目的骨架，当你第一次创建项目骨架的时候，你还会饶有兴趣地去体会这些默认约定背后的思想，第二次，第三次，你也许还会满意自己的熟练程度，但第四、第五次做同样的事情，就会让程序员恼火了，为此Maven提供了Archetype以帮助我们快速勾勒出项目骨架。

还是以Hello World为例，我们使用maven archetype来创建该项目的骨架，离开当前的Maven项目目录。

如果是Maven 3，简单的运行：

mvn archetype:generate

如果是Maven 2，最好运行如下命令：

mvn org.apache.maven.plugins:maven-archetype-plugin:2.0-alpha-5:generate

很多资料会让你直接使用更为简单的 mvn archetype:generate 命令，但在Maven2中这是不安全的，因为该命令没有指定archetype插件的版本，于是Maven会自动去下载最新的版本，进而可能得到不稳定的SNAPSHOT版本，导致运行失败。然而在Maven 3中，即使用户没有指定版本，Maven也只会解析最新的稳定版本，因此这是安全的，具体内容见7.7小节。

我们实际上是在运行插件maven-archetype-plugin，注意冒号的分隔，其格式为 groupId:artifactId:version:goal ，org.apache.maven.plugins 是maven官方插件的groupId，maven-archetype-plugin 是archetype插件的artifactId，2.0-alpha-5 是目前该插件最新的稳定版，generate是我们要使用的插件目标。

紧接着我们会看到一段长长的输出，有很多可用的archetype供我们选择，包括著名的Appfuse项目的archetype，JPA项目的archetype等等。每一个archetype前面都会对应有一个编号，同时命令行会提示一个默认的编号，其对应的archetype为maven-archetype-quickstart，我们直接回车以选择该archetype，紧接着Maven会提示我们输入要创建项目的groupId、artifactId、 version、以及包名package，如下输入并确认：

1. Define value for groupId: : com.juvenxu.mvnbook  

2. Define value for artifactId: : hello-world  

3. Define value for version:  1.0-SNAPSHOT: :  

4. Define value for package:  com.juvenxu.mvnbook: : com.juvenxu.mvnbook.helloworld  

5. Confirm properties configuration:  

6. groupId: com.juvenxu.mvnbook  

7. artifactId: hello-world  

8. version: 1.0-SNAPSHOT  

9. package: com.juvenxu.mvnbook.helloworld  

10.  Y: : Y  

Archetype插件将根据我们提供的信息创建项目骨架。在当前目录下，Archetype插件会创建一个名为hello-world（我们定义的artifactId）的子目录，从中可以看到项目的基本结构：基本的pom.xml已经被创建，里面包含了必要的信息以及一个junit依赖；主代码目录src/main/java已经被创建，在该目录下还有一个Java类com.juvenxu.mvnbook.helloworld.App，注意这里使用到了我们刚才定义的包名，而这个类也仅仅只有一个简单的输出Hello World!的main方法；测试代码目录src/test/java也被创建好了，并且包含了一个测试用例com.juvenxu.mvnbook.helloworld.AppTest。

Archetype可以帮助我们迅速地构建起项目的骨架，在前面的例子中，我们完全可以在Archetype生成的骨架的基础上开发Hello World项目以节省我们大量时间。

此外，我们这里仅仅是看到了一个最简单的archetype，如果你有很多项目拥有类似的自定义项目结构以及配置文件，你完全可以一劳永逸地开发自己的archetype，然后在这些项目中使用自定义的archetype来快速生成项目骨架Maven Archetype。