Maven的核心概念生命周期和插件及常用插件

Maven的核心概念生命周期和插件及常用插件

前言

本文介绍了 Maven 的生命周期和插件两个重要的概念。不仅解释了生命周期背后的理念，还详细阐述了 clean、default、site 三套生命周期各自的内容。还重点介绍了 Maven 插件如何与生命周期绑定，以及 Spring Boot Maven Plugin。

除了坐标、依赖以及仓库之外，Maven 另外两个核心概念是生命周期和插件。

在有关 Maven 的日常使用中，命令行的输入往往就对应了生命周期，如 mvn package 就表示执行默认生命周期阶段 package 。

Maven 的生命周期是抽象的，其实际行为由插件来完成，如 package 阶段的任务可能就会由 maven-jar-plugin 完成。

生命周期和插件两者协同工作，密不可分。

生命周期

在 Maven 出现之前，项目构建的生命周期就已经存在，软件开发人员每天都对项目进行清理、编译、测试和部署。虽然大家都在不停地做构建工作，但公司和公司间、项目和项目间，往往使用不同的方式做类似的工作。

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

Maven 的生命周期是抽象的，这意味着生命周期本身不做任何实际的工作，在 Maven 的设计中，实际的任务都交由插件来完成。这种思想与设计模式中的模板方法非常相似。模板方法在父类中定义算法的整体结构，子类可以通过实现或者重写父类的方法来控制实际的行为，这样既保证了算法有足够的可扩展性，又能严格控制算法的整体结构。

Maven 的理念：生命周期抽象了构建的各个步骤，定义了它们的次序，但没有提供具体实现。通过设计的插件机制，每个构建步骤都可以绑定一个或者多个插件行为，Maven 为大多数构建步骤编写并绑定了默认插件。

例如，针对编译的插件有 maven-compiler-plugin ，针对测试的插件有 maven-surefire-plugin 等。虽然在大多数时间里，用户几乎都不会觉察到插件的存在，但实际上编译是由 maven-compiler-plugin 完成的，而测试是由 maven-surefire-plugin 完成的。

当用户有特殊需要的时候，也可以配置插件定制构建行为，甚至自己编写插件。

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

---

三套生命周期

Maven 拥有三套相互独立的生命周期，它们分别为 clean, default 和 site。 clean生命周期的目的是清理项目，default生命周期的目的是构建项目，而site生命周期的目的是建立项目站点。

每个生命周期包含一些阶段(phase)，这些阶段是有顺序的，并且后面的阶段依赖于前面的阶段，用户和 Maven 最直接的交互方式就是调用这些生命周期阶段。以clean生命周期为例，它包含的阶段有 pre-clean， clean 和 post-clean。当用户调用 pre-clean 的时候，只有 pre-clean 阶段得以执行；当用户调用clean的时候，pre-clean 和 clean 阶段会得以顺序执行；当用户调用post-clean的时候，pre-clean ，clean 和 post-clean。

较之于生命周期阶段的前后依赖关系，三套生命周期本身是相互独立的， 用户可以仅仅调用clean生命周期的某个阶段，或者仅仅调用default生命周期的某个阶段，而不会对其他生命周期产生任何影响。例如，当用户调用clean生命周期的clean阶段的时候，不会触发default生命周期的任何阶段，反之亦然， 当用户调用default生命周期的compile阶段的时候，也不会触发clean生命周期的任何阶段。

clean生命周期

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

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

default生命周期

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

1. validate
2. initialize
3. generate-sources
4. process-sources 处理项目主资源文件。一般来说，是对 src/main/resources 目录的内容进行变量替换等工作后，复制到项目输出的主classpath目录中。
5. generate-resources
6. process-resources
7. compile 编译项目的主源码。一般来说，是编译 src/main/java 目录下的Java文件至输出的主classpath目录中。
8. process-classes
9. generate-test-sources
10. process-test-sources 处理项目测试资源文件。一般来说，是对 src/test/resources 目录的内容进行变量替换等工作后，复制到项目输出的测试的classpath目录中。
11. generate-test-resources
12. process-test-resources
13. test-compile 编译项目的测试代码。一般来说，是编译 src/test/java 目录下的文件至项目输出的测试classpath目录中。
14. process-test-classes
15. test 使用单元测试单元框架运行测试，测试代码不会被打包或部署。
16. prepare-package
17. package 接受编译好的代码，打包成可发布的格式，如JAR。
18. pre-integration-test
19. integration-test
20. post-integration-test
21. verify
22. install 将包安装到Maven本地仓库，供本地其他Maven项目使用。
23. deploy 将最终的包复制到远程仓库，供其他开发人员和Maven项目使用。

site生命周期

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

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

---

命令行与生命周期

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

下面以一些常见的Maven命令为例，解释其执行的生命周期阶段：

1. mvn clean ： 该命令调用clean生命周期的clean阶段。 实际执行的阶段为clean生命周期的pre-clean 和 clean 阶段。

2. mvn test : 该命令调用default生命周期的test阶段。实际执行的阶段为default生命周期的validate, initialize等，直到test的所有阶段。这也解释了为什么在执行测试的时候，项目的代码能够自动得以编译。

3. mvn clean install : 该命令调用clean生命周期的clean阶段和default生命周期的install阶段。实际执行的阶段为clean生命周期的pre-clean， clean阶段，以及default生命周期的从validate至install的所有阶段。该命令结合了两个生命周期，在执行真正的项目构建之前清理项目是一个很好的实践。

4. mvn clean deploy site-deploy : 该命令调用clean生命周期的clean阶段，default生命周期的deploy阶段，以及site生命周期的site-deploy阶段。实际执行的阶段为clean生命周期的pre-clean， clean阶段， default生命周期的所有阶段，以及site生命周期的所有阶段。该命令结合了Maven所有三个生命周期，且deploy为default生命周期的最后一个阶段，site-deploy为site生命周期的最后一个阶段。

由于Maven中主要的生命周期阶段并不多， 而常用的Maven命令实际都是基于这些阶段简单组合而成的。因此只要对Maven生命周期有一个基本的理解，就可以正确而熟练的使用Maven命令。

插件

插件目标（Plugin Goal）

Maven 的核心仅仅定义了抽象的生命周期，具体的任务是交由插件完成的，插件以独立的构件形式存在，因此，Maven 核心的分发包只有不到3MB的大小，Maven 会在需要的时候下载并使用插件。

对于插件本身，为了能够复用代码，它往往能够完成多个任务。例如 maven-dependency-plugin ， 它能够基于项目依赖做很多事情。 它能够分析项目依赖， 帮助找出潜在的无用依赖；它能够列出项目的依赖树，帮助分析依赖来源；它能够列出项目所有已解析的依赖等等。 为每个这样的功能编写一个独立的插件显然是不可取的，因为这些任务背后有很多可以复用的代码，因此，这些功能聚集在一个插件里，每个功能就是一个插件目标(goal)。

maven-dependency-plugin 有十多个目标，每个目标对应了一个功能，上述提到的几个功能分别对应插件的目标为dependency:analyze， dependency:tree 和 dependency-list。 这是一种通用的写法，冒号前面是插件前缀，冒号后面是该插件的目标。类似地， 还可以写出compiler:compile(这是maven-compiler-plugin的compile目标) 和 surefire:test（这是maven-surefire-plugin的test目标）。

---

插件绑定

Maven 的生命周期与插件相互绑定，用以完成实际的构建任务。具体而言， 是生命周期的阶段与插件目标的相互绑定，以完成某个具体的构建任务。例如项目编译这一任务，它对应了default生命周期的compile 这一阶段，而maven-compiler-plugin这一插件的compile目标能够完成该任务。因此，将它们绑定，就能实现项目编译的目的。

---

内置绑定

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

clean 生命周期仅有 pre-clean、 clean 和 post-clean 三个阶段，其中的 clean 与 maven-clean-plugin:clean绑定。 maven-clean-plugin 仅有clean这一目标， 其作用就是删除项目的输出目录。

site 生命周期有pre-site 、 site、 post-site 和 site-deploy 四个阶段， 其中，

• site 和 maven-site-plugin:site 相互绑定，
• site-deploy 和 maven-site-plugin:deploy相互绑定。

maven-site-plugin 有很多目标，其中， site目标用来生成项目站点， deploy 目标用来将项目站点部署到远程服务器上。

相对于 clean 和 site 生命周期来说，default 生命周期与插件目标的绑定关系就显得复杂一些。 这是因为对于项目来说，例如jar项目和war项目， 它们的项目清理和站点生成任务是一样的，不过构建过程会有区别。例如jar项目需要打成JAR包，而war项目需要打成WAR包。

由于项目的打包类型会影响构建的具体过程，因此，default 生命周期的阶段与插件目标的绑定关系由项目打包类型决定，打包类型是通过 POM 中的packaging元素定义的。最常见，最重要的打包类型是jar, 它是默认的打包类型。基于该打包类型的项目， 其default生命周期的内置插件绑定关系及具体任务如下表所示。

注意，上表中只列出了拥有插件绑定关系的阶段，default生命周期还有很多其他阶段，默认它们没有绑定任何的插件，因此也没有任何实际行为。

default生命周期与插件目标的绑定关系可参阅Maven官方文档：https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html#Built-in_Lifecycle_Bindings

可以通过从 Maven 的命令行输出中看到在项目构建过程执行了哪些插件目标。

[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ validator-exception-demo ---
[INFO] 
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ validator-exception-demo ---

---

自定义绑定

除了内置绑定以外，用户还能够自已选择将某个插件目标绑定到生命周期的某个阶段上，这种自定义绑定方式能让 Maven 项目在构建过程中执行更多更富特色的任务。

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

<build>  
    <plugins>  
        <plugin>  
            <groupId>org.apache.maven.pluginsgroupId>  
            <artifactId>maven-source-pluginartifactId>  
            <version>2.1.1version>  
            <executions>  
                <execution>  
                    <id>attach-sourcesid>  
                    <phase>verifyphase>  
                    <goals>  
                        <goal>jar-no-forkgoal>  
                    goals>  
                execution>  
            executions>  
        plugin>  
    plugins>  
build>

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

---

插件配置

用户可以配置插件目标的参数，进一步调整插件目标所执行的任务，以满足项目的需求。几乎所有 Maven 插件的目标都有一些可配置的参数，用户可以通过命令行和 POM 配置等方式来配置这些参数。

1.命令行插件配置

在Maven命令中使用-D参数，并伴随一个参数键=参数值的形式来配置插件目标的参数。

例如maven-surefire-plugin提供了一个maven.test.skip参数，当其值为true的时候，就会跳过执行测试。于是，在运行命令的时候，加上如下-D参数就能跳过测试：
mvn install -Dmaven.test.skip=true
参数-D是Java自带的，其功能是通过命令行设置一个Java系统属性，Maven简单地重用了该参数，在准备插件的时候检查系统属性，便实现了插件参数的配置。

2.POM中插件全局配置

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

用户可以在声明插件的时候，对此插件进行一个全局的配置。也就是说，所有基于该插件目标的任务，都会使用这些配置。

<build>
	<plugins>
		<plugin>
            <groupId>org.apache.maven.pluginsgroupId>
            <artifactId>maven-compiler-pluginartifactId>
            <version>3.8.1version>
            <configuration>
                <source>1.8source>
                <target>1.8target>
                <encoding>UTF-8encoding>
            configuration>
        plugin>
	plugins>
build>

这样，不管绑定到 compiler 阶段的 maven-compiler-plugin:compile 任务，还是绑定到 test-compiler 阶段的 maven-compiler-plugin:testCompiler 任务，就都能够使用该配置，基于 Java 1.8 版本进行编译。

spring-boot-maven-plugin:repackage

Spring Boot Maven Plugin 插件提供 Spring Boot 在 maven 中的支持。允许你打包可运行的jar包或war包。

在打包 Spring Boot 项目成 jar 包时需要在 pom.xml 使用 spring-boot-maven-plugin 来增加Maven功能。

插件提供了几个maven目标和Spring Boot 应用一起工作

• spring-boot:repackage
• spring-boot:run
• spring-boot:start and spring-boot:stop
• spring-boot:build-info

repackage：创建一个自动可执行的jar或war文件。它可以替换常规的 artifact，或者用一个单独的 classifier 附属在maven构建的生命周期中。
　　
示例：

<plugin>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-maven-pluginartifactId>
    <version>2.1.18.RELEASEversion>
    <configuration>
        <mainClass>com.chen.example.demo2.Demo2ApplicationmainClass>
    configuration>
    <executions>
        <execution>
            <id>repackageid>
            <goals>
                <goal>repackagegoal>
            goals>
        execution>
    executions>
plugin>

这个例子重新打包了一个jar包或war包，这个jar包或war包被构建于maven生命周期的package阶段，包括定义在工程中的任何依赖（包括scope为provided）。如果有一些依赖模块需要被排除掉，可以使用一个exclude的选项。

默认情况下，repackage和run这两个maven目标会包括定义在工程中的任何依赖。

总结

生命周期

Maven 的生命周期就是为了对所有的构建过程进行抽象和统一。

Maven 的生命周期是抽象的，这意味着生命周期本身不做任何实际的工作，在 Maven 的设计中，实际的任务都交由插件来完成。

Maven 的理念：生命周期抽象了构建的各个步骤，定义了它们的次序，但没有提供具体实现。通过设计的插件机制，每个构建步骤都可以绑定一个或者多个插件行为，Maven 为大多数构建步骤编写并绑定了默认插件。

Maven 拥有三套相互独立的生命周期，它们分别为 clean, default 和 site。 clean生命周期的目的是清理项目，default生命周期的目的是构建项目，而site生命周期的目的是建立项目站点。

每个生命周期包含一些阶段(phase)，这些阶段是有顺序的，并且后面的阶段依赖于前面的阶段，用户和 Maven 最直接的交互方式就是调用这些生命周期阶段。

---

插件

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

对于插件本身，为了能够复用代码，它往往能够完成多个任务或功能，每个功能就是一个插件目标(goal)。。

插件绑定

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

内置绑定

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

自定义绑定

除了内置绑定以外，用户还能够自已选择将某个插件目标绑定到生命周期的某个阶段上，这种自定义绑定方式能让 Maven 项目在构建过程中执行更多更富特色的任务。

插件配置

用户可以配置插件目标的参数，进一步调整插件目标所执行的任务，以满足项目的需求。

• 1.命令行插件配置
• 2.POM中插件全局配置

Spring Boot Maven Plugin 插件提供 Spring Boot 在 maven 中的支持。允许你打包可运行的jar包或war包。

公众号

参考

《Maven 实战》 许晓斌