maven详解之生命周期与插件

最新推荐文章于 2024-06-19 07:44:47 发布

转载最新推荐文章于 2024-06-19 07:44:47 发布 · 427 阅读

持续集成CI 专栏收录该内容

4 篇文章

订阅专栏

介绍Maven的生命周期、内置绑定及插件配置方法。包括clean、default、site生命周期的各阶段，以及如何通过插件实现不同构建任务。

来源：http://blog.youkuaiyun.com/wanghantong/article/details/36424149

Maven是一个优秀的项目管理工具，它能够帮你管理编译、报告、文档等。

Maven的生命周期：

maven的生命周期是抽象的，它本身并不做任何的工作。实际的工作都交由"插件"来完成。

maven的每个构建步骤都可以绑定一个或多个插件行为，而且maven为大多数的构建步骤编写并绑定了默认插件。

三套生命周期：

clean、default、site

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生命周期: 建立和发布项目站点，Maven能够基于POM所包含的信息，自动生成站点

pre-site: 执行一些在生成项目站点之前需要完成的工作

site: 生成项目站点文档

post-site: 执行一些在生成项目站点之后需要完成的工作

site-deploy: 将生成的项目站点发布到服务器上

Maven的生命周期的各个阶段是前后阶段相互依赖的，当用户调用clean的时候，pre-clean 和 clean阶段会顺序执行，不会碰触default的任何阶段。

在命令行中的复杂调用和生命周期各个阶段的执行情况：

从三个例子来说明：

1.$mvn test : 该命令调用default生命周期的 test 阶段。实际执行的阶段为default生命周期的validate到test的所有阶段

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

3.$mvn clean deploy site-deploy : 该命令调用了clean生命周期的clean阶段和default生命周期的deploy阶段，以及site生命周期的site-deploy阶段。实际执行的是clean生命周期的pre-clean、clean阶段和default生命周期的所有阶段，以及site生命周期的所有阶段。

Maven的插件

Maven的核心分发包只有不到3MB的大小，Maven会在需要的时候下载并使用插件，对于插件本身，为了能够复用代码，它往往能够完成多个任务。Maven的生命周期与插件相互绑定，用以完成实际的构建任务。具体而言是生命周期的阶段与插件的目标相互绑定，以完成某个具体的构建任务。

内置绑定

Maven在核心为一些主要的生命周期阶段绑定了很多插件的目标

clean生命周期阶段与插件目标的绑定关系

生命周期阶段	插件目标
pre-clean
clean	maven-clean-plugin:clean
post-clean

site生命周期阶段与插件目标的绑定关系

生命周期阶段	插件目标
pre-site
site	maven-site-plugin:site
post-site
site-deploy	maven-site-plugin:deploy

default生命周期与内置插件绑定关系及具体任务(打包类型: jar)

生命周期阶段	插件目标	执行任务
process-resources	maven-resources-plugin:resources	复制主资源文件至主输出目录
compile	maven-compile-plugin:compile	编译主代码至主输出目录
process-test-resources	maven-resources-plugin:testRresources	复制测试资源文件至测试输出目录
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	将项目输出构件部署到远程仓库

插件解析机制和常见问题

与依赖构件一样，插件构件同样基于坐标存储在Maven仓库中。在需要的时候，Maven会从本地仓库寻找插件，如果不存在，则从远程插件仓库查找。找到插件之后，再下载到本地仓库使用

注：依赖的远程仓库！= 插件的远程仓库，Maven会区别对待他们。

Maven需要的依赖在本地仓库中不存在时，Maven会去配置的远程仓库中查找

Maven需要的插件在本地仓库中不存在时，Maven不会去这些远程仓库查找。

如何配置插件的远程仓库

Maven的插件远程仓库使用<pluginRepositories>和><pluginRepository>进行配置

Maven内置的插件远程仓库配置如下：它关闭了对SNAPSHOT的支持，防止不稳定的构建

 
   [html] 
   view plain
    copy
  
<pluginRepositories>  
        <pluginRepository>  
            <id>central</id>  
            <name>Maven Plugin Repository</name>  
            <url>http://repo1.maven.org/maven2</url>  
            <layout>default</layout>  
            <snapshots>  
                <enabled>false</enabled>  
            </snapshots>  
            <releases>  
                <updatePolicy>never</updatePolicy>  
            </releases>  
        </pluginRepository>  
    </pluginRepositories>  

——————

1）稳定性

对自定义绑定的插件，应该声明一个非快照版本来保证构建的稳定。

2） execution

配置执行一个 id 为 attach-sources 的任务，通过 phase 配置绑定到verify 生命周期阶段上，

再通过 goals 配置指定要执行的插件目标。

3）默认绑定阶段

有很多插件的目标在编写时已经定义了默认绑定阶段，删除上面 phase一行配置，

再次执行 mvn verify，效果仍然一样。

4）执行顺序

当插件目标被绑定到不同的生命周期阶段，其执行顺序会由生命周期阶段的先后顺序决定。

如果多个目标被绑定到同一阶段，他们的执行会是？当多个插件目标绑定到同一阶段的时候，

这些插件声明的先后顺序决定了目标的执行顺序。

3. 插件配置

完成了插件和生命周期的绑定之后，还可以配置插件目标的参数，进一步调整插件目标所执行的任务，

几乎所有的 Maven 插件都有一些可配置的参数。

a）命令行配置

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

例如：install–Dmaven.test.skip=true。

i. –D 参数

是 Java 自带，功能是通过命令行设置一个 Java 系统属性，Maven 简单地重用了该参数。

ii. maven-surefire-plugin

maven-surefire-plugin 提供一个 maven.test.skip 参数，当其值为 true的时候，

就会跳过执行测试。

b） pom 中插件全局配置

并不是所有插件参数都适合命令行配置，有些参数的值从项目创建到项目发布都不会改变，

或者说很少改变，对于这种情况，在 pom 文件中一次性配置就显得比重复在命令行输入要方便。

用户可以在声明插件的时候，对此插件进行一个全局的配置。也就是说，

所有该基于该插件目标的任务，都会使用这些配置。

例如：编译 Java 源文件版本。

i. 编译 Java 源文件版本

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