Apache Maven上手指南

###什么是Maven Maven 是一个项目管理与构建（Build）工具，不过对于程序员来说我们主要关注它提供的自动构建和依赖jar包的管理功能。

自动化构建。Maven自定义了一套构建生命周期过程，从清理（clean）、编译（compile）、测试（test）与生成报告，到打包（package）和部署（deploy），只需执行相应命令（如 mvn compile）即可由maven帮我们完成相应的操作。

第三方依赖（jar包）管理。Maven在构建过程中会自动从配置的maven 库（默认为Maven的中央库）中下载该项目依赖的所有jar包到本地库中，并将其引入项目的编译路径中。

###安装Maven ####命令行 1.确保已经安装过JDK，否则需要先到Oracle官网下载JDK安装。然后到https://maven.apache.org/download.cgi下载apache-maven-x.x.x-bin.zip后解压到安装目录（如D:\Program Files (x86)\apache-maven）。
2.接下来配置环境变量，新增M2_HOME指向之前的解压目录，并在path中增加% %M2_HOME%\bin;，如下：

打开命令行，输入mvn -v查看是否安装成功：

C:\Users\Walker>mvn -v
Apache Maven 3.2.5 (12a6b3acb947671f09b81f49094c53f426d8cea1; 2014-12-15T01:29:2
3+08:00)
Maven home: D:\Program Files (x86)\apache-maven
Java version: 1.8.0, vendor: Oracle Corporation
Java home: D:\Java\jdk1.8.0\jre
Default locale: zh_CN, platform encoding: GBK
OS name: "windows 8.1", version: "6.3", arch: "x86", family: "dos"

3.接下来打开maven安装目录下conf\settings.xml文件，查找localRepository，若是没找到或是被注释掉了，则新增一行：

<localRepository>/path/to/local/repo</localRepository>

这个字段主要用来配置本地库的路径，因为以后所有从远程库下载的jar包都会存放在这里，windows下建议改到一个空间较大的盘下（默认路径为${user.home}/.m2/repository），比如将上面的/path/to/local/repo替换为D:/Users/walker/.m2/repository。

4.增加Maven远程库镜像。因为默认的远程库可能被墙等原因导致无法访问的，所以需要增加国内的maven库镜像，不过目前国内只有开源中国的源。同样是修改conf\settings.xml，在<mirrors>..</mirrors>中新增如下：

<mirror>
	<id>nexus-osc</id>
	<mirrorOf>*</mirrorOf>
	<name>Nexus osc</name>
	<url>http://maven.oschina.net/content/groups/public/</url>
</mirror>

具体的修改可以参考开源中国 Maven 库使用帮助。 ####IDE插件如果你使用的是最新版的Eclipse或IntelliJ IDEA，这些工具已经集成maven，否则需要到Eclipse Marketplace或IDEA Plugin Repository下载。
Eclipse需要修改的地方如下：

###使用Maven

通常情况下，我们会从命令行进入pom.xml所在目录，执行命令。
比如运行：

mvn compile

该命令将编译整个工程，生成class文件。或者运行：

mvn clean intall

将清理整个工程（自动生成的class和其他资源文件都被清理掉）重新构建并安装。
另外Maven 使用惯例优于配置的原则。它要求项目有如下的结构：

project
 ├─src
 │  ├─main
 │  │  ├─java
 │  │  │  └─org
 │  │  │      └─greycode
 │  │  └─resources
 │  └─test
 │      ├─java
 │      │  └─org
 │      │      └─greycode
 │      └─resources
 └─target
    ├─classes
    │  └─org
    │      └─greycode
    └─...

main 和 test 分别为项目的源代码和测试代码目录，resources主要是用于存放其他资源文件比如log4j2.xml，spring-root.xml等。使用Maven编译后的class会放在target/classes目录下。

等等！你可能会想问pom.xml是什么鬼，而mvn compile和mvn install有什么区别，这些命令又让maven在后台做了些什么？

嗯……所以有些概念还是得了解一下。 ###一些概念

#####POM（Project Object Model） Maven使用名为pom.xml的文件来描述项目的信息、输入输出目录、依赖的第三方jar包、需要使用的maven插件以及在构建项目过程中会采取的行为（比如如何打包部署等）。一个典型的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">

	<modelVersion>4.0.0</modelVersion>
	<groupId>org.greycode.demo</groupId>
	<artifactId>maven-demo</artifactId>
	<version>0.0.1-SNAPSHOT</version>

	<dependencies>
		<dependency>
			<groupId>com.google.guava</groupId>
			<artifactId>guava</artifactId>
			<version>18.0</version>
		</dependency>
	</dependencies>

	<build>
		<sourceDirectory>src</sourceDirectory>
		<plugins>
			<plugin>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>3.1</version>
				<configuration>
					<source>1.8</source>
					<target>1.8</target>
				</configuration>
			</plugin>
		</plugins>
	</build>

</project>

你可能注意到了groupId:artifactId:version这样的组合。
groupId:artifactId:version通常被理解为Maven中的坐标，Maven以此来标记一个唯一的组件，比如org.springframework:spring-context:4.1.6.RELEASE将定位到 spring-context-4.1.6.RELEASE.jar，maven使用坐标主要是为了仓库和依赖管理，因为第三方的jar包实在太多，使用坐标将非常方便地帮助我们找到需要的组件。
其中groupId为某组织机构的项目名称（或者干脆就是项目名），artifactId为项目下模块的名称/标识，version为组件的版本。
我们自己的项目也需要配置groupId:artifactId:version。
其他更多pom.xml的选项可以参考https://gist.github.com/greycode/ca9775743f7e4ef827c1 。
#####插件 Maven大多数的功能都是通过插件来完成的，包括我们之前用到的mvn compile命令。每个插件都包含一些“目标（goal）”，所以使用插件是通常是下面的命令语法：

mvn [插件名]:[目标]

比如几个常见的：

 mvn compiler:compile
 mvn surefire:test
 mvn jar:jar

注意上面的mvn compiler:compile，其实这个才是mvn compile的完全体，我们可以直接使用mvn compile是因为maven内置了一些插件和生命周期的绑定。插件的配置需要在<plugins>节点下。

#####构建生命周期 Maven内部有三套独立的生命周期，分别为clean、default和site。clean生命周期的主要目的是清理项目，default是构建项目，而site是建立项目站点。
生命周期包含一些阶段（phase），而每个生命周期都是顺序按照这些阶段来执行的。
clean包含了pre-clean、clean、post-clean三个阶段。
site包含了pre-site、site、post-site和site-deploy。
而default生命周期的阶段则定义了构建项目时主要的步骤：

validate

generate-sources

process-sources

generate-resources

process-resources 处理项目主目录的资源文件。主要是对src/main/resources文件夹下的内容进行一些处理并输出到target\classes下。

compile 编译项目主代码。目录为src/main/java，生成class文件到target\classes下。

process-test-sources

process-test-resources 处理项目测试目录的资源文件。主要是对src/test/resources文件夹下的内容进行一些处理并输出到target\test-classes下。

test-compile 编译项目测试代码。目录为src/test/java，生成class文件到target\test-classes。

test 使用测试框架测试代码。

package 对编译好的代码进行打包，如jar、、war。

install 将包安装到maven本地库。

deploy 将包安装到maven远程库。

以上并不是完整的default生命周期阶段，详细请参考官方文档。

你会发现在mvn 接上面default生命周期的阶段名都会执行相应的操作，另外执行某个命令比如mvn compile时将先执行compile的前置阶段（上面的 1-5）再执行compile。
因此当运行

mvn clean install

其实是先执行clean生命周期的pre-clean、clean，然后执行上面default生命周期的1-12。

当然平常项目开发中，我们最常用的还是mvn compile 和 mvn test，最多也就执行到package。

#####依赖项目开发会用到很多第三方jar包，如果将所有的jar（编译用的，测试用的，运行时必须用的）全放到lib目录下很不明智，比如至少得区别开测试用的jar包吧，没必要把一个junit-4.12.jar打包放到运行环境中。
而且某个jar包 A.1可能会依赖于其他的第三方jar包同B.1，B.1又依赖于C.1，我们的项目中可能有了C.2。
所以手动新增一个jar时需要同时添加这个jar嵌套依赖的所有jar，同时还要考虑版本冲突的问题以及是否运行时部署的问题，是不是很麻烦？

所以需要Maven这样的工具来帮助我们自动解决依赖的问题。

对于依赖的jar包需要在<dependencies>节点下声明，如一个项目的pom.xml中：

<dependencies>
    
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>4.1.6.RELEASE</version>
    </dependency>
    
    <!-- ...其他依赖项...  -->
</dependencies>

当执行mvn compile时，maven 会首先在<localRepository>配置的本地库的org\springframework\spring-context\4.1.6.RELEASE目录中查找该jar，没找到的话再从配置的远程库（默认为Maven官方的中央库）下载到本地库的上面的位置，再将该jar加入到编译路径中完成编译。

上面的命令执行时不只是下载了spring-context-4.1.6.RELEASE.jar一个包，而是所有依赖的以及嵌套依赖的包都会采用同样的方式添加到编译路径参与编译。

###最佳实践 [TBD]

greycode - Yet another programmer :-)

Published under (CC) BY-NC-SA in categories Java开发 tagged with java maven 上手指南

2015-04-24