自定义Maven插件并使用

本文介绍了如何创建自定义Maven插件,包括创建插件工程、添加依赖、实现Mojo类(如MyPlugin)并安装到本地仓库,以及在其他项目中引用和执行插件。通过实例演示了在springboot工程中使用自定义插件帮助构建的过程。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1.预备知识

        自定义Maven插件需要你创建一个工程(这个工程就是你自己的插件),然后安装到本地仓库中,在其他需要这个插件的工程中引入这个插件的依赖,使用时通过命令行执行。

这里我们先说明一下插件调用的maven命令:mvn {插件前缀}:{调用方法目标}。

这里maven会通过你引入的依赖的artifactId来自动识别插件前缀,一般有如下两种前缀识别方式:

前置匹配:${prefix}-maven-plugin

中间匹配:maven-${prefix}-plugin

这里我一般选择前缀匹配,所以我的工程名就叫做hccPlugin-maven-plugin。

2.创建插件工程并安装到本地仓库

如图,名为hccPlugin-maven-plugin的maven工程创建后,我们需要添加下方红框内的<packaging>maven-plugin</packaging>标签与maven插件工程所需的依赖maven-plugin-api。

接着我们要新建Mojo类,它是Maven插件的核心类,Mojo全称是:Maven Old Java Object,可以创建多个,名字自己定义,Mojo类需要实现org.apache.maven.plugin.Mojo接口,或继承AbstractMojo抽象类,我们这里选择继承AbstractMojo抽象类,实现execute()方法。

这里我创建了一个Mojo类,名叫MyPlugin,继承AbstractMojo抽象类,实现execute()方法,实现在使用该插件时,控制台会打印“----->I am helping you build the project.”的日志。上方用文档注释中的注解,说明该Mojo对应的调用方法目标为helpBuild。

我们执行install这里安装成功了,那么这个插件就安装到你的本地仓库中了。

要在其他工程中使用这个插件还需要在Maven的settings.xml中配置<pluginGroup>为你插件的<groupId>。

3.新建工程并引用该插件执行相关功能

我们新建一个空的springboot工程。

然后执行mvn hccPlugin:helpBuild,在日志中就能看到调用了我们自定义插件的目标方法。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值