Maven的安装、配置及使用入门

第1章 Maven的安装和配置

1.1检查JDK安装
   在安装Maven之前，首先确认是否已经正确安装了JDK。Maven可以运行在JDK1.4及以上的版本上。打开Windows的命令行，运行如下命令来检查Java安装，如图2-1所示：

   

   上述命令首先检查环境变量JAVA_HOME是否指向了正确的JDK目录，接着尝试运行java命令。如果Windows无法执行java命令，或者无法找到JAVA_HOME环境变量。你就需要检查Java是否安装了，或者环境变量是否设置正确。
   

1.2下载Maven

   访问Maven的下载页面：http://maven.apache.org/download.html，其中包含针对不同平台的各种版本的Maven下载文件。由于最新版本不太稳定，推荐使用Maven3.1.1，因此下载apache-maven-3.1.1-bin.zip。当然，如果你对Maven的源代码感兴趣并想自己构建Maven，还可以下载apache-maven-3.1.1-src.zip。该下载页面还提供了md5校验和（checksum）文件和asc数字签名文件，可以用来检验Maven分发包的正确性和安全性。

   
   
   
1.3本地安装

   将安装文件解压到你指定的目录中，如：

   D:\ProgramFiles(x86)>jar xvf "D:\Downloads\apache-maven-3.1.1-bin.zip"

   
   这里的Maven安装目录是D:\ProgramFiles(x86)\apache-maven-3.1.1，接着需要设置环境变量，将Maven安装配置到操作系统环境中。
打开系统属性面板（桌面上右键单击"我的电脑"→"属性"），点击高级系统设置，再点击环境变量，在系统变量中新建一个变量，变量名为M2_HOME，变量值   为Maven的安装   目录D:\ProgramFiles(x86)\apache-maven-3.1.1。点击确定，接着在系统变量中找到一个名为Path的变量，在变量值的末尾加       上%M2_HOME%\bin;，注意多个值之间需要有    分号隔开，然后点击确定。至此，环境变量设置完成，详细情况如图2-2所示：
      

        这里需要提一下的是Path环境变量，当我们在cmd中输入命令时，Windows首先会在当前目录中寻找可执行文件或脚本，如果没有找到，Windows会接着遍历环境变量Path中定义的路径。由于我们将%M2_HOME%\bin添加到了Path中，而这里%M2_HOME%实际上是引用了我们前面定义的另一个变量，其值是Maven的安装目录。因此，Windows会在执行命令时搜索目录D:\ProgramFiles(x86)\apache-maven-3.1.1\bin，而mvn执行脚本的位置就是这里。

   明白了环境变量的作用，现在打开一个新的cmd窗口（这里强调新的窗口是因为新的环境变量配置需要新的cmd窗口才能生效），运行如下命令检查Maven的安装情况：

1.4 安装m2eclipse 

m2eclipse是Eclipse下的一款十分强大的Maven插件，可以访问http://m2eclipse.sonatype.org/ 了解更多信息，下面介绍如何安装m2eclipse插件。
启动Eclipse之后，在菜单栏中选择Help，然后选择Install New Software…，接着你会看到一个Install对话框，点击Work with:字段边上的Add按钮，你会得到一个新的Add Repository对话框，在Name字段中输入m2e，Location字段中输入http://download.eclipse.org/technology/m2e/releases，然后点击OK。Eclipse会下载m2eclipse安装站点上的资源信息。等待资源载入完成之后，我们再将其全部展开，就能看到图2-6所示的界面：


如图显示了m2eclipse的核心模块Maven Integration for Eclipse (Required)，选择后点击Next >，Eclipse会自动计算模块间依赖，然后给出一个将被安装的模块列表，确认无误后，继续点击Next >，这时我们会看到许可证信息，m2eclipse使用的开源许可证是Eclipse Public License v1.0，选择I accept the terms of the license agreements，然后点击Finish，接着就耐心等待Eclipse下载安装这些模块，如图2-7所示：


待安装完毕后，重启Eclipse，现在验证一下m2eclipse是否正确安装了。首先，点击菜单栏中的Help，然后选择About Eclipse，在弹出的对话框中，点击Installation Details按钮，会得到一个对话框，在Installed Software标签栏中，检查刚才我们选择的模块是否在这个列表中，如图2-9所示：


如果一切没问题，再检查一下Eclipse现在是否已经支持创建Maven项目，依次点击菜单栏中的File→New→Other，在弹出的对话框中，找到Maven一项，再将其展开，看到如图2-10所示的对话框：

如果一切正常，说明m2eclipse已经正确安装了。

最后，关于m2eclipse的安装，需要提醒的一点是，可能会在使用m2eclipse时遇到类似这样的错误：
Eclipse is running in a JRE, but a JDK is required
Some Maven plugins may not work when importing projects or updating source folders.

这是因为Eclipse默认是运行在JRE上的，而m2eclipse的一些功能要求使用JDK，解决方法是配置Eclipse安装目录的eclipse.ini文件，添加vm配置指向JDK，如：
--launcher.XXMaxPermSize
256m
-vm
D:\java\jdk1.6.0_07\bin\javaw.exe
-vmargs
-Dosgi.requiredJavaVersion=1.5
-Xms128m
-Xmx256m

第2章 Maven安装最佳实践

本节介绍一些在安装Maven过程中不是必须的，但十分有用的实践。

2.1 设置MAVEN_OPTS环境变量
前面介绍Maven安装目录时我们了解到，运行mvn命令实际上是执行了Java命令，既然是运行Java，那么运行Java命令可用的参数当然也应该在运行mvn命令时可用。这个时候，MAVEN_OPTS环境变量就能派上用场。

我们通常需要设置MAVEN_OPTS的值为：-Xms128m -Xmx512m，因为Java默认的最大可用内存往往不能够满足Maven运行的需要，比如在项目较大时，使用Maven生成项目站点需要占用大量的内存，如果没有该配置，我们很容易得到java.lang.OutOfMemeoryError。因此，一开始就配置该变量是推荐的做法。

关于如何设置环境变量，请参考前面设置M2_HOME环境变量的做法，尽量不要直接修改mvn.bat或者mvn这两个Maven执行脚本文件。因为如果修改了脚本文件，升级Maven时你就不得不再次修改，一来麻烦，二来容易忘记。同理，我们应该尽可能地不去修改任何Maven安装目录下的文件。

2.2 配置用户范围settings.xml
Maven用户可以选择配置$M2_HOME/conf/settings.xml或者~/.m2/settings.xml。前者是全局范围的，整台机器上的所有用户都会直接受到该配置的影响，而后者是用户范围的，只有当前用户才会受到该配置的影响。

我们推荐使用用户范围的settings.xml，主要原因是为了避免无意识地影响到系统中的其他用户。当然，如果你有切实的需求，需要统一系统中所有用户的settings.xml配置，当然应该使用全局范围的settings.xml。

除了影响范围这一因素，配置用户范围settings.xml文件还便于Maven升级。直接修改conf目录下的settings.xml会导致Maven升级不便，每次升级到新版本的Maven，都需要复制settings.xml文件，如果使用~/.m2目录下的settings.xml，就不会影响到Maven安装文件，升级时就不需要触动settings.xml文件。

2.3 不要使用IDE内嵌的Maven
无论是Eclipse还是NetBeans，当我们集成Maven时，都会安装上一个内嵌的Maven，这个内嵌的Maven通常会比较新，但不一定很稳定，而且往往也会和我们在命令行使用的Maven不是同一个版本。这里有会出现两个潜在的问题：首先，较新版本的Maven存在很多不稳定因素，容易造成一些难以理解的问题；其次，除了IDE，我们也经常还会使用命令行的Maven，如果版本不一致，容易造成构建行为的不一致，这是我们所不希望看到的。因此，我们应该在IDE中配置Maven插件时使用与命令行一致的Maven。

在m2eclipse环境中，点击菜单栏中的Windows，然后选择Preferences，在弹出的对话框中，展开左边的Maven项，选择Installation子项，在右边的面板中，我们能够看到有一个默认的Embedded Maven安装被选中了，点击Add…然后选择我们的Maven安装目录M2_HOME，添加完毕之后选择这一个外部的Maven，如图2-14所示：

第3章 Maven使用入门

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

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

<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/maven-v4_0_0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.wll.mvn</groupId><artifactId>mavenSSH</artifactId><packaging>jar</packaging><version>1.0-SNAPSHOT</version><name>mavenSSH Maven Webapp</name><url>http://maven.apache.org</url></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。
artifactId定义了当前Maven项目在组中唯一的ID，我们为这个Hello World项目定义artifactId为hello-world。而在前面的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等等。
name元素声明了一个对于用户更为友好的项目名称，虽然这不是必须的，但我还是推荐为每个POM声明name，以方便信息交流。

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

3.2 编写主代码

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

package com.wll.mvn.helloworld;public class HelloWorld {public String sayHello(){return "Hello Maven";}public static void main(String[] args) {System.out.println(new HelloWorld().sayHello());}}

关于该Java代码有两点需要注意。首先，在95%以上的情况下，我们应该把项目主代码放到src/main/java/目录下（遵循Maven的约定），而无须额外的配置，Maven会自动搜寻该目录找到项目主代码。其次，该Java类的包名是com.wll.mvn.helloworld，这与我们之前在POM中定义的groupId和artifactId相吻合。一般来说，项目中Java类的包都应该基于项目的groupId和artifactId，这样更加清晰，更加符合逻辑，也方便搜索构件或者Java类。
代码编写完毕后，我们使用Maven进行编译，在项目根目录下运行命令 mvn clean compile ，执行该命令Maven会自动访问中央仓库(http://search.maven.org)下载所需jar包，最终会得到如下输出：

...[INFO] Scanning for projects...  [INFO] ------------------------------------------------------------------------  [INFO] Building Maven Hello World Project  [INFO]    task-segment: [clean, compile]  [INFO] ------------------------------------------------------------------------  [INFO] [clean:clean {execution: default-clean}]  [INFO] Deleting directory D:\code\hello-world\target  [INFO] [resources:resources {execution: default-resources}]  [INFO] skip non existing resourceDirectory D: \code\hello-world\src\main\resources  [INFO] [compiler:compile {execution: default-compile}]  [INFO] Compiling 1 source file to D: \code\hello-world\target\classes  [INFO] ------------------------------------------------------------------------  [INFO] BUILD SUCCESSFUL  [INFO] ------------------------------------------------------------------------  [INFO] Total time: 1 second  [INFO] Finished at: Fri Oct 09 02:08:09 CST 2009  [INFO] Final Memory: 9M/16M  [INFO] ------------------------------------------------------------------------  ...

clean告诉Maven清理输出目录target/，compile告诉Maven编译项目主代码，从输出中我们看到Maven首先执行了clean:clean任务，删除target/目录，默认情况下Maven构建的所有输出都在target/目录中；接着执行resources:resources任务（未定义项目资源，暂且略过）；最后执行compiler:compile任务，将项目主代码编译至target/classes目录(编译好的类为com/wll/mvn/helloworld/HelloWorld.Class）。
上文提到的clean:clean、resources:resources，以及compiler:compile对应了一些Maven插件及插件目标，比如clean:clean是clean插件的clean目标，compiler:compile是compiler插件的compile目标。

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

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

<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/maven-v4_0_0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.wll.mvn</groupId><artifactId>mavenSSH</artifactId><packaging>jar</packaging><version>1.0-SNAPSHOT</version><name>mavenSSH Maven Webapp</name><url>http://maven.apache.org</url><dependencies><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>4.9</version><scope>test</scope></dependency></dependencies></project>

代码中添加了dependencies元素，该元素下可以包含多个dependency元素以声明项目的依赖，这里我们添加了一个依赖——groupId是junit，artifactId是junit，version是4.9。有了这段声明，Maven就能够自动下载junit-4.9.jar。配置了测试依赖，接着就可以编写测试类，回顾一下前面的HelloWorld类，现在我们要测试该类的sayHello()方法，检查其返回值是否为“Hello Maven”。在src/test/java目录下创建文件，其内容如代码清单3-4：

package com.wll.mvn.helloworld;import org.junit.Assert;import org.junit.Test;public class HelloWorldTest{@Testpublic void testSayHello(){HelloWorld hello = new HelloWorld();String result = hello.sayHello();Assert.assertEquals("Hello Maven", result);}}

测试用例编写完毕之后就可以调用Maven执行测试，运行mvn clean test,执行该命令Maven会自动访问中央仓库(http://search.maven.org)下载所需jar包，从输出中看到Maven从中央仓库下载了junit-4.9.pom和junit-4.9.jar这两个文件到本地仓库（~/.m2/repository）中，供所有Maven项目使用。最终会得到如下输出:

…  [INFO] [compiler:testCompile {execution: default-testCompile}]  [INFO] Compiling 1 source file to D: \code\hello-world\target\test-classes  [INFO] [surefire:test {execution: default-test}]  [INFO] Surefire report directory: D:\code\hello-world\target\surefire-reports  -------------------------------------------------------   T E S T S  -------------------------------------------------------  Running com.juvenxu.mvnbook.helloworld.HelloWorldTest  Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.055 sec  Results :  Tests run: 1, Failures: 0, Errors: 0, Skipped: 0  [INFO] ------------------------------------------------------------------------  [INFO] BUILD SUCCESSFUL  [INFO] ------------------------------------------------------------------------  …  

3.4 打包和运行

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

…  Tests run: 1, Failures: 0, Errors: 0, Skipped: 0    [INFO] [jar:jar {execution: default-jar}]  [INFO] Building jar: D:\code\hello-world\target\hello-world-1.0-SNAPSHOT.jar  [INFO]   --------------------------------------------------------------------  [INFO] BUILD SUCCESSFUL  …  

类似地，Maven会在打包之前执行编译、测试等操作。这里我们看到jar:jar任务负责打包，实际上就是jar插件的jar目标将项目主代码打包成一个名为hello-world-1.0-SNAPSHOT.jar的文件，该文件也位于target/输出目录中，它是根据artifact-version.jar规则进行命名的。

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

   …     [INFO] [jar:jar {execution: default-jar}]     [INFO] Building jar: D: \code\hello-world\target\hello-world-1.0-SNAPSHOT.jar     [INFO] [install:install {execution: default-install}]     [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     [INFO]  ------------------------------------------------------------------------     [INFO] BUILD SUCCESSFUL     …  

在打包之后，我们又执行了安装任务install:install，从输出我们看到该任务将项目输出的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，配置该插件如下：

<plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>1.2.1</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><transformers><transformerimplementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><!-- 将该信息放到MANIFEST中 --><mainClass>com.wll.mvn.helloworld.HelloWorld</mainClass></transformer></transformers></configuration></execution></executions></plugin></plugins>

plugin元素在POM中的相对位置应该在<project><build><plugins>下面。我们配置了mainClass为com.wll.mvn.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，这正是我们所期望的。

3.5 m2eclipse简单使用

3.5.1 导入Maven项目
前面介绍了如何安装m2eclipse，现在我们使用m2ecilpse导入Hello World项目。选择菜单项File->Import，我们会看到一个Import对话框，在该对话框中选择General目录下的Maven Projects，然后点击Next，就会出现Import Projects对话框，在该对话框中点击Browse…选择Hello World的根目录（即包含pom.xml文件的那个目录），这时对话框中的Projects:部分就会显示该目录包含的Maven项目，如图3-1所示：

3.5.2 创建Maven项目
创建一个Maven项目也十分简单，选择菜单项File -> New -> Other，在弹出的对话框中选择Maven下的Maven Project，然后点击Next >，在弹出的New Maven Project对话框中，我们使用默认的选项（不要选择Create a simple project选项，那样我们就能使用Maven Archetype），点击Next >，此时m2eclipse会提示我们选择一个Archetype，我们选择maven-archetype-webapp，再点击Next >。输入groupId,、artifactId、version、package（暂时我们不考虑Properties），如图3-3所示：

3.5.3 运行mvn命令
我们需要在命令行输入如mvn clean install之类的命令来执行maven构建，m2eclipse中也有对应的功能，在Maven项目或者pom.xml上右击，再选择Run As，就能看到如下的常见Maven命令，如图3-4所示：

博文参考：http://www.cnblogs.com/dcba1112/archive/2011/05/01/2033805.html