讲师中心 微信公众号
AI工具推荐 视频效率加速

如何从零开始开发自定义Maven插件

轻磊吖_8143

轻磊吖_8143

发布时间:2026-08-05 14:24:33

|

905人浏览过

|

来源于php中文网

原创

必须使用maven-archetype-plugin模板创建自定义Maven插件项目,添加maven-plugin-annotations和maven-plugin-api依赖,编写带@Mojo注解的Mojo类,配置maven-plugin-plugin指定goalPrefix,最后执行mvn clean install安装到本地仓库。

如何从零开始开发自定义maven插件 - php中文网

你想让 Maven 在构建时自动执行一段专属逻辑,比如生成版本文件、校验代码规范、或清理特定临时目录,但现有插件无法满足——这时必须从零开发一个自定义 Maven 插件。

创建插件项目骨架

在 IDEA 中新建 Maven 项目 → 选择 maven-archetype-plugin 模板(不是普通 archetype)→ 填写 groupId、artifactId、version。这一步直接生成符合插件规范的目录结构和基础 pom.xml,省去手动配置 packaging 的风险。

【必须选 maven-archetype-plugin,选错模板会导致后续 compile 失败】

生成后检查 pom.xml 是否含 <packaging>maven-plugin</packaging>,若没有请立即补上并刷新 Maven 项目。

引入核心依赖

打开 pom.xml,在 <dependencies> 中添加两项:

方法一:基础注解支持
<dependency><groupId>org.apache.maven.plugin-tools</groupId><artifactId>maven-plugin-annotations</artifactId><version>3.6.4</version><scope>provided</scope></dependency>

方法二:运行时 API 支持
<dependency><groupId>org.apache.maven</groupId><artifactId>maven-plugin-api</artifactId><version>3.8.6</version></dependency>

注意:maven-plugin-annotations 的 scope 必须为 provided,否则打包后会污染使用者项目类路径。

编写 Mojo 类

第一步:在 src/main/java 下新建包路径,例如 io.example.myplugin;

Maven 3.9.12
Maven 3.9.12

Maven下载页提供 Apache Maven 3.9.12 官方跨平台二进制包,并整理安装配置、环境变量和入门使用说明。

下载

第二步:新建 Java 类 VersionGeneratorMojo,继承 AbstractMojo;

第三步:添加 @Mojo(name = "generate-version") 注解,name 值将作为命令行调用的目标名;

第四步:声明参数字段并用 @Parameter 标记,例如:
@Parameter(defaultValue = "${project.build.directory}", readonly = true)<br>private File outputDir;
这个表达式会自动注入当前项目的 target 目录路径,无需硬编码。

第五步:重写 execute() 方法,在其中实现业务逻辑——比如创建 Version.txt 并写入当前时间戳。务必用 getLog().info("...") 输出日志,这是唯一标准输出方式。

配置插件元信息

在 pom.xml 的 <build><plugins> 中加入 maven-plugin-plugin:

<plugin><br>  <groupId>org.apache.maven.plugins</groupId><br>  <artifactId>maven-plugin-plugin</artifactId><br>  <version>3.6.4</version><br>  <configuration><br>    <goalPrefix>example</goalPrefix><br>  </configuration><br></plugin>

其中 goalPrefix 决定了插件简写前缀:安装后可用 mvn example:generate-version 调用,而不是冗长的全坐标。

构建并安装到本地仓库

执行 mvn clean install;

成功后,插件 JAR 会出现在 ~/.m2/repository/io/example/mykit-maven-plugin/1.0.0-SNAPSHOT/ 目录下;

此时插件已可被其他项目引用——无需上传私服,本地验证阶段直接生效。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

相关专题

更多
Java Maven专题
Java Maven专题

本专题聚焦 Java 主流构建工具 Maven 的学习与应用,系统讲解项目结构、依赖管理、插件使用、生命周期与多模块项目配置。通过企业管理系统、Web 应用与微服务项目实战,帮助学员全面掌握 Maven 在 Java 项目构建与团队协作中的核心技能。

2940

2025.09.15

Java Maven/Gradle 构建与依赖管理合集
Java Maven/Gradle 构建与依赖管理合集

系统讲解 Java 项目构建工具的使用与进阶配置,涵盖 Maven 的 POM 文件结构、生命周期(clean/compile/package/install/deploy)与插件机制、依赖范围(compile/provided/test/runtime)与传递依赖管理、多模块聚合与继承、私有 Nexus 仓库发布,以及 Gradle 的 Groovy / Kotlin DSL 语法、Task 自定义与增量构建、依赖版本目录(Versi

309

2026.05.09

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

80

2026.09.23

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

20

2026.09.23

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

20

2026.09.23

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

20

2026.09.22

Conan二进制包配置指南
Conan二进制包配置指南

本专题介绍Conan根据操作系统、编译器、架构和构建类型生成二进制包的方法,讲解Profile、Settings、Options及Package ID的作用,帮助管理不同平台和编译环境下的包版本。

40

2026.09.22

Conan私有仓库搭建教程
Conan私有仓库搭建教程

本专题系统的讲解Conan私有仓库的搭建流程,涵盖仓库服务部署、存储目录配置、用户认证、权限划分和远程地址添加,并介绍内部C++依赖包的上传、下载及版本维护方法。

20

2026.09.22

loomy官网入口地址合集
loomy官网入口地址合集

本专题汇总了 Loomy 桌面 AI 助理的官方入口地址合集及使用指南。提供 macOS 与 Windows 客户端下载 。Loomy 是讯飞推出的桌面级 AI 工作搭子,支持文件整理、数据分析、网页操作及通过飞书/钉钉远程操控电脑,助你高效完成本地办公任务 。

20

2026.09.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Apache Maven 官方用户中心
Apache Maven 官方用户中心

共0课时 | 0人学习

Apache Maven 官方安装指南
Apache Maven 官方安装指南

共0课时 | 0人学习

Apache Maven 官方用户中心
Apache Maven 官方用户中心

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn