Maven学习笔记之生命周期和插件

前言：在有关Maven的日期使用中，命令行的输入往往就对应了生命周期。Maven的生命周期是抽象的，其实际行动都由插件来完成。

一、简介

  Maven的声明周期就是为了对所有的构建过程进行抽象和统一。Maven从大量项目和构建工具中学习和反思，然后总结了一套高度完善的、易扩展的生命周期。这个生命周期包含了项目的清理、初始化、编译、测试、打包、集成测试、验证、部署和站点生成等几乎所有构件步骤。也就是说，几乎所有项目的构建，都能映射到这样一个生命周期上。

  Maven的声明周期是抽象的，这意味着生命周期本身不做任何实际的工作，在Maven的设计中，实际的任务（如编译源代码）都交由插件来完成。

  Maven定义的生命周期和插件机制一方面保证了所有Maven项目有一致的构建标准，另一方面又通过默认插件和稳定了实际项目的构建。此外，该机制还提供了足够的扩展空间，用户可以通过配置现有插件或者自行编写插件来自定义构建行为。

二、生命周期

2.1 三套生命周期

  Maven的生命周期不是一个整体，Maven拥有三套相互独立的生命周期，他们分别为clean、default和site。clean声明周期的目的是清理项目，default生命周期的目的是构建项目，而site生命周期的目的是建立项目站点。每个生命周期包含一些阶段（phase），这些阶段是有顺序的，并且后面的阶段依赖于前面的阶段。用户和Maven最直接的交互方式就是调用这些生命周期阶段。较之于生命周期阶段的前后依赖关系，三套生命周期本身是相互独立的。

2.2 clean生命周期

clean生命周期的目的是清理项目，它包含三个阶段：

pre-clean：执行一些清理前需要完成的工作。
clean：清理上一次构建生成的文件。
post-clean：执行一些清理后需要完成的工作。

2.3 default生命周期

default生命周期定义了真正构建时所需要执行的所有步骤，它是所有生命周期中最核心的部分，包含的阶段如下：

validate
initialize
generate-sources
process-sources：处理项目主资源文件。一般来说，是对src/main/resources目录的内容进行变量替换等工作后，复制到项目输出的主classpath目录中。
generate-resources
process-resources
compile：编译项目的主源码。一般来说，是编译src/main/java目录下的Java文件至项目输出的主classpath目录中。
process-classes
generate-test-sources
process-test-sources：处理项目测试资源文件。一般来说，是对src/test/resources目录的内容进行变量替换等工作后，复制到项目输出的测试classpath目录中。
generate-test-resources
process-test-resources
test-compile：编译项目的测试代码。一般来说，是编译src/test/java目录下的Java文件至项目输出的测试classpath目录中。
process-test-classes
test：使用单元测试框架运行测试，测试代码不会被打包或部署。
prepare-package
package：接受编译好的代码，打包成可发布的格式，如JAR。
pre-integration-test
integration-test
post-integration-test
verify
install：将包安装到Maven本地仓库，供本地其他Maven项目使用。
deploy：将最终的包复制到远程仓库，供其他开发人员和Maven项目使用
详细的可以参考官网：Introduction to the Build Lifecycle

2.4 site生命周期

  site生命周期的目的是建立和发布项目站点，Maven能够基于POM所包含的信息，自动生成一个友好的站点，方便团队交流和发布项目信息。包含的阶段如下：

pre-site：执行一些在生成项目站点之前需要完成的工作。
site：生成项目站点文档。
post-site：执行一些在生成项目站点之后需要完成的工作。
site-deploy：将生成的项目站点发布到服务器上。

三、命令行与生命周期

  从命令行执行Maven任务的最主要方式就是调用Maven的生命周期阶段。需要注意的是，各个生命周期是相互独立的，而一个生命周期的阶段是有前后依赖关系的。

常见的Maven命令：

mvn clean：该命令调用clean生命周期的clean阶段。
mvn test：该命令调用了default生命周期的test阶段。执行的阶段从validate到test，执行测试代码之前，项目代码已经自动得以编译。
mvn clean install：该命令调用clean生命周期的clean阶段和default生命周期的install阶段。该命令结合了两个生命周期，在执行真正的项目构建之前清理项目是一个很好的实践。
mvn clean deploy site-deploy：该命令调用clean生命周期的clean阶段、default生命周期的deploy阶段，以及site生命周期的site-deploy阶段。

四、插件

4.1 插件目标(Plugin Goal)

  Maven的核心仅仅定义了抽象的生命周期，具体的任务是交由插件完成的，插件以独立的构件形成存在，Maven会在需要的时候下载并使用插件。

  对于插件本身，为了能够复用代码，往往能够完成多个任务。为每个功能编写一个独立的插件显然是不可取的，因为这些任务背后有很多可以复用的代码，因此，这些功能聚集在一个插件里，每个功能就是一个插件目标。

  调用插件的目标的通用写法是，冒号前面是插件前缀，冒号后面是该插件的目标。例如：compiler:compile

4.2 插件绑定

  Maven的生命周期与插件相互绑定，用以完成实际的构建任务。具体而言，是生命周期的阶段与插件的目标相互绑定，以完成某个具体的构建任务。

4.2.1 内置绑定

  为了能让用户几乎不用任何配置就能构建Maven项目，Maven在核心为一些主要的生命周期阶段绑定了很多插件的目标，当用户通过命令行调用生命周期阶段的时候，对应的插件目标就会执行相应的任务。

详细参考官网：Built-in Lifecycle Bindings

注意：由于项目的打包类型会影响构建的具体过程，因此，default生命周期的阶段与插件目标的绑定关系有项目打包类型所决定，打包类型是通过POM中packaging元素定义的。

4.2.2 自定义绑定

  除了内置绑定以外，用户还能够自己选择将插件目标绑定到生命周期的某个阶段上。

  举例来说：创建项目的源码jar包，内置的插件绑定关系中并没有涉及这一任务，因此需要我们自行配置。maven-source-plugin的jar-no-fork目标能够将项目的主代码打包成jar文件，可以将其绑定到default生命周期的verify阶段上，在执行完集成测试后和安装构件之前创建源码jar包。具体的配置如下：

<build>
<plugins>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>2.1.1</version>
<execution>
<id>attach-sources</id>
<phase>verify</phase>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</plugins>
</build>

  在POM的build元素下的plugins子元素中声明插件的使用，其中groupId元素是Maven官方插件的groupId，artifactId和version是插件的基本坐标信息。重点是下面的插件执行配置，executions下每个execution子元素来配置执行一个任务，phrase元素，指定了绑定的生命周期的那个阶段，通过goals配置指定要执行的插件目标。

  运行mvn verify命令，会创建一个以-sources.jar结尾的源码文件包。需要注意的是，有时候，即使不通过phase元素配置生命周期阶段，插件目标也能够绑定到生命周期中去。我们可以使用maven-help-plugin查看插件详细信息，了解插件目标的默认绑定阶段。 

mvn help:describe -Dplugin=org.apache.maven.plugins:maven-source-plugin:2.1.1 -Ddetail

输出结果（部分）：

source:jar-no-fork
  Description: This goal bundles all the sources into a jar archive. This
    goal functions the same as the jar goal but does not fork the build and is
    suitable for attaching to the build lifecycle.
  Implementation: org.apache.maven.plugin.source.SourceJarNoForkMojo
  Language: java
  Bound to phase: package

从输出可以看出表示该目标默认绑定的生命周期阶段package，也就是说，当用户配置使用maven-source-plugin的jar-no-fork目标的时候，如果不指定phase参数，该目标就会被绑定到package阶段。

  当插件目标被绑定到不同的声明周期阶段的时候，其执行顺序会由生命周期阶段的先后顺序决定。如果多个目标被绑定到同一阶段的时候，这些插件声明的先后顺序决定了目标的执行顺序。

4.3 插件配置

  完成了插件和生命周期的绑定之后，用户还可以配置插件目标的参数，进一步调整插件目标所执行的任务，以满足项目的需求。

4.3.1 命令行插件配置

  在上面我们已经接触到了，用户可以在Maven命令中使用-D参数，并伴随一个参数键=参数值的形式，来配置插件目标的参数。参数-D是Java自带的，其功能是通过命令行设置一个Java系统属性，Maven简单地重用了该参数，在准备插件的时候检查系统属性，便实现了插件参数的配置。

4.3.2 POM中插件全局配置

  并不是所有的插件参数都适合从命令行配置，有些参数的值从项目创建到项目发布都不会改变，或者说很少改变，对于这种情况，在POM文件中一次性配置就显然比重复再命令行输入要方便。

举例如下：我们通常会配置maven-compiler-plugin告诉它编译Java1.5版本的源文件，生成与JVM1.5兼容的字节码文件，配置如下：

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compile-plugin</artifactId>
<version>2.1</version>
<configuration>
<source>1.5</source>
<target>1.5</target>
</configuration>
</plugin>
</plugins>
</build>

4.3.3 POM中插件任务配置

  除了为插件配置全局参数，用户还可以为某个插件任务配置特定的参数。插件全局配置中configuration元素位于plugin元素下面，而插件任务配置时configuration元素则位于execution元素下，表示这是特定任务的配置，而非插件整体的配置。

4.4 获取插件

Apache官方插件：http://maven.apache.org/plugins/index.html

4.5 插件解析机制

  为了方便用户使用和配置插件，Maven不需要用户提供完整的插件坐标信息，就可以解析得到正确的插件，Maven这一特性是一把双刃剑，虽然它简化了插件的使用和配置，可一旦插件的行为出现异常，用户就很难快速定位到出问题的插件构件。

4.5.1 插件仓库

  与依赖构件一样，插件构件同样基于坐标存储在Maven仓库中。值得一提的是Maven会区别对待依赖的远程仓库与插件的远程仓库。当Maven需要的依赖在本地仓库不存在时，他会去所配置的远程仓库查找，可当Maven需要的插件在本地仓库不存在时，他就不会去这些远程仓库查找。

  不同于repositories及其repository子元素，插件远程仓库使用pluginRepositories和pluginRepository配置。

Maven内置了如下的插件远程仓库配置，如下：

<pluginRepositories>
<pluginRepository>
<id>central</id>
<name>Maven Plugin Repository</name>
<url>http://repo1.maven.org/maven2</url>
<layout>default</layout>
<snapshots>
<enabled>false</enabled>
</snapshots>
<releases>
<updatePolicy>never</updatePolicy>
</releases>
</pluginRepository>
</pluginRepositories>

  除了pluginRepositories和pluginRepository标签不同之外，其余所有子元素表达的含义与依赖远程仓库配置完全一样。我们可以看到，这个默认插件仓库的地址就是中央仓库，他关闭了对SANPSHOT的支持，以防止引入SANPSHOT的版本的插件而导致不稳定的构建。

  一般来说，中央仓库所包含的插件完全能够满足我们的需要，因此也不需要配置其他的插件仓库。

4.5.2 插件的默认groupId

  在POM中配置插件的时候，如果插件是Maven的官方插件（即如果其groupId为org.apache.maven.plugins），就可以省略groupId配置。

4.5.3 解析插件版本

  为了简化插件的配置和使用，在用户没有提供插件版本的情况下，Maven会自动解析插件的版本，首先，Maven在超级POM中为所有插件设定了版本，如果用户使用某个插件时 没有设定版本，而这个插件又不属于核心插件的范畴，Maven就会去检查所有仓库中可用的版本，然后做出选择。Maven3调整了解析机制，当插件没有声明版本的时候，不再解析至latest，而是使用release。这样就可以避免由于快照频繁更新而导致的插件行为不稳定。

4.5.4 解析插件前缀

  mvn命令行支持使用插件前缀来简化插件的调用。插件前缀与groupId:artifactId是一一对应，这种匹配关系存储在仓库元数据中。（此处略）

  

参考资料：

《Maven实战》

最后修改时间：2017年1月15日11:11:18

********************************************************************************结束语********************************************************************************************

  我在写这篇博客的时候也是一名初学者，有任何疑问或问题请留言，或发邮件也可以，邮箱为：fanxiaobin.fxb@qq.com，我会尽早的进行更正及更改。

在我写过的博客中有两篇博客是对资源的整理，可能对大家都有帮助，大家有兴趣的话可以看看！！
下载资料整理——目录：http://blog.csdn.net/fanxiaobin577328725/article/details/51894331

  这篇博客里面是我关于我见到的感觉不错的好资源的整理，里面包含了书籍及源代码以及个人搜索的一些资源，如果有兴趣的可以看看，我会一直对其进行更新和添加。
优秀的文章&优秀的学习网站之收集手册：http://blog.csdn.net/fanxiaobin577328725/article/details/52753638

  这篇博客里面是我对于我读过的，并且感觉有意义的文章的收集整理，纯粹的个人爱好，大家感觉有兴趣的可以阅读一下，我也会时常的对其进行更新。

********************************************************************************感谢********************************************************************************************