maven生命周期和插件

Maven生命周期

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

  Maven的生命周期是抽象的,这意味着生命周期本身不做任何实际的工作,在Maven的设计中,实际的任务(如编译源代码)都交由插件来完成。这种思想和设计模式中的模板方法非常相似。

  生命周期抽象了构建的各个步骤,定义了它们的次序,但没有提供具体的实现,那么谁来实现这些步骤呢?是插件。每个构建步骤都可以绑定一个或者多个插件行为,而且Maven为大多数构建步骤编写并绑定了默认插件。例如,针对编译的插件有maven-compiler-plugin,针对测试的插件有maven-surefire-plugin等。

  Maven有三套相互独立的生命周期,它们分别是clean、default和site。clean生命周期的目的是清理项目,default生命周期的目的是构建项目,而site生命周期的目的是建立项目站点。
  
  每个生命周期包含一些阶段(phase),这些阶段是有顺序的,并且后面的阶段依赖于前面的阶段,用户和Maven最直接的交互方式就是调用这些生命周期阶段。

clean生命周期

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

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项目使用。

    对于上述未加解释的阶段,比较简单,详情可参阅官方说明:文档

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

插件目标

  对于插件来说,为了能够复用代码,它往往能够完成多个任务。例如maven-dependency-plugin,它能基于项目依赖做很多事情。它能够分析项目依赖,帮助找出潜在的无用依赖;它能够列出项目的依赖树,帮助分析依赖来源;它能够列出项目所有已解析的依赖等等。为每个这样的功能编写一个独立的插件显然是不可取的,因为这些任务背后有很多可以复用的代码,因此,这些功能聚集在一个插件里,每个功能就是一个插件目标。
  
  maven-dependency-plugin有十多个目标,每个目标对应了一个功能,上述提到的几个功能分别对应的插件目标为dependency:analyzedependency:treedependency:list。这是一种通用的写法,冒号前面是插件前缀,冒号后面是该插件的目标。类似地,还可以写出compiler:compile(这是maven-compiler-plugin的compile目标)。

插件绑定

  生命周期的阶段与插件的目标相互绑定,以完成某个具体的构建任务。
  例如,default生命周期的compile阶段,绑定了maven-compiler-plugin插件的compile目标。

插件配置

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

  命令行配置:使用-D参数,并伴随一个参数键=参数值得形式来配置插件的参数。
例如,maven-surefie-plugin提供了一个maven.test.skip参数,当其值为true的时候,就会跳过执行测试。$mvn install -Dmaven.test.skip=true

  POM配置:并不是所有的插件参数都适合从命令行配置,有些参数的值从项目创建到项目发布都不会改变,或者说很少改变,对于这种情况,在POM文件中一次性配置就显然比重复在命令行输入要方便。
  
  可以在声明插件时,对此插件进行一个全局的配置。也就是说,所有基于该插件目标的任务,都会使用这个配置。 例如,我们通常会需要配置maven-compiler-plugin告诉它编译Java1.5版本的源文件,生成JVM1.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>

  这样,不管绑定到compile阶段的maven-compiler-plugin:compile任务,还是绑定到test-compile阶段的maven-compiler-plugin:testCompile任务,都能够使用该配置,基于Java1.5版本进行编译。

猜你喜欢

转载自blog.csdn.net/gnd15732625435/article/details/80461851