EZLippi-浮生志

Maven生命周期和插件

Maven有几个核心的概念,包括坐标、依赖、仓库,这几个概念比较容易理解,Maven另外两个重要的概念是生命周期和插件,你在工作中可能会经常使用maven clean install这样的命令来打包项目,但是你有没有仔细想过这两个命令会执行哪些操作。

项目构建的生命周期不外乎清理、编译、测试、打包和部署,这个工作可以通过自动化脚本来完成,为了能够对各个过程容易扩展,Maven引入了一套生命周期的概念,Maven的生命周期就是对所有的构建过程进行抽象和统一,这个生命周期包括项目的清理、初始化、编译、测试、打包、集成测试、验证、部署和站点生成。既然生命周期是抽象的,意味着生命周期本身不做任何实际的工作,实际的任务都是有相应的插件来完成,这种思想和设计模式的模板方法有点相似,在父类中定义算法的整体结构,子类中通过实现或者重写父类的方法来控制实际的行为。

三套生命周期

Maven有三套相互独立的生命周期,分别是clean,default和site生命周期,clean生命周期用来清理项目,default生命周期用来构建项目,site生命周期用来建立项目站点。每个生命周期都会有相应的阶段(phase),用户一般调用这些生命周期的阶段来完成相应的工作,比如clean生命周期有pre-clean,clean和post-clean三个阶段,生命周期的阶段前后有依赖关系,调用clean阶段时会先执行pre-clean阶段。

default生命周期

default生命周期用来构建项目,是用户接触最多的,它有很多个阶段,这里我只介绍比较重要的几个阶段:

  • compile:编译项目源代码,一般是src\main\java目录下
  • test-compile:编译项目的测试代码
  • test使用单元测试框架运行单元测试,测试代码不会被打包或部署
  • package:打包成可发布的格式,如Jar,War,Bundle
  • Integration-test:集成测试
  • install:将包安装到Maven本地仓库,供本地其他项目使用
  • deploy:将最终的包袱值到远程仓库,供其他开发人员和项目组使用

通过命令行执行生命周期阶段

比如我们常用mvn clean来清理项目,会执行clean生命周期的clean阶段,实际上会执行pre-clean和clean阶段,调用mvn test来执行单元测试时会自动test阶段之前的所有阶段,包括default生命周期的validate,initialize,compile和test-compile,也就是说调用mvn test会自动编译项目的源代码和测试代码。调用mvn install时会执行default生命周期从validate到install的所有阶段,我们常常会结合两个生命周期来调用,比如mvn clean install既执行了clean生命周期的pre-clean.clean阶段,也执行了default生命周期的compile,test-compile,test,package,install阶段。

site生命周期用来建立和发布项目站点,一般用的比较少,主要有四个阶段,pre-site,site,post-site和site-deploy,这里就不一一介绍了。

插件的目标(Goal)

前面讲过,Maven的生命周期只是抽象的,具体的任务执行都依赖于相应的插件,比如编译源代码依赖于maven-compiler插件,执行单元测试依赖于maven-surefire插件,每个插件有很多个目标(goal),不同目标有不同的功能,比如maven-dependecy-plugin有analyze,tree和list目标,一般我们通过·插件前缀:插件目标·来执行相应的功能,比如mvn dependency:tree来列出项目的依赖树,用mvn surefire:test来执行maven-surefire-plugin的test目标。

生命周期阶段和插件目标的绑定

为了减少用户的配置,Maven给一些主要的生命周期阶段绑定了很多插件的目标,比如maven clean生命周期的clean阶段绑定了maven-clean-plugin的clean目标,执行mvn clean会调用maven-clean-plugin的clean目标,compile阶段绑定了maven-compiler-plugin的compiler目标,test阶段绑定了maven-surefire-plugin的test目标,install阶段绑定了maven-install-plugin的install目标,package阶段绑定了maven-jar-plugin的jar目标,除了默认的jar打包类型外,常见的还有pom,war.

自定义绑定

除了内置绑定意外,用户还能够自己将某个插件目标绑定到生命周期的某个阶段上,这种自定义绑定方式能让Maven项目的构建过程中执行更附特色的任务一个常见的例子是创建项目的源码jar包,内置插件没有绑定这个任务,需要自行设置,maven-source-plugin可以帮我们完成,他的jar-no-fork目标就是将项目的主代码打包成jar文件,可以将其绑定到default生命周期的verify阶段上,在执行完集成测试后很安装构建之前创建源码jar包:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<bulid>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>2.1.1</version>
<executons>
<execution>
<id>attach-sources</id>
<phase>verify</phase>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executons>
</plugin>
</plugins>
</bulid>

插件任务配置

用户可以为某个插件任务配置特定的参数,以maven-antrun-plugin为例,他有一个目标run,可以用来在Maven中调用Ant任务,用户将这个插件的run绑定到多个生命周期阶段上,再加以不同的配置,就可以让Maven在不同的生命阶段执行不同的任务。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<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 validate phase</echo>
</tasks>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>

maven-help-plugin获取插件描述

maven-help-plugin用来获取插件的详细信息,可以运行如下命令:$mvn help:describe -Dplugin = org.apache.maven.plugins:maven-compiler-plugin:2.1,也就是执行maven-help-plugin的describe目标,结果中列出了插件的坐标,目标前缀和目标等,目标前缀为了在命令行直接运行插件,maven-compiler-plugin的前缀为compiler,在描述插件时可以省去版本信息,进一步简化为 $mvn help:describe -Dplugin = compiler,只想要了解某个目标信息可以加上goal参数:如$mvn help:describe -Dplugin = compiler -Dgoal = compile 想要更详细信息则加上detail参数:$mvn help:describe -Dplugin = compiler -Ddetail,在命令行执行之后输出如下所示,可以看到插件前缀为compiler:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Name: Apache Maven Compiler Plugin
Description: The Compiler Plugin is used to compile the sources of your
project.
Group Id: org.apache.maven.plugins
Artifact Id: maven-compiler-plugin
Version: 3.5.1
Goal Prefix: compiler

This plugin has 3 goals:

compiler:compile
Description: Compiles application sources

compiler:help
Description: Display help information on maven-compiler-plugin.
Call mvn compiler:help -Ddetail=true -Dgoal=<goal-name> to display
parameter details.

compiler:testCompile
Description: Compiles application test sources.

For more information, run 'mvn help:describe [...] -Ddetail'

命令行使用插件

一般通过mvn 插件前缀:目标来调用插件执行某个任务,比如mvn help describe这里调用的是maven-help-plugin的describe目标,插件前缀的信息可以用这个任务来获取,maven-compiler-plugin的插件前缀是compiler,执行编译任务可以用mvn compiler:compile来执行,一般我们直接调用生命周期阶段mvn compile也可以实现相同的效果,因为compile生命周期阶段绑定了maven-compiler-plugin的compile目标。

🐶 您的支持将鼓励我继续创作 🐶

热评文章