【项目管理工具】Maven学习笔记（四）Maven生命周期和插件

• 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生命周期的任何阶段。
  ##1.1 clean生命周期
• clean生命周期的目的是清理项目，它包含三个阶段：
  • pre-clean：执行一些清理前需要完成的工作。
  • clean：清理上一次构建生成的文件。
  • post-clean：执行一些清理后需要完成的工作
    ##1.2 default生命周期
• default生命周期定义了真正构建时所需要执行的所有步骤，它是所有生命周期中最核心的部分，其包含的阶段如下：
  • validate：检查工程配置是否正确，完成构建过程的所有必要信息是否能够获取到。
  • initialize：初始化构建状态，例如设置属性。
  • generate-sources：生成编译阶段需要包含的任何源码文件。
  • process-sources：处理项目主资源文件。一般来说，是对src/main/resources目录的内容进行变量替换等工作后，复制到项目输出的主classpath目录中。
  • generate-resources：生成工程包中需要包含的资源文件。
  • process-resources：拷贝和处理资源文件到目的目录中，为打包阶段做准备。
  • compile：编译项目的主源码。一般来说，是编译src/main/java目录下的Java文件至项目输出的主classpath目录中。
  • process-classes：处理编译生成的文件，例如 Java Class 字节码的加强和优化。
  • generate-test-sources：生成编译阶段需要包含的任何测试源代码。
  • process-test-sources：处理项目测试资源文件。一般来说，是对src/test/resources目录的内容进行变量替换等工作后，复制到项目输出的测试classpath目录中。
  • test-compile：编译项目的测试代码。一般来说，是编译src/test/java目录下的Java文件至项目输出的测试classpath目录中。
  • process-test-classes：处理测试代码文件编译后生成的文件。
  • test：使用单元测试框架运行测试，测试代码不会被打包或部署。
  • prepare-package：在真正打包之前，为准备打包执行任何必要的操作。
  • package：获取编译后的代码，并按照可发布的格式进行打包，例如 JAR、WAR 或者 EAR 文件。
  • pre-integration-test：在集成测试执行之前，执行所需的操作。例如，设置所需的环境变量。
  • integration-test：处理和部署必须的工程包到集成测试能够运行的环境中。
  • post-integration-test：在集成测试被执行后执行必要的操作。例如，清理环境。
  • verify：运行检查操作来验证工程包是有效的，并满足质量要求。
  • install：安装工程包到本地仓库中，该仓库可以作为本地其他工程的依赖。
  • deploy：拷贝最终的工程包到远程仓库中，以共享给其他开发人员和工程。
    ##1.3 site生命周期
• site生命周期的目的是建立和发布项目站点，Maven能够基于POM所包含的信息，自动生成一个友好的站点，方便团队交流和发布项目信息。该生命周期包含如下阶段：
  • pre-site执行一些在生成项目站点之前需要完成的工作。
  • site生成项目站点文档。
  • post-site执行一些在生成项目站点之后需要完成的工作。
  • site-deploy将生成的项目站点发布到服务器上。
    #2 命令行与生命周期
• 从命令行执行Maven任务的最主要方式就是调用Maven的生命周期阶段。需要注意的是，各个生命周期是相互独立的，而一个生命周期的阶段是有前后依赖关系的。下面以一些常见的Maven命令为例，解释其执行的生命周期阶段：
  • mvn clean：该命令调用clean生命周期的clean阶段。实际执行的阶段为clean生命周期的pre-clean和clean阶段。
  • mvn test：该命令调用default生命周期的test阶段。实际执行的阶段为default生命周期的validate、initialize等，直到test的所有阶段。这也解释了为什么在执行测试的时候，项目的代码能够自动得以编译。
  • mvn clean install：该命令调用clean生命周期的clean阶段和default生命周期的install阶段。实际执行的阶段为clean生命周期的pre-clean、clean阶段，以及default生命周期的从validate至install的所有阶段。该命令结合了两个生命周期，在执行真正的项目构建之前清理项目是一个很好的实践。
  • mvn clean deploy site-deploy：该命令调用clean生命周期的clean阶段、default生命周期的deploy阶段，以及site生命周期的site-deploy阶段。实际执行的阶段为clean生命周期的pre-clean、clean阶段，default生命周期的所有阶段，以及site生命周期的所有阶段。该命令结合了Maven所有三个生命周期，且deploy为default生命周期的最后一个阶段，site-deploy为site生命周期的最后一个阶段。
    #3 插件

插件相当于某个功能类，插件目标相当于这个类中的某个具体函数
##3.1 插件目标

• 一个插件可以有多个目标，每个目标对应了一个功能，通用的写法，冒号前面是插件前缀，冒号后面是该插件的目标。
  ##3.2 插件绑定
• Maven的生命周期与插件相互绑定，用以完成实际的构建任务。具体而言，是生命周期的阶段与插件的目标相互绑定，以完成某个具体的构建任务。
  ###3.2.1 内置绑定
• Maven在核心为一些主要的生命周期阶段绑定了很多插件的目标，当用户通过命令行调用生命周期阶段的时候，对应的插件目标就会执行相应的任务。（相当于是快捷键，调用相应的阶段就相当于调用了对应的插件目标）

表3-1 clean声明周期阶段与插件目标的绑定关系 |声明周期阶段|插件目标| |-|-| |pre-clean|| |clean|maven-clean-plugin:clean| |post-clean||

• site生命周期有pre-site、site、post-site和site-deploy四个阶段，其中，site和maven-site-plugin:site相互绑定，site-deploy和maven-site-plugin:depoy相互绑定。maven-site-plugin有很多目标，其中，site目标用来生成项目站点，deploy目标用来将项目站点部署到远程服务器上。

表3-2 site声明周期阶段与插件目标的绑定关系 |声明周期阶段|插件目标| |-|-| |pre-site|| |site|maven-site-plugin:site| |post-site|| |site-deploy|maven-site-plugin:deploy|

• default生命周期与插件目标的绑定关系就显得复杂一些。这是因为对于任何项目来说，例如jar项目和war项目，它们的项目清理和站点生成任务是一样的，不过构建过程会有区别。由于项目的打包类型会影响构建的具体过程，因此，default生命周期的阶段与插件目标的绑定关系由项目打包类型所决定，打包类型是通过POM中的packaging元素定义的。

表3-3 default声明周期的内置插件绑定关系及具体任务（打包类型：jar） |生命周期阶段|插件目标|执行任务| |-|-|-| |process-resources|maven-resources-plugin:resources|复制竹资源文件至输出目录| |compile|maven-compile-plugin:compile|编译主代码至输出目录| |process-test-resources|maven-resources-plugin:testResources|复制测试资源文件至测试输出目录| |test-compile|maven-compile-plugin:testCompile|编译测试代码至测试输出目录| |test|maven-surefire-plugin:test|执行测试用例| |package|maven-jar-plugin:jar|创建项目jar包| |install|maven-install-plugin:install|将项目输出构件安装到本地仓库| |deploy|maven-deploy-plugin:deploy|将项目输出的构件部署到远程仓库| ###3.2.2 自定义绑定 - 用户能够自己选择将某个插件目标绑定到生命周期的某个阶段上，这种自定义绑定方式能让Maven项目在构建过程中执行更多更富特色的任务。 ``` <?xml version="1.0" encoding="UTF-8"?> 4.0.0

<groupId>com.companyname.myapp</groupId>
<artifactId>project</artifactId>
<version>1.0-SNAPSHOT</version>

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

``` #4 插件配置 ##4.1 POM中插件全局配置 - 用户可以在声明插件的时候，对此插件进行一个全局的配置。也就是说，所有该基于该插件目标的任务，都会使用这些配置。 - 配置maven-compiler-plugin告诉它编译Java 1.5版本的源文件，生成与JVM 1.5兼容的字节码文件 ``` <?xml version="1.0" encoding="UTF-8"?> 4.0.0

<groupId>com.companyname.myapp</groupId>
<artifactId>project</artifactId>
<version>1.0-SNAPSHOT</version>

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

``` ##4.2 POM中插件任务配置 - 除了为插件配置全局的参数，用户还可以为某个插件任务配置特定的参数。 ``` <?xml version="1.0" encoding="UTF-8"?> 4.0.0

<groupId>com.companyname.myapp</groupId>
<artifactId>project</artifactId>
<version>1.0-SNAPSHOT</version>

<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>

- configuration元素位于execution元素下，表示这是特定任务的配置，而非插件整体的配置。