Maven的plugin与goal管理

2020-11-29 本文已影响0人 qingshuiting

在了解Maven的生命周期（lifecycle）之前，我们需要先了解Maven的Plugin与goal

通过上一篇文档Maven的基本概念，我们了解到：goal是Maven中执行任务的最基本的单元；plugin又是提供goal的主体。因此了解maven中的plugin和goal的基本规则，以及学会如何查找和如何使用合适的plugin、goal至关重要（就像使用vim一样，要学会如何找到合适的第三方插件，以及学会如何使用这个插件一样）。

Plugin的分类

Maven中Plugin分为两种类型：

build类型Plugin只能在build阶段执行，在POM中需要在 <build/> 标签下进行配置。
reporting类型：在site generation阶段被执行。在POM中需要在<reporting/>标签下配置。

一些常见的Maven 官方的插件插件:

https://maven.apache.org/plugins/index.html

https://repo.maven.apache.org/maven2/org/apache/maven/plugins/

一些常见的Maven官方之外的，按照插件开发规则添加的常用插件：

https://www.mojohaus.org/plugins.html

如何识别一个plugin与goal

标识一个plugin的最规范的路径是：groupId:artifactId:version。标识一个goal的最规范的路径为groupId:artifactId:version:goal。

例如执行 mvn org.apache.maven.plugins:maven-help-plugin:3.2.0:system 实际上就是执行了 mvn help:system；这样的使用方式主要是由于直接使用groupid，artifactid，version的方式是比较复杂的，所以在maven中引入的goalPrefix的概念，其实就是给上边冗余的指定plugin的命名方式给了一个简称。

Plugin的简称/goalPrefix的命名规则

maven的plugin分为两种类型，一种是maven官方发布的plugin，另一种是按照maven的plugin开发要求开发的第三方的plugin。plugin的prefix官方规则文档介绍着两种plugin的主要区别。

官方插件：都是使用org.apache.maven.plugins
作为groupid；其插件对应的artifactid都是 maven-prefixname/goalprefix-plugin的规则；maven官方的plugins metadata store给出了基本上可以用的官方plugin的全部内容，以及其对应的goalprefix。
第三方插件：org.codehaus.mojo 就是一个第三方插件的集合groupid，其中有非常多有用的插件；并且个人也可以按照plugin的dev文档来开发自己的第三方的插件，然后进行发布。

如何自主学习某个Plugin的使用方法

在实际的plugin和goal的使用中需要解决两个问题：（1）如何找到能够解决某个问题的plugin；（2）如何学习这个plugin的多个goals的使用方式。

查找合适的plugin的方法：一般可以通过官方提供Available Plugins；或者通过一些比较常用的第三方plugin集合（org.codehaus.mojo ）中寻找合适的插件。
学习某个plugin如何使用：
- 使用plugin自带的helpgoal：例如直接使用 mvn compiler:help可以查看对应的compiler插件有多个少个goals。
  image.png
  并且还可以进一步通过mvn compiler:help -Ddetail=true -Dgoal=<goal-name>来查看详细的每一个goal对应的参数使用方法。
- 使用maven的help插件的describegoal来了解plugin和goals的功能；例如下边的例子

mvn help:describe -Dcmd=compile
mvn help:describe -Dcmd=compiler:compile
mvn help:describe -Dplugin=org.apache.maven.plugins:maven-compiler-plugin
mvn help:describe -DgroupId=org.apache.maven.plugins -DartifactId=maven-compiler-plugin

Plugin在POM中如何配置

当我们学会使用一个maven plugin的时候，在选择执行其对应的某个goal的时候，可以添加上不同的参数来控制goal执行的行为。例如 mvn plugin:help -Ddetail=true可以打印出plugin帮助信息的一些详细参数；或者使用mvn plugin:help -Dgoal=goalname
仅仅打印某个goal的帮助信息。

maven的官方文档给出了如何对Plugin进行配置。plugin分为两种类型（build类型与reporting类型），这两种类型有公共的部分，也有各自特殊的部分。

公共部分的配置：主要在于对应的每一个不同goal的执行所需要的parameters的配置上。在实现一个goal的时候，会定义不同的参数，每一个参数都有其对应的数据类型（比如简单的类型：string，boolean，int，double等；复杂的一些对象数据类型；甚至一些collections或者property类型。）主要的使用方式如下：

 <configuration>
    <url>http://www.baidu.com</url>
 </configuration>

相当于配置了对应的goal中url的属性为http://www.baidu.com

build类型的plugin特殊的配置：这里主要说下executionstags，其他配置参数可以直接参考官方的文档进行学习。execution的主要作用是可以把一个插件的某个goal或者某些goals绑定到一个executionid上，或者绑定到某个phase上。例如下边的这个例子

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <artifactId>maven-myquery-plugin</artifactId>
        <version>1.0</version>
        <executions>
          // 第一个execution配置
          <execution>
            <id>execution1</id>
            <phase>test</phase>
            <configuration>
              <url>http://www.bar.com/query</url>
              <timeout>15</timeout>
            </configuration>
            <goals>
              <goal>query</goal>
            </goals>
          </execution>
          // 第二个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>

将同一个插件分别设置了多个exection，execution1是将其绑定到了test阶段（phase）上；exection2并没有绑定到任何阶段。那么如下的两个命令都分别可以执行对应的goal（query）：

mvn test
mvn plugin:goal@execution2

reporting部分使用的不是太多，具体使用的时候，可以直接查阅上面给到的plugin配置链接进行查阅。