使用maven自定义插件开发

Maven 作为一个优秀的项目管理工具，其插件机制为其功能扩展提供了非常大的便捷性。

虽然说大多数情况下，我们可能不太会自己去编写 Maven 插件，但不排除在某些特殊的情况下，我们需要去完成一个自己的插件，来协助我们处理某些比较通用的事情。

正好，最近有一些需求可能需要对 Drools 的一个 Maven 插件进行扩展，所以学习一下 Maven 的插件编写。

Maven 插件的命名规范

一般来说，我们会将自己的插件命名为 -maven-plugin，而不推荐使用 maven--plugin，因为后者是 Maven 团队维护官方插件的保留命名方式，使用这个命名方式会侵犯 Apache Maven 商标。

什么是 Mojo？

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

创建 Mojo 工程

这里，我们使用 Idea 作为开发工具进行讲解，创建工程选择 Maven，然后在模板中找到 maven-archetype-mojo，点击下一步，输入对应的参数，如：com.qchery/ekjar-maven-plugin/1.0-SNAPSHOT，最后点击完成即可创建一个简单的 Mojo 工程。

Maven 插件的命名规范

一般来说，我们会将自己的插件命名为 -maven-plugin，而不推荐使用 maven--plugin，因为后者是 Maven 团队维护官方插件的保留命名方式，使用这个命名方式会侵犯 Apache Maven 商标。

什么是 Mojo？

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

创建 Mojo 工程

这里，我们使用 Idea 作为开发工具进行讲解，创建工程选择 Maven，然后在模板中找到 maven-archetype-mojo，点击下一步，输入对应的参数，如：com.qchery/ekjar-maven-plugin/1.0-SNAPSHOT，最后点击完成即可创建一个简单的 Mojo 工程。

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

<dependency>
  <groupId>org.apache.maven</groupId>
  <artifactId>maven-plugin-api</artifactId>
  <version>2.0</version>
</dependency>

与普通 pom.xml 文件一个重要的不同之处是它的打包方式：

<packaging>maven-plugin</packaging>

简单 Mojo 的创建

工程创建完毕后，我们开始 Mojo 创建之旅，上面提到过 Mojo 是一个简单的 Java 类，那我们创建第一个 Mojo 类用于打印一行输出。

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
/**
 * @goal hello
 */
public class HelloMojo extends AbstractMojo {
    public void execute() throws MojoExecutionException, MojoFailureException {
        System.out.println("hello world");
    }
}

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

Mojo 操作的实现我们了解了，那怎么让 Maven 知道这是一个 Mojo 而不是一个普通的 Java 类呢？这里，就需要说一下 Mojo 的查找机制了，在处理源码的时候，plugin-tools 会把使用了 @Mojo 注解或 Javadoc 里包含 @goal 注释的类来当作一个 Mojo 类。在上面的例子中，我们使用了 Javadoc 的方法来声明一个 Mojo。同样我们也可以使用 @Mojo 注解来进行声明：

@Mojo(name = "hello")
public class HelloMojo extends AbstractMojo {
    public void execute() throws MojoExecutionException, MojoFailureException {
        System.out.println("hello world");
    }
}

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

<dependency>
  <groupId>org.apache.maven.plugin-tools</groupId>
  <artifactId>maven-plugin-annotations</artifactId>
  <version>3.1</version>
</dependency>

运行自定义 Plugin

与使用其它插件类似，我们需要在 pom.xml 文件中引入插件：

<build>
    <plugins>
        <plugin>
            <groupId>com.qchery</groupId>
            <artifactId>ekjar-maven-plugin</artifactId>
            <version>1.0-SNAPSHOT</version>
        </plugin>
    </plugins>
</build>

先执行命令：

mvn install

然后执行:

mvn com.qchery:ekjar-maven-plugin:1.0-SNAPSHOT:hello

即可看到输出：

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building ekjar-maven-plugin Maven Mojo 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- ekjar-maven-plugin:1.0-SNAPSHOT:hello (default-cli) @ ekjar-maven-plugin ---
hello world
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.249 s
[INFO] Finished at: 2017-03-26T12:59:47+08:00
[INFO] Final Memory: 6M/123M
[INFO] ------------------------------------------------------------------------

缩短执行命令

在刚才运行插件的时候，我们使用全量的插件指引，但这个实在是太长太繁琐了，那我们是否可以缩短我们的执行命令呢？

答案肯定是可以的，如果你想要执行的是你本地库中最新版本的插件，那么你可以删除掉版本号；如果你的命名满足前面提及的两种命令方式，你可以直接使用插件名及 goal 名来运行对应的插件，如：

mvn ekjar:hello

你会得到与之前完全一样的结果。

绑定 Maven 执行周期

你还可以将插件配置为将特定目标，从而附加到构建生命周期中的某个特定阶段。如：

<build>
    <plugins>
        <plugin>
            <groupId>com.qchery</groupId>
            <artifactId>ekjar-maven-plugin</artifactId>
            <version>1.0-SNAPSHOT</version>
            <executions>
                <execution>
                    <goals>
                        <goal>hello</goal>
                    </goals>
                    <phase>package</phase>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

继承AbstractMojo 的类中，参数可以通过命令赋值，例如：

/**
 *
 * @goal echo
 * @phase process-sources
 */
public class MyMojo extends AbstractMojo {
    /**
     * @parameter expression="${echo.message}" default-value="Hello World..."
     */
    private String message;
    public void execute() throws MojoExecutionException, MojoFailureException {
        System.out.println("hello world");
        getLog().info("hello mymojo : "+message);
    }
}

其中注释就是maven插件很重要的元数据

/**
 * @goal CustomMavenMojo：表示该插件的服务目标
 * @phase compile：表示该插件的生效周期阶段
 * @requiresProject false：表示是否依托于一个项目才能运行该插件
 * @parameter expression="${name}"：表示插件参数，使用插件的时候会用得到
 * @required:代表该参数不能省略
 */

执行：

mvn com.handarui.yanquan:yanquan:1.0-SNAPSHOT:echo -Decho.message="The Eagle has Landed"

（MyMojo类中的message 参数的javadoc注释是 echo.message, 通过命令赋值时，需要传入-Decho.message=XXX 这种形式 ）

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

最新评论