Maven插件开发

Maven插件开发

From: http://qa.taobao.com/?p=4964

Maven 插件开发—-让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

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 greeting

*/

public class GreetingMojo extends AbstractMojo {

/**

* @parameter expression=”${greeting.words}” default-value=”Hello to you!”

*/

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 goodBye

*/

public class GoodByeMojo extends AbstractMojo {

/**

* @parameter expression=”${goodBye.words}” default-value=”goodBye to you!”

*/

private String words;

public void execute() throws MojoExecutionException, MojoFailureException {

getLog().info(words);

}

}

 
pom.xml中的依赖为：

< dependency >
       < groupId >org.apache.maven </ groupId >
       < artifactId >maven-plugin-api </ artifactId >
       < version >2.0 </ version >
     </ dependency >
     < dependency >
       < groupId >com.alibaba.external </ groupId >
       < artifactId >test.junit </ artifactId >
       < version >4.4 </ version >
       < scope >test </ scope >
     </ dependency >

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

6，    安装成功后继续运行以下命令查看插件的运行状况：

运行：

mvn com.taobao.maven:maven-hello-plugin:1.0-SNAPSHOT:greeting

，能够看到控制台看到输出：“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 对构建生命周期的固定理解包含了许多不一样的阶段，以下表：

...省略

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，便可看到对应阶段的输出信息。