首页 > 代码库 > Maven学习笔记(六)：生命周期与插件

Maven学习笔记(六)：生命周期与插件

2024-07-21 00:25:34   222人阅读

何为生命周期：

     Maven的生命周期就是为了对所有的构建过程进行抽象和统一。Maven从大量项目和构建工具中学习和反思，然后总结了一套高度完善的、易扩展的生命周期。这个生命周期包含了项目的清理、初始化、编译、测试、打包、集成测试、验证、部署和站点生成等几乎所有构建步骤。也就是说，几乎所有项目的构建，都能映射到这样一个生命周期上。
     Maven的生命周期是抽象的，这意味着生命周期本身不做任何实际的工作，在Maven的设计中，实际的任务(如编译源代码)都交由插件来完成。这种思想与设计模式中的模板方法(Template Method)非常相似。每个构建步骤都可以绑定一个或者多个插件行为，而Maven为大多数构建步骤编写并绑定了默认插件。当用户有特殊需要的时候，也可以配置插件定制构建行为，甚至自己编写插件。

生命周期详解：

三套生命周期：
     Maven拥有三套互相独立的生命周期，它们分别是clean、default和site。clean生命周期的目的是清理项目，default生命周期的目的是构建项目，而site生命周期的目的是建立项目站点。
     每个生命周期包含一些阶段，这些阶段是有顺序的，并且后面的阶段依赖于前面的阶段，用户和Maven最直接的交互方式就是调用这些生命周期阶段。较之于生命周期阶段的前后依赖关系，三套生命周期本身是相互独立的。
Clean生命周期：
     clean生命周期的目的是清理项目，它包含三个阶段:
  • pre-clean：执行一些清理前需要完成的工作
  • clean：清理上一次构建生成的文件
  • post-clean：执行一些清理后需要完成的工作
default生命周期：     
  • validate    
  • initialize
  • generate-source
  • process-sources：处理项目主资源文件。一般来说，是对src/main/resource目录的内容进行变量替换等工作后，复制到项目输出的主classpath目录中。
  • generate-resources
  • process-resources
  • compile：编译项目的源代码，一般来说，是编译src/main/java目录下的Java文件至项目输出的主classpath目录中
  • process-classes
  • generate-test-sources
  • process-test-sources：处理项目测试资源文件。一般来说，是对src/test/resource目录的内容进行变量替换等工作后，复制到项目输出的主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项目使用
site生命周期：
     site生命周期的目的是建立和发布项目站点，Maven能够基于POM所包含的信息，自动生成一个友好的站点，方便团队交流和发布项目信息。该生命周期包含如下阶段：
  • pre-site：执行一些在生成项目站点之前需要完成的工作
  • site：生成项目站点文档
  • post-site：执行一些在生成项目站点之后需要完成的工作
  • site-deploy：将生成的项目站点发布到服务器上
命令行与生命周期：
     从命令行执行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生命周期的最后一个阶段。

插件目标：

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

插件绑定：

     Maven的生命周期与插件相互绑定，用以完成实际的构建任务。具体而言，是生命周期的阶段与插件的目标相互绑定，以完成某个具体的构建任务。例如项目编译这一任务，它对应了default生命周期的compile这一阶段，而maven-compile-plugin这一插件的compile目标能完成该任务。
内置绑定：
     Maven为一些核心的生命周期绑定了很多插件的目标，当用户通过命令行调用生命周期阶段的时候，对应的插件目标就会执行相应的任务。
     clean生命周期阶段与插件目标的绑定关系：
生命周期阶段插件目标
pre-clean
clean
post-clean
maven-clean-plugin:clean
     site生命周期阶段与插件目标的绑定关系：
生命周期阶段插件目标
pre-site
site
post-site
site-deploy
maven-site-plugin:site

maven-site-plugin:deploy
     相对于clean和site生命周期来说，default生命周期与插件目标的绑定关系就显得复杂一些。由于项目的打包类型会影响构建的具体过程，因此，default生命周期的阶段与插件目标的绑定关系由项目打包类型所决定，打包类型是通过packaging元素定义的。最常见、最重要的打包类型是jar，它也是默认的打包类型。基于该打包类型的项目，其default生命周期的内置插件绑定关系及具体任务如下：
生命周期阶段插件目标
process-resources
compile
process-test-resources
test-compile
test
package
install
deploy		maven-resources-plugin:resources
maven-compiler-plugin:compile
maven-resources-plugin:testResources
maven-compiler-plugin:testCompile
maven-surefire-plugin:test
maven-jar-plugin:jar
maven-intall-plugin:install
maven-deploy-plugin:deploy
     除了默认的打包类型jar之外，常见的打包类型还有war、pom、maven-plugin、ear等。
自定义绑定：
     除了内置绑定以外，用户还能够自己选择将某个插件目标绑定到生命周期的某个阶段上。一个常见的例子是创建项目的源码jar包，内置的插件绑定关系中并没有涉及这一任务，因此需要用户自行配置。maven-source-plugin可以帮助我们完成该任务，它的jar-no-fork目标能够将项目的主代码打包成jar文件，可以将其绑定到default生命周期的verify阶段上，在执行完集成测试后和安装构件之前创建源码jar包。
<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>
     在插件执行配置中，executions下每个execution子元素可以用来配置执行一个任务。该例中配置了一个id为attach-sources的任务，通过phase配置，将其绑定到verify生命周期阶段上，再通过goals配置指定要执行的插件目标。
     有时候，即使不通过phase元素配置生命周期阶段，插件目标也能够绑定到生命周期中去。出现这种现象的原因是：有很多插件的目标在编写时已经定义了默认绑定阶段。可以使用maven-help-plugin查看插件详细信息，了解插件目标的默认绑定阶段。运行命令如下：
     $mvn help:describe -Dplugin = org.apache.maven.plugins:maven -source-plugin:2.1.1 -Ddetail
     当插件目标被绑定到不同的生命周期阶段的时候，其执行顺序会由生命周期阶段的先后顺序决定。当多个插件目标绑定到同一个阶段的时候，这些插件生命的先后顺序决定了目标的执行顺序。

插件配置：

     用户可以配置插件目标的参数，进一步调整插件目标所执行的任务，以满足项目的需求。
命令行插件配置：
     很多插件目标的参数都支持从命令行配置，用户可以在Maven命令中使用-D参数，并伴随一个参数键=参数值的形式，来配置插件目标的参数。
     例如，maven-surefire-plugin提供了一个maven.test.skip参数，当其值为true的时候，就会跳过执行测试。于是，在运行命令的时候，加上如下-D参数就能跳过测试：
     $mvn install -Dmaven.test.skip=true
POM中插件全局配置：
     并不是所有的插件参数都适合从命令行配置，有些参数的值从项目创建到项目发布都不会改变，或者说很少改变，对于这种情况，在POM文件中一次性配置就显然比重复在命令行输入要方便。例如，我们通常需要配置maven-compiler-plugin告诉它编译Java 1.5版本的源文件，生成与JVM 1.5兼容的字节码文件，代码如下：
<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>

POM中插件任务配置：
     除了为插件配置全局的参数，用户还可以为某个任务配置特定的参数。以maven-antrun-plugin为例，它有一个目标run，可以用来在Maven中调用Ant任务。用户将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>

     插件全局配置中的configuration元素位于plugin元素下面，而这里的configration元素则位于execution元素下，表示这是特定任务的配置，而非插件整体的配置。这个ant-validate任务配置了一个echo Ant任务，向命令行输出一段文字，表示该任务是绑定到validate阶段的。第二个任务的id为ant-verify，它绑定到了verify阶段，同样它也输出一段文字到命令行，告诉该任务绑定到了verify阶段。

Maven学习笔记(六)：生命周期与插件


联系
我们