Maven生命周期和插件

生命周期和插件

• Maven的核心概念是：坐标、依赖、仓库、生命周期以及插件
• Maven的生命周期是抽象的，其实际行为都是由插件来完成的

1.1 何为生命周期

• Maven的生命周期就是为了对所有的构建过程进行抽象和统一
• 生命周期包含了项目的清理、初始化、编译、测试、打包、集成测试、验证、部署和站点生成等几乎所有构建步骤，几乎所有项目的构建，都能映射到这样一个生命周期上
• 每个构建步骤都可以绑定一个或者多个插件行为

1.2 生命周期详解

1.2.1 三套生命周期

Maven拥有三套相互独立的生命周期，分别是clean、default和site

• clean：清理项目
• default：构建项目
• site：建立项目站点
• 三套生命周期相互独立，不会对其他生命周期产生任何影响

1.2.2 clean生命周期

包含三个阶段：

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

1.2.3 default生命周期

default生命周期定义了真正构建时所需要执行的所有步骤，是所有生命周期中最核心的部分

• process-sources：处理项目主资源文件，是对src/main/resources目录的内容进行变量替换等工作后，复制到项目输出的主classpath目录中
• compile：编译项目的主代码，是编译src/main/java目录下的Java文件至项目输出的主classpath目录中
• process-test-sources：处理项目测试资源文件，是对src/test/resources目录的内容进行变量替换等工作后，复制到项目输出的测试classpath目录中
• test-compile：编译项目的测试代码
• test：使用单元测试框架运行测试，测试代码不会被打包或部署
• package：接受编译好的代码，打包成可发布的格式
• install：将包安装到Maven本地仓库，供本地其他Maven项目使用
• deploy：将最终的包复制到远程仓库，供其他开发人员和Maven项目使用

1.2.4 site生命周期

Maven能够基于POM包含的信息，自动生成一个友好的站点，方便团队交流和发布项目信息

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

1.2.5 命令行与生命周期

从命令行执行Maven任务的最主要方式就是调用Maven的生命周期阶段

1.3 插件目标

• Maven的核心仅仅定义了抽象的生命周期，具体的任务是交由插件完成的，插件以独立的构件形式存在
• 对于插件本身，为了能够复用代码，一个插件往往能够实现多个功能，每个功能就是一个插件目标
• 例如maven-dependency-plugin插件有十多个目标，常见的有dependency:analyze、dependency:tree、dependency:list等不同的功能

1.4 插件绑定

• 插件绑定是生命周期的阶段与插件的目标相互绑定，以完成某个具体的构建任务

1.4.1 内置绑定

​ 为了让用户不用任何配置就能构件Maven项目，Maven在核心为一些主要的生命周期阶段绑定了很多插件目标，这些绑定就是内置绑定。下面是三个生命周期中的内置绑定：

生命周期阶段	插件目标
clean(clean生命周期阶段)	maven-clean-plugin:clean
site(site生命周期阶段)	maven-site-plugin:site
site-deploy(site生命周期阶段)	maven-site-plugin:deploy

​ default生命周期阶段

生命周期阶段	插件目标	执行任务
process-resources	maven-resources-plugin:resources	复制主资源文件至主输出目录
compile	maven-compile-plugin:compile	编制主代码至主输出目录
process-test-resources	maven-resources-plugin:testResources	复制测试资源文件至测试输出目录
test-compile	maven-compiler-plugin:testCompile	编译测试代码至测试输出目录
test	maven-surefire-plugin:test	执行测试用例
package	maven-jar-plugin:jar	创建项目jar包
install	maven-install-plugin:install	将项目输出构件安装到本地仓库
deploy	maven-deploy–plugin:deploy	将项目输出构件部署到远程仓库

1.4.2 自定义绑定

• 用户可以自己选择将某个插件目标绑定到生命周期的某个阶段上
• 例子，我们将maven-source-plugin插件中的jar-no-fork目标绑定到default生命周期的verify阶段上，这样就可以将项目的主代码打包成jar文件

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

即便不通过phase配置生命周期阶段，该插件目标也能绑定到生命周期中去，是因为很多插件的目标在编写时就定义了默认绑定阶段

1.5 插件配置

1.5.1 命令行插件配置

​ 用户可以在Maven命令中使用-D参数，并伴随一个参数键 = 参数值的形式，来配置插件目标的参数，例如，maven-surefire-plugin提供了一个maven.test.skip参数，当其值为true的时候，跳过执行测试

$mvn install -Dmaven.test.skip = true

参数-D是Java自带的

1.5.2 POM中插件全局配置

​ 用户可以在声明插件的时候，对插件进行一个全局的配置，也就是说，所有基于该插件目标的任务，都会使用这些配置。例如，配置maven-compiler-plugin告诉它编译Java1.5的源文件，生成与JVM1.5兼容的字节码文件，如下

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

1.5.3 POM中插件任务配置

​ 用户可以为某个插件任务配置特定的参数，例如将maven-antrun-plugin:run绑定到多个生命周期阶段上，使用不同的配置，可以让Maven在不同的生命阶段执行不同的任务，如下

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-antrun-plugin</artifactId>
            <version>1.3</version>
            <executions>
                <execution>
                    <id>ant-validate</id>
                    <phase>validate</phase>
                    <goals>
                        <goal>run</goal>
                    </goals>
                    <configuration>
                        <tasks>
                            <echo>I'm bound to validate phase</echo>
                        </tasks>
                    </configuration>
                </execution>
                <execution>
                    <id>ant-verify</id>
                    <phase>verify</phase>
                    <goals>
                        <goal>run</goal>
                    </goals>
                    <configuration>
                        <tasks>
                            <echo>I'm bound to verify phase</echo>
                        </tasks>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

1. 实现，maven-antrun-plugin:run与validate阶段绑定，构成一个id为ant-validate的任务，configuration元素位于execution元素下，表达这是特定任务的配置，而非插件整体的配置
2. 第二个任务的id为ant-verify