正确配置 Maven Shade Plugin 以生成可执行 Fat Jar

云宇酱_6970

云宇酱_6970

2026-03-22

493人浏览

原创

正确配置 Maven Shade Plugin 以生成可执行 Fat Jar

本文详解为何 maven-shade-plugin 未生效的常见原因——误将插件声明置于 中,并提供完整、可落地的配置方案,确保 mvn package 正确触发 Shade 插件构建包含依赖的可运行 JAR。

本文详解为何 `maven-shade-plugin` 未生效的常见原因——误将插件声明置于 `` 中,并提供完整、可落地的配置方案,确保 `mvn package` 正确触发 shade 插件构建包含依赖的可运行 jar。

在多模块 Maven 项目中,若希望为特定子模块(如 simple-client 或 simple-server)生成包含所有运行时依赖的「Fat Jar」(即 Uber JAR),maven-shade-plugin 是最常用且可靠的工具。但实践中常出现「执行 mvn package 后却只生成普通 JAR(由 maven-jar-plugin 生成),Shade 插件完全未执行」的问题——这并非插件版本或生命周期冲突所致,而是一个典型的配置作用域误解。

? 根本原因: ≠

Maven 中:

  • 仅用于集中声明插件的默认配置和版本,它本身不会绑定插件到生命周期,也不会触发执行;
  • (即顶层 plugins 块)才真正将插件声明“激活”,使其在对应 phase(如 package)中运行。

在你的 simple-client/pom.xml 中,Shade 插件被错误地放在 内:

<build><pluginmanagement><plugins><plugin><groupid>org.apache.maven.plugins</groupid><artifactid>maven-shade-plugin</artifactid><!-- ... --></plugin></plugins></pluginmanagement></build>

✅ 正确做法是:移出 ,直接置于 下:

<build><finalname>Server</finalname><plugins><plugin><groupid>org.apache.maven.plugins</groupid><artifactid>maven-shade-plugin</artifactid><version>3.4.1</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><transformers><transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><mainclass>com.firstproject.myapp.AppServer</mainclass></transformer></transformers><minimizejar>false</minimizejar><createdependencyreducedpom>false</createdependencyreducedpom><dependencyreducedpomlocation>${java.io.tmpdir}/dependency-reduced-pom.xml</dependencyreducedpomlocation><relocations><relocation><pattern>com.firstproject.myapp</pattern><shadedpattern>hidden.coyote</shadedpattern></relocation></relocations></configuration></execution></executions></plugin></plugins></build>

? 提示: 仍保留在 根层级下,它影响最终 JAR 文件名(如生成 Server.jar 而非默认的 simple-client-1.0-SNAPSHOT.jar)。

✅ 验证与最佳实践

  1. 验证是否生效:执行 mvn clean package -X(开启 debug 日志),搜索 maven-shade-plugin:3.4.1:shade,确认其出现在 package phase 日志中;同时检查 target/ 目录下是否生成了 Server.jar(而非 Server-1.0-SNAPSHOT.jar)及 Server-original.jar(原始 jar)。

  2. 避免父 POM 干预:你当前的 parent-project 使用 packaging=pom 且 为空,这是推荐做法——父 POM 不应定义具体插件行为,子模块按需独立声明。若未来需统一 Shade 配置(如所有可执行模块共用相同 mainClass 模式),可在父 POM 的 中预设,但每个子模块仍必须在自身 中显式引用该插件:

<!-- 父 POM 中(仅管理) -->
<pluginmanagement><plugins><plugin><groupid>org.apache.maven.plugins</groupid><artifactid>maven-shade-plugin</artifactid><version>3.4.1</version><configuration><createdependencyreducedpom>false</createdependencyreducedpom></configuration></plugin></plugins></pluginmanagement>
<!-- 子模块中(必须显式启用) -->
<build><plugins><plugin><groupid>org.apache.maven.plugins</groupid><artifactid>maven-shade-plugin</artifactid><!-- 版本继承自 pluginManagement,无需重复声明 --><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><transformers><transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><mainclass>com.firstproject.myapp.AppServer</mainclass></transformer></transformers></configuration></execution></executions></plugin></plugins></build>

⚠️ 注意事项总结

  • ❌ 不要仅靠 “以为已配置” —— 它不执行,只管理;
  • ✅ 是插件执行的唯一入口,必须出现在子模块 pom.xml 的 直接子节点中;
  • ? maven-jar-plugin 的默认 jar goal 总会在 package phase 执行,但只要 Shade 插件正确绑定,它会生成额外的 shaded jar(原 jar 仍存在,除非显式禁用);
  • ? 若仍不生效,请检查 mvn help:effective-pom -Dverbose 查看实际生效的 POM 结构,确认 Shade 插件是否出现在 列表中。

遵循以上配置逻辑,即可稳定、可靠地为任意子模块生成带主类、含全部依赖的可执行 Fat Jar。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

10937

6

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

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

2023.07.05

8062

9

java自学难吗
java自学难吗

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

2023.07.31

6972

8

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

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

2023.08.01

1184

3

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

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

2023.08.02

968

3

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

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

2023.08.02

1416

5

java有什么用
java有什么用

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

2023.08.02

2889

5

java在线网站
java在线网站

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

2023.08.03

20171

3

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

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

2023.08.03

1275

8

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.9万人学习