Maven自定义插件实现

发表于 | 阅读次数:

没有接触过自定义插件，都会把它想的特别难，我刚接触也是，但“手是英雄”，真正动手做了才知道。

Maven 作为一个优秀的项目管理工具，其插件机制为其功能扩展提供了非常大的便捷性。虽然说大多数情况下，我们可能不太会自己去编写 Maven 插件，但不排除在某些特殊的情况下，我们需要去完成一个自己的插件，来协助我们处理某些比较通用的事情。

什么是 Mojo？


Mojo 就是 Maven plain Old Java Object。每一个 Mojo 就是 Maven 中的一个执行目标（executable goal），而插件则是对单个或多个相关的 Mojo 做统一分发。一个 Mojo 包含一个简单的 Java 类。插件中多个类似 Mojo 的通用之处可以使用抽象父类来封装。

1、新建Maven项目


在IDEA中新建Maven项目，选择maven-archetype-mojo,点击下一步，输入对应的参数最后点击完成即可创建一个简单的 Mojo 工程。
这里写图片描述

创建完成后，工程内会生成对应的 pom.xml 文件。其内容比较简单，与普通 Maven 工程的 pom.xml 基本一致，只是自动添加了对 maven-plugin-api 的依赖，这个依赖里面会包含一些 Mojo 的接口与抽象类，在后续编写具体的 Mojo 时再进行详细讲解。

整体的pom.xml文件如下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>maven-plugin-dbs</groupId>
  <artifactId>maven-plugin-dbs</artifactId>
  <packaging>maven-plugin</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>mavenplugin Maven Mojo</name>
  <url>http://maven.apache.org</url>
  
  <dependencies>
    <dependency>
      <groupId>org.apache.maven</groupId>
      <artifactId>maven-plugin-api</artifactId>
      <version>2.0</version>
    </dependency>
    <dependency>
      <groupId>org.apache.maven.plugin-tools</groupId>
      <artifactId>maven-plugin-annotations</artifactId>
      <version>3.3</version>
    </dependency>
  </dependencies>

</project>


其中打包方式一定要是<packaging>maven-plugin</packaging>

1
2
3
<groupId>maven-plugin-dbs</groupId> //一级目录
<artifactId>maven-plugin-dbs</artifactId>  //二级目录
<version>1.0-SNAPSHOT</version>  //三级目录


这里先记住一二三级目录，后面会用到。

2、Mojo类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

@Mojo(name="myplugin")
public class Mojo  extends AbstractMojo {

    @Parameter
    private String msg;

    public void execute() throws MojoExecutionException,MojoFailureException{
        System.out.println("执行成功:"+msg);
    }
}

观察一下这个类，我们发现它继承了 AbstractMojo 这个抽象类，并实现了 execute() 方法，该方法就是用来定义这个 Mojo 具体操作内容，我们只需要根据自己的需要来编写自己的实现即可。

Mojo 操作的实现我们了解了，那怎么让 Maven 知道这是一个 Mojo 而不是一个普通的 Java 类呢？这里，就需要说一下 Mojo 的查找机制了，在处理源码的时候，plugin-tools 会把使用了 @Mojo 注解或 Javadoc 里包含 @goal 注释的类来当作一个 Mojo 类。

使用 @Mojo 注解，我们需要引入一个新包：

1
2
3
4
5
<dependency>
  <groupId>org.apache.maven.plugin-tools</groupId>
  <artifactId>maven-plugin-annotations</artifactId>
  <version>3.1</version>
</dependency>

上面的代码定义了一个名字为“myplugin”的mojo，它就是插件的一个goal，并且通过注解@Parameter定义了可接受的参数。

3、打包插件

执行mvn clean install 将插件安装到本地库，之后就可以使用了。
可以在本地仓库中找到
这里写图片描述

图中的1,2,3分别对应上面提到的一二三级目录，maven-plugin-dbs-1.0-SNAPSHOT.jar就是我们真正需要的jar包。

4、如何在其他项目中使用自定义插件

新建另一个maven项目，引入前面的插件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<build>
        <plugins>
            <plugin>
                <groupId>maven-plugin-dbs</groupId>
                <artifactId>maven-plugin-dbs</artifactId>
                <version>1.0-SNAPSHOT</version>
                <configuration>
                    <msg>this is my plugin</msg>
                </configuration>
                <executions>
                    <execution>
                        <id>first</id>
                        <phase>compile</phase>
                        <goals>
                            <goal>myplugin</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

可以在依赖包中看到
这里写图片描述

其中内的节点名需要和代码中@Parameter参数注解的属性名一致；其中的compile表示此插件在compile阶段引入，的取值必须是maven构建生命周期其中的值，maven是一个以构建周期为轴线的工程，插件可以附加到其构建周期中的某些阶段上,中的值就是@Mojo中的值。

执行：mvn compile

当看到BUILD SUCCESS就表示插件执行成功，会输出this is my plugin。