如何正确配置 Maven Shade 插件生成可执行 Fat Jar

千杰君_6208

千杰君_6208

2026-04-30

794人浏览

原创

如何正确配置 Maven Shade 插件生成可执行 Fat Jar

本文详解 Maven 中 maven-shade-plugin 未生效的典型原因:插件被错误置于 块内,导致构建时完全静默;提供精简、可运行的配置模板,并说明验证方法与关键注意事项。

本文详解 maven 中 `maven-shade-plugin` 未生效的典型原因:插件被错误置于 `` 块内,导致构建时完全静默;提供精简、可运行的配置模板,并说明验证方法与关键注意事项。

在使用 Maven 构建可执行 Fat Jar(即包含全部依赖与主类声明的单体 JAR)时,maven-shade-plugin 是业界首选——它不仅支持依赖打包,还提供类重定位(relocation)、资源合并、冲突处理等高级能力。但大量开发者会遇到一个“无声失败”问题:执行 mvn clean package 后,输出的仍是普通 JAR(由 maven-jar-plugin 生成),控制台日志中甚至找不到 shade 的任何执行痕迹,且生成的 JAR 既无 Main-Class 入口,也不含第三方依赖(如示例中的 gnu.getopt)。

根本原因在于 Maven 的配置作用域误解:

  • 仅用于集中声明插件的默认版本与配置模板,它本身不触发插件执行,也不绑定到生命周期阶段;
  • 真正启用插件并使其参与构建流程,必须将 声明置于 (即顶层插件块)中。

在你的 pom.xml 中,maven-shade-plugin 被包裹在 内:

<build><pluginmanagement><plugins><plugin><groupid>org.apache.maven.plugins</groupid><artifactid>maven-shade-plugin</artifactid><version>3.4.1</version><!-- ... execution & configuration --></plugin></plugins></pluginmanagement></build>

这相当于“只写了说明书,没按开关”——插件配置存在,但从未被激活。Maven 默认仍调用 maven-jar-plugin:jar(见日志中 maven-jar-plugin:2.4:jar (default-jar)),因此生成的是空依赖、无 MANIFEST 的标准 JAR。

✅ 正确配置方式(精简可运行版):
将 移出 ,直接置于 下,并确保 绑定到 package 阶段:

<build><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>org.example.Hello</mainclass></transformer></transformers><!-- 关键:禁用 dependency-reduced pom,避免干扰 --><createdependencyreducedpom>false</createdependencyreducedpom><!-- 可选:重命名输出文件,避免与原始 jar 冲突 --><shadedartifactattached>true</shadedartifactattached><shadedclassifiername>fat</shadedclassifiername></configuration></execution></executions></plugin></plugins></build>

✅ 效果验证方法:

  • 执行 mvn clean package -X | grep -i "shade",应看到类似:
    Executing org.apache.maven.plugins:maven-shade-plugin:3.4.1:shade
  • 检查 target/ 目录:除 hello-fat-jar-0.1-SNAPSHOT.jar 外,还会生成 hello-fat-jar-0.1-SNAPSHOT-fat.jar(因启用了 shadedArtifactAttached);
  • 运行 jar -tf target/hello-fat-jar-0.1-SNAPSHOT-fat.jar | head -20,可见 gnu/getopt/ 包路径及大量依赖类;
  • 运行 java -jar target/hello-fat-jar-0.1-SNAPSHOT-fat.jar -x,应输出 Hello X! 和 Goodbye。

⚠️ 关键注意事项:

  • 勿混用 与 :多模块项目中,若需统一管理插件版本,应在父 POM 的 中声明版本,再于子模块 中仅声明 groupId/artifactId/goals(无需重复 version);
  • 避免 MANIFEST 冲突:若同时配置了 maven-jar-plugin,其 MANIFEST 可能覆盖 Shade 的设置,建议移除或显式禁用;
  • 依赖冲突处理:当多个依赖含同名资源(如 META-INF/services/*),需添加 ServicesResourceTransformer;
  • Java 9+ 模块兼容性:若项目使用模块系统(module-info.java),Shade 不支持自动迁移模块描述符,建议结合 jlink 或改用 jpackage。

最终,一个最小可行的 Fat Jar 构建流程只需三步:

  1. 将 maven-shade-plugin 正确声明于 ;
  2. 配置 ManifestResourceTransformer 指定 mainClass;
  3. 执行 mvn clean package 并验证输出 JAR 的内容与可执行性。

至此,你已掌握 Maven Shade 插件的核心实践逻辑——不是配置越复杂越好,而是理解作用域、生命周期与插件职责边界,方能一次构建,稳定交付。

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

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

下载

相关标签:

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

相关专题

更多
Java Maven专题
Java Maven专题

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

2025.09.15

3380

19

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

2026.05.09

349

25

FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

2026.10.08

0

20

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

2026.09.30

120

10

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

2026.09.30

100

14

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

2026.09.30

80

12

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

2026.09.30

80

26

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

2026.09.29

100

15

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

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

2026.09.23

300

15

热门下载

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

精品课程

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

共6课时 | 54.6万人学习

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

共89课时 | 133.4万人学习