一，快速开发你的第一个插件

1，创建一个maven-plugin目录，并通过CMD程序从后台进入此目录。

2，运行命令：

mvn archetype:create -DgroupId=com.test.maven -DartifactId=maven-hello-plugin -DarchetypeArtifactId=maven-archetype-mojo

note:最新版maven请使用 mvn archetype:generate,然后逐步选择，其中一步要注意选择maven-archetype-mojo对应的序号groupId:artifactId:version:goal

创建类：

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;

/**
 * Goal which touches a timestamp file.
 *
 * @goal hello
 * 
 * @phase process-sources
 */
public class GreetingMojo
    extends AbstractMojo
{
 /**
  * @parameter expression="${hello.words}" default-value="This is some world."
  */
    private String words;
    
    public void execute() throws MojoExecutionException {
     getLog().info(words);
    }
}

运行mvn clean install，即安装了此插件

调用使用groupId:artifactId:version:goal，例如调用hello目标，则使用

com.test.maven:maven-hello-plugin:1.0-SNAPSHOT:hello

当然，后面可以带参数com.test.maven:maven-hello-plugin:1.0-SNAPSHOT:hello -Dhello.words="Hello,world"

可以看到输出中会有相应信息。

二，插件开发过程的相关说明

1，MOJO

Maven 通过插件动作完成大多数构建任务。可以把 Maven 引擎认为是插件动作的协调器。插件中的每个任务goal称作一个 Mojo（Maven plain Old Java Object）。项目中每一个Mojo都要实现org.apache.maven.plugin.Mojo接口，上面的插件示例的Mojo通过扩展org.apache.maven.plugin.AbstractMojo类实现了该接口。Mojo提供过了如下的方法：

void setLog( org.apache.maven.monitor.logging.Log log )

每一个Mojo实现都必须提供一种方法让插件能够和某个特定目标的过程相交流。该目标成功了么？或者，是否在运行目标的时候遇到了问题？当Maven加载并运行Mojo的时候，它会调用setLog()方法，为Mojo实例提供正确的日志目标，以让你在自定义插件中使用。

protected Log getLog()

Maven会在Mojo运行之前调用setLog()方法，然后你的Mojo就可以通过调用getLog()获得日志对象。Mojo应该去调用这个Log对象的方法，而不是直接将输出打印到标准输出或者控制台。

void execute() throws org.apache.maven.plugin.MojoExecutionException

轮到运行目标的时候，Maven就会调用该方法。

Mojo接口只关心两件事情：目标运行结果的日志记录，以及运行一个目标。当编写自定义插件的时候，需要扩展AbstractMojo。AbstractMojo处理setLog()和getLog()的实现，并包含一个抽象的execute()方法。在扩展AbstractMojo的时候，你所需要做的只是实现execute()方法。

2，Phase

Maven 对构建生命周期的固定理解包含了许多不同的阶段，如下表：

 

validate验证确保当前配置和POM的内容是有效的。这包含对pom文件树的验证。initialize初始化在执行构建生命周期的主任务之前可以进行初始化。generate-sources生成源码代码生成器可以开始生成在以后阶段中处理或编译的源代码。process-sources处理源码提供解析、修改和转换源码。常规源码和生成的源码都可以在这里处理。generate-resources生成资源可以生成非源码资源。通常包括元数据文件和配置文件。process-resources处理资源处理非源码资源。修改、转换和重定位资源都能在这阶段发生。compile编译编译源码。编译过的类被放到目标目录树中。process-classes处理类处理类文件转换和增强步骤。字节码交织器和常用工具常在这一阶段操作。generate-test-sources生成测试源码mojo可以生成要操作的单元测试代码。process-test-sources处理测试源码在编译前对测试源码执行任何必要的处理。在这一阶段，可以修改、转换或复制源代码。generate-test-resources生成测试资源允许生成与测试相关的（非源码）资源。process-test-resources处理测试资源可以处理、转换和重新定位与测试相关的资源。test-compile测试编译编译单元测试的源码。test测试运行编译过的单元测试并累计结果。package打包将可执行的二进制文件打包到一个分布式归档文件中，如pre-integration-test前集成测试、准备集成测试。这种情况下的集成测试是指在一个受到一定控制的模拟的真实部署环境中测试代码。这一步能将归档文件部署到一个服务器上执行。integration-test集成测试执行真正的集成测试。post-integration-test后集成测试、解除集成测试准备。这一步涉及测试环境重置或重新初始化。verify检验检验可部署归档的有效性和完整性。过了这个阶段，将安装该归档。install安装将该归档添加到本地Maven目录。这一步让其他可能依赖该归档的模块可以使用它。deploy部署将该归档添加到远程Maven目录。这一步让这个工件能为更多的人所用。

 

3，插件组成

每一个mojo都由一些注解annotation来描述，这些注解是在java类的上面标注。常用的几个注解如下：

execute：注解形式：

a), @execute phase=”<phaseName>” lifecycle=”<lifecycleId>”;

b), @execute phase=”<phaseName>”

c), @execute goal=”<goalName>”

当这个目标goal被调用时，它会先调用一个平行的生命周期，在制定的阶段结束。如果插件没有被指定阶段，这一目标将会单独执行。

goal：注解形式：@goal <goalName>

用户在命令行下直接调用插件的目标goal，或者在项目的pom文件中通过配置调用这个goal。

phase：注解形式：@phase <phaseName>

绑定这个mojo到标准构建生命周期里对应的阶段。

 

对于一个mojo里的变量参数，也有一些常用的注解：

configuration：注解形式：

@parameter expression=”${aSystemProperty}” default-value=”${anExpression}”

对参数指定一个计算表达式、在mojo构建时将计算结果注入到此变量中，同时也可以给定一个默认值。这个参数值也可以在pom文件中予以配置。

三，在其他工程中使用此插件

<plugin>
  <groupId>com.test.maven</groupId>
  <artifactId>maven-hello-plugin</artifactId>
  <version>1.0-SNAPSHOT</version>
  <executions>
    <execution>
     <id>compile phase</id>
     <phase>compile</phase>
     <goals>
      <goal>hello</goal>
     </goals>
     <configuration>
      <words>hello everyone</words>
      </configuration>
    </execution>
   </executions>
</plugin>