Java 中怎么在 Maven 中编写自定义生命周期插件扩展构建能力

老丽大大_4120

老丽大大_4120

2026-08-14

214人浏览

原创

maven自定义插件本质是创建绑定到标准生命周期阶段(如package)的mojo,通过@mojo注解或pom.xml中executions配置实现绑定;需设packaging为maven-plugin,引入maven-plugin-api和maven-plugin-annotations依赖,并支持参数注入与mavenproject上下文访问。

java 中怎么在 maven 中编写自定义生命周期插件扩展构建能力

在 Maven 中编写自定义生命周期插件,本质是创建一个可绑定到标准生命周期阶段(如 package、compile)的 Mojo,并通过注解或配置明确其执行时机和行为。它不是新增生命周期,而是扩展已有生命周期的能力——让构建过程自动执行你定义的逻辑。

明确 Mojo 与生命周期阶段的绑定方式

Maven 默认生命周期(default、clean、site)本身不可修改,但每个阶段可以绑定任意数量的插件目标(goal)。自定义插件的核心就是把你的 Mojo 绑定到某个 phase:

  • 用 @Mojo(defaultPhase = LifecyclePhase.PACKAGE) 直接声明默认绑定阶段
  • 不加 defaultPhase 时,需在使用方项目的 pom.xml 中显式配置绑定:
    <plugin><groupid>com.example</groupid><artifactid>my-maven-plugin</artifactid><version>1.0.0</version><executions><execution><phase>package</phase><goals><goal>assemble-configs</goal></goals></execution></executions></plugin>
  • 一个 Mojo 可被多次绑定到不同 phase,也可不绑定、仅作手动调用(如 mvn my:deploy)

项目结构与关键配置必须到位

自定义插件不是普通 Java 项目,Maven 会按特殊规则识别和加载它:

deep-java-review
deep-java-review

Java项目代码review工具。分析Git变更+完整调用链路上下文,推断业务需求,进行多维度评分和分类汇总,生成完整PRD文档。包含细粒度Java代码审查清单(Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载
  • pom.xml 中 <packaging></packaging> 必须设为 maven-plugin
  • 必须引入两个核心依赖:
    • org.apache.maven:maven-plugin-api(提供 Mojo 接口和上下文)
    • org.apache.maven.plugin-tools:maven-plugin-annotations(提供 @Mojo、@Parameter 等注解,provided 范围)
  • 推荐使用 maven-plugin-plugin 插件生成插件描述符(plugin.xml),避免运行时报 “No plugin descriptor found”

参数注入与构建上下文访问是实用关键

Mojo 不是孤立运行的,它能天然获取 Maven 构建环境信息:

  • 用 @Parameter(defaultValue = "${project}") 注入 MavenProject 对象,可读取 pom.xml 内容、模块路径、依赖列表等
  • 用 @Parameter(defaultValue = "${session}") 获取 MavenSession,用于跨模块协调或判断构建模式(如是否跳过测试)
  • 自定义参数用 @Parameter(property = "myplugin.env"),支持命令行传参:mvn package -Dmyplugin.env=prod
  • 日志统一用 getLog().info("..."),输出会自然融入 Maven 控制台流

验证与调试要分两步走

插件开发容易卡在“写了但没执行”,验证链路要清晰:

  • 先本地安装:在插件项目中执行 mvn clean install,确认 target/classes/META-INF/maven/plugin.xml 存在且 goal 正确注册
  • 再在业务项目中引用并触发:要么配置 <executions></executions> 让它随生命周期自动跑;要么直接命令行调用:mvn com.example:my-maven-plugin:1.0.0:assemble-configs
  • 若未执行,优先检查:plugin.xml 是否生成、goal 名是否拼写一致、绑定 phase 是否已被其他插件覆盖、Maven 版本兼容性(如注解版本与 maven-plugin-plugin 版本匹配)

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java maven

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9277

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

6442

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5752

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1024

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

848

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1216

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2449

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19791

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1095

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习