现在的位置: 首页 > 综合 > 正文

Maven插件开发

2013年02月12日 ⁄ 综合 ⁄ 共 3184字 ⁄ 字号 评论关闭
Maven 插件开发—-让maven使用更加灵活
对于习惯于使用maven构建、管理项目的人来说,maven就是项目开发、测试、部署的一把利器:对类库的集中管理;依赖传递、继承、重用性高;对整个项目开发生命周期的完整支持,从头到尾只需要几个简单的命令就可以快速地遍历整个开发周期,减轻了配置管理的工作量。这些优秀的功能都是通过maven插件库里提供的丰富插件来完成的。因此,掌握maven插件开发、在实际工作中根据自己的需要开发适合自己需求maven插件,是很有必要的。
这篇文章先从动手实践开始,迅速开发出自己的一个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文件中予以配置。

<h3 myriad="" pro',="" helveticaneue-light,="" helvetica="" neue="" light',="" lucida="" grande',="" neue',="" arial,="" sans="" unicode',="" sans-serif;="" font-weight:="" normal;="" line-height:="" 1.3;="" style="padding: 0px; margin: 1em 0px 0.2em; font-family:
宋体, 'Arial Narrow', arial, serif; border: 0px; font-size: 24px; outline: 0px;">三,在其他工程中使用此插件

伴随插件开发完成,在被其他项目使用时有比较多的、灵活的配置,接下来也通过一个示例来使用这个插件。
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,即可看到对应阶段的输出信息。

抱歉!评论已关闭.