编写maven插件（十五）

编写maven插件

首先，介绍下编写maven插件的主要步骤：

1.创建一个maven-plugin项目：插件本身也是maven项目，特殊的地方在于packaging必须是maven-plugin，用户可以使用maven-archetype-plugin快速创建一个maven插件项目。

2.为插件编写目标：每个插件都必须包含一个或者多个目标，maven称之为mojo。编写插件的时候必须提供一个或者多个继承自AbastactMojo的类。

3.为目标提供配置点：大部分maven插件及其目标都是可配置的，因此在编写mojo的时候需要注意提供可配置的参数。

4.编写代码实现目标行为：根据实际的需要实现mojo。

5.错误处理及日志：当mojo发生异常时，根据情况控制maven的运行状态，在代码中编写必要的日志以便为用户提供足够的信息。

6.测试插件：编写自动化的测试代码测试行为，然后在实际运行插件以验证其行为。

下面看一个简单的例子：

pom.xml

<project>
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.shw.archetype</groupId>
  <artifactId>archetype-t</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>maven-plugin</packaging>

  <name>archetype-t</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.apache.maven</groupId>
      <artifactId>maven-plugin-api</artifactId>
      <version>3.2.2</version>
    </dependency>
    <dependency>
      <groupId>org.apache.maven.plugin-tools</groupId>
      <artifactId>maven-plugin-annotations</artifactId>
      <version>3.3</version>
    </dependency>
  </dependencies>
</project>

引入的两个依赖是创建插件需要的依赖，一个是需要继承的类的依赖，另外一个是支持注解的依赖。

package com.shw.archetype;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

@Mojo(name = "count")//目标名称，必须的
public class CountMojo extends AbstractMojo {

    //配置变量，在插件的configuration元素下配置变量名
    @Parameter
    private String name;
    /**
     * 目标执行的方法
     * @throws MojoExecutionException
     * @throws MojoFailureException
     */
    public void execute() throws MojoExecutionException, MojoFailureException {
        System.out.println(name);
    }
}