Maven 插件开发入门

Stella981
• 阅读 778

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

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=”” lifecycle=””;

b), @execute phase=”

c), @execute goal=”

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

goal:注解形式:@goal

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

phase:注解形式:@phase

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

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

configuration:注解形式:

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

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

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

com.test.maven

maven-hello-plugin

1.0-SNAPSHOT

compile phase

compile

hello

hello everyone

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
Wesley13 Wesley13
3年前
java将前端的json数组字符串转换为列表
记录下在前端通过ajax提交了一个json数组的字符串,在后端如何转换为列表。前端数据转化与请求varcontracts{id:'1',name:'yanggb合同1'},{id:'2',name:'yanggb合同2'},{id:'3',name:'yang
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
4个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Wesley13 Wesley13
3年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
Stella981 Stella981
3年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Stella981 Stella981
3年前
Eclipse插件开发_学习_00_资源帖
一、官方资料 1.eclipseapi(https://www.oschina.net/action/GoToLink?urlhttp%3A%2F%2Fhelp.eclipse.org%2Fmars%2Findex.jsp%3Ftopic%3D%252Forg.eclipse.platform.doc.isv%252Fguide%2
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
10个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这