maven mojo

Maven 插件开发—让maven使用更加灵活
对于习惯于使用maven构建、管理项目的人来说，maven就是项目开发、测试、部署的一把利器：对类库的集中管理；依赖传递、继承、重用性高；对整个项目开发生命周期的完整支持，从头到尾只需要几个简单的命令就可以快速地遍历整个开发周期，减轻了配置管理的工作量。这些优秀的功能都是通过maven插件库里提供的丰富插件来完成的。因此掌握maven插件开发、在实际工作中根据自己的需要开发适合自己需求maven插件，是很有必要的。

一、快速开发你的第一个插件
1、创建一个maven-plugin目录，并通过CMD程序从后台进入此目录。

2、运行命令：
mvn archetype:create -DgroupId=com.taobao.maven -DartifactId=maven-hello-plugin -DarchetypeArtifactId=maven-archetype-mojo
note:最新版maven请使用 mvn archetype:generate,然后逐步选择，其中一步要注意选择maven-archetype-mojo对应的序号groupId:artifactId:version:goal

3，进入maven-hello-plugin目录，运行命令：mvn eclipse:eclipse 构建eclipse工程。

4，通过eclipse import工程，删除包下面自动生成的java文件，新建GreetingMojo.java和GoodByeMojo.java，分别对应打招呼、再见两个动作。

 

GreetingMojo.java的内容如下：

package com.taobao.maven;

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

/**
     * Goal which output all config files
     * 
     * @goal greeting
     * @phase process-sources
 */
public class GreetingMojo extends AbstractMojo {

    private String words;

    public void execute() throws MojoExecutionException {
        getLog().info(words);
    }
}

GoodByeMojo.java的内容如下：

package com.taobao.maven;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
/**
     * Goal which output all config files
     * 
     * @goal goodBye
     * @phase process-sources
*/
public class GoodByeMojo extends AbstractMojo {
    private String words;
    public void execute() throws MojoExecutionException, MojoFailureException {
        getLog().info(words);
    }
}

5、文件编写完成后回到cmd命令行，在项目的pom文件目录处运行install命令将插件安装到本地repository：mvn clean install

6、安装成功后继续运行如下命令查看插件的运行情况：
运行：
mvn com.taobao.maven:maven-hello-plugin:1.0-SNAPSHOT:greeting (类的注解 @goal 对应)
note：groupId:artifactId:version:goal

 

可以看到控制台看到输出：“Hello to you!”；这个输出是插件的默认参数：
default-value=”Hello to you!”

运行：
mvn com.taobao.maven:maven-hello-plugin:1.0-SNAPSHOT:goodBye
可以在控制台看到输出：“goodBye to you!”；这个输出是插件的默认参数：
default-value=”goodBye to you!”

运行：
mvn com.taobao.maven:maven-hello-plugin:1.0-SNAPSHOT:greeting -Dgreeting.words=”welcome!”
可以在控制台看到输出：“welcome!”；这个在命令中明确指定插件的参数，因此输出的是指定的参数“welcome!”。

运行：
mvn com.taobao.maven:maven-hello-plugin:1.0-SNAPSHOT:goodBye -DgoodBye.words=”see you!”
可以在控制台看到输出：“see you!”；这个在命令中明确指定插件的参数，因此输出的是指定的参数“see you!”。

7、至此一个简单maven插件基本完成。

二、插件开发过程的相关说明
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 对构建生命周期的固定理解包含了许多不同的阶段，如下表：
 

mvn clean install

生命周期阶段 描述

validate	验证项目是否正确，以及所有为了完整构建必要的信息是否可用
generate-sources	生成所有需要包含在编译过程中的源代码
process-sources	处理源代码，比如过滤一些值
generate-resources	生成所有需要包含在打包过程中的资源文件
process-resources	复制并处理资源文件至目标目录，准备打包
compile	编译项目的源代码
process-classes	后处理编译生成的文件，例如对Java类进行字节码增强（bytecode enhancement）
generate-test-sources	生成所有包含在测试编译过程中的测试源码
process-test-sources	处理测试源码，比如过滤一些值
generate-test-resources	生成测试需要的资源文件
process-test-resources	复制并处理测试资源文件至测试目标目录
test-compile	编译测试源码至测试目标目录
test	使用合适的单元测试框架运行测试。这些测试应该不需要代码被打包或发布
prepare-package	在真正的打包之前，执行一些准备打包必要的操作。这通常会产生一个包的展开的处理过的版本（将会在Maven 2.1+中实现）
package	将编译好的代码打包成可分发的格式，如JAR，WAR，或者EAR
pre-integration-test	执行一些在集成测试运行之前需要的动作。如建立集成测试需要的环境
integration-test	如果有必要的话，处理包并发布至集成测试可以运行的环境
post-integration-test	执行一些在集成测试运行之后需要的动作。如清理集成测试环境。
verify	执行所有检查，验证包是有效的，符合质量规范
install	安装包至本地仓库，以备本地的其它项目作为依赖使用
deploy	复制最终的包至远程仓库，共享给其它开发人员和项目（通常和一次正式的发布相关）

 
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文件中予以配置。

三、在其他工程中使用此插件
伴随插件开发完成，在被其他项目使用时有比较多的、灵活的配置，接下来也通过一个示例来使用这个插件。
1、回到maven-plugin目录，创建插件测试工程：
mvn archetype:create -DgroupId=com.taobao.maven -DartifactId=plugin-test -Dpackaging=jar

2、在测试工程的pom文件中加入插件依赖：

<build>
    <plugins>
        <plugin>
            <groupId>com.taobao.maven</groupId>
                <artifactId>maven-hello-plugin</artifactId>
                <version>1.0-SNAPSHOT</version>
            </plugin>
        </plugins>
</build>

 

3、在上述配置后可以使用这个插件了，但是这个插件在开发的时候并没有定义插件运行的生命周期，而且，在使用时也希望得到更加灵活的参数配置，因此在使用时大多采用如下的配置：

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

 

这个配置对这个插件定义了运行时的生命周期，在编译compile阶段运行插件的greeting 目标，输出greeting.words是“hello everyone”；在测试test阶段运行插件的goodBye 目标，输出goodBye.words是“goodbye everyone”。配置完成后，回到命令行的plugin-test工程目录下运行：mvn clean package，即可看到对应阶段的输出信息。