本文详细介绍了Maven中插件的配置，包括build和reporting两类插件，以及configuration、executions、dependencies和inherited等标签的使用。内容涵盖Mojo的概念、参数配置、映射对象以及执行阶段绑定等，旨在帮助读者深入理解Maven插件的配置和使用。
介绍
在Maven中包含两类插件：build、reporting，很显然，前者与项目构建有关，后者与项目报告有关。
build plugins
在build时、build后执行，配置：build元素。reporting plugins
在生成站点时执行，配置：reporting元素。
所有的插件的配置至少要包含：groupId，artifactId 和 version，恰好这三个元素为大家所熟悉，这里不再赘述。
configuration
这是build、reporting的公共元素。
先了解一下Mojo是什么：
每个插件都含有编写目标，比如clean、compile，Maven称之为Mojo。例子：假设我们有这样一个Mojo，它要查询一个URL地址，并且需要指定timeout及一些options:
/**
* @goal query
*/
public class MyQueryMojo
extends AbstractMojo
{
/**
* @parameter expression="${query.url}"
*/
private String url;
/**
* @parameter default-value="60"
*/
private int timeout;
/**
* @parameter
*/
private String[] options;
public void execute()
throws MojoExecutionException
{
...
}
}
针对这个Mojo配置POM，如下：
<project>
...
<build>
<plugins>
<plugin>
<artifactId>maven-myquery-plugin</artifactId>
<version>1.0</version>
<configuration>
<url>http://www.foobar.com/query</url>
<timeout>10</timeout>
<options>
<option>one</option>
<option>two</option>
<option>three</option>
</options>
</configuration>
</plugin>
</plugins>
</build>
...
</project>
很显然，configuration中的元素都与Mojo中的字段匹配，Maven的配置机制让人很简单的想到了使用XML配置来映射Java对象，所以上面的例子中，元素url映射到了url字段，timeout元素映射到了timeout字段，映射机制通过检查字段的类型来决定是否是一个可行的映射。对于Mojo而言，可以使用CLI（命令行）直接执行，所需要的参数可以通过系统属性来指定而取代通过configuration元素进行配置，对于那些参数，在插件文档中会描述系统参数由怎样的一个表达式来表示，在上面的例子中，url的表达式就是${query.url}，意味着它的值可以由系统属性query.url来表示：
mvn myquery:query -Dquery.url=http://maven.apache.org
注意，系统属性名不一定非要与Mojo的参数名一样，但这是一个比较普遍的做法。对于插件的系统变量，应该采用一些字首来避免与其他插件的系统变量冲突，甚至有些插件系统变量名与参数名毫不相关，所以查看插件文档是非常必要的。
参数配置
映射简单对象
<configuration>
<myString>a string</myString>
<myBoolean>true</myBoolean>
<myInteger>10</myInteger>
<myDouble>1.0</myDouble>
<myFile>c:\temp</myFile>
<myURL>http://maven.apache.org</myURL>
</configuration>
映射复杂对象
<configuration>
<person>
<firstName>Jason</firstName>
<lastName>van Zyl</lastName>
</person>
</configuration>
关于复杂对象映射的规则:
- 必须有一个private字段与元素名项对应，所以上面的例子中，Mojo必须含有person这样一个字段。
- 实例化的对象必须与Mojo在同一个包下，在上面的例子中，应该在包下找到Person类。
如果你想实例化的对象不再Mojo同一个包下，可以使用implementation属性进行如下的定义：
<configuration> <person implementation="com.mycompany.mojo.query.SuperPerson"> <firstName>Jason</firstName> <lastName>van Zyl</lastName> </person> </configuration>
映射集合
映射List
Mojo如下：public class MyAnimalMojo extends AbstractMojo { /** * @parameter */ private List animals; public void execute() throws MojoExecutionException { ... } }关于Mojo中animals的映射如下：
<project> ... <build> <plugins> <plugin> <artifactId>maven-myanimal-plugin</artifactId> <version>1.0</version> <configuration> <animals> <animal>cat</animal> <animal>dog</animal> <animal>aardvark</animal> </animals> </configuration> </plugin> </plugins> </build> ... </project>集合没有指定其元素的类型，那么将按照下面的规则确认类型：
- 如果标签包含了implementation属性，那么以属性指定的类型作为元素的类型。
- 如果标签名包含了符号“.”，那么尝试作为完整的类名使用。
- 若标签名以大写字母开头，尝试着使用同包下的同名类作为元素类型。
若标签不含子标签，就嘉定它为String类型。
映射Map
例子，Mojo定义如下：... /** * My Map. * * @parameter */ private Map myMap; ...POM中插件配置如下：
... <configuration> <myMap> <key1>value1</key1> <key2>value2</key2> </myMap> </configuration> ...映射properties
例子，Mojo定义如下：... /** * My Properties. * * @parameter */ private Properties myProperties; ...POM中插件配置如下：
... <configuration> <myProperties> <property> <name>propertyName1</name> <value>propertyValue1</value> <property> <property> <name>propertyName2</name> <value>propertyValue2</value> <property> </myProperties> </configuration> ...
build配置
使用executions标签
使用executions标签让插件参与到build生命周期中的某些阶段中，这是一个很常见的做法。比如前面的MyQueryMojo这个Mojo例子，我们可以如下配置使得Mojo参与到指定的阶段中：
<project>
...
<build>
<plugins>
<plugin>
<artifactId>maven-myquery-plugin</artifactId>
<version>1.0</version>
<executions>
<execution>
<id>execution1</id>
<phase>test</phase>
<configuration>
<url>http://www.foo.com/query</url>
<timeout>10</timeout>
<options>
<option>one</option>
<option>two</option>
<option>three</option>
</options>
</configuration>
<goals>
<goal>query</goal>
</goals>
</execution>
<execution>
<id>execution2</id>
<configuration>
<url>http://www.bar.com/query</url>
<timeout>15</timeout>
<options>
<option>four</option>
<option>five</option>
<option>six</option>
</options>
</configuration>
<goals>
<goal>query</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
...
</project>
从例子可以看出，id为execution1的这个execution绑定到了test阶段，而第二个execution没有指定phase，那么它将在哪个阶段被执行呢？在我的另一篇博客（Maven - 坐标、依赖、生命周期）中的生命周期部分讲到了目标与阶段默认绑定的问题，既然这里定义了目标为query，那么就得看这个Mojo是否定义了默认绑定的阶段了，若没有定义，则配置的execution将不会被执行，当然，若有默认绑定的阶段，那么execution将在默认绑定的阶段被执行。注意，在同一个插件配置中，execution的id应该唯一，而在继承关系的父子POM文件中，不必保证这一点，只是在children中与parent中id相同的execution将会被合并，这同样适用于profiles标签。如果一个插件定义了多个execution且分别绑定到了不同的阶段，那么这些execution只要在保证配置正确的情况下，他们都会在对应的阶段被执行。
默认绑定阶段的Mojo例子：
/**
* @goal query
* @phase package
*/
public class MyBindedQueryMojo
extends AbstractMojo
{
/**
* @parameter expression="${query.url}"
*/
private String url;
/**
* @parameter default-value="60"
*/
private int timeout;
/**
* @parameter
*/
private String[] options;
public void execute()
throws MojoExecutionException
{
...
}
}
仔细观察就会发现我们在类注释中添加了@phase package，这就是绑定默认阶段的方式，现在就可以定义execution而不指定执行阶段了，默认将在package阶段执行：
<project>
...
<build>
<plugins>
<plugin>
<artifactId>maven-myquery-plugin</artifactId>
<version>1.0</version>
<executions>
<execution>
<id>execution1</id>
<phase>install</phase>
<configuration>
<url>http://www.bar.com/query</url>
<timeout>15</timeout>
<options>
<option>four</option>
<option>five</option>
<option>six</option>
</options>
</configuration>
<goals>
<goal>query</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
...
</project>
关于命令行执行execution，首先你的maven版本应该不小于3.3.1，针对上面的execution1，命令如下:
mvn myqyeryplugin:queryMojo@execution1
使用dependencies标签
一般使用此标签来覆盖插件的依赖构件的版本，版本1.2的maven-antrun-plugin插件依赖ant的版本为1.6.5，如果你想用1.7.1的版本，可以如下配置:
<project>
...
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
<version>1.2</version>
...
<dependencies>
<dependency>
<groupId>org.apache.ant</groupId>
<artifactId>ant</artifactId>
<version>1.7.1</version>
</dependency>
<dependency>
<groupId>org.apache.ant</groupId>
<artifactId>ant-launcher</artifactId>
<version>1.7.1</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
...
</project>
使用inherited标签
默认情况下，build中的插件配置将会传递到它的children，可以使用inherited来打破这种默认行为。
<project>
...
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
<version>1.2</version>
<inherited>false</inherited>
...
</plugin>
</plugins>
</build>
...
</project>
reporting配置
关于配置有关reporting的插件到reporting标签或者build标签的区别：
mvn site
仅会使用定义在reporting标签中的插件的configuration元素下配置的参数，而忽略build中configuration元素下配置的参数。
mvn aplugin:areportgoal
首先会检查reporting中定义的参数配置（configuration），如果没有定义，再检查build中定义的参数。
使用reportSets标签
这将在执行mvn site时，生成的报告变得可选，如果你想指定生成某些报告，就可以使用此标签。下面这个例子将只生成team report：
<project>
...
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>2.1.2</version>
<reportSets>
<reportSet>
<reports>
<report>project-team</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>
...
</project>
若不生成任何报告，如下配置：
<reportSets>
<reportSet>
<reports/>
</reportSet>
</reportSets>
使用inherited标签
与build相同。
扫一扫
764
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
