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

如何使用 Maven Shade 插件正确构建可执行 Fat Jar

星瑶君_6704

星瑶君_6704

发布时间:2026-04-30 12:37:03

|

422人浏览过

|

来源于php中文网

原创

如何使用 Maven Shade 插件正确构建可执行 Fat Jar

本文详解 Maven 中 maven-shade-plugin 未生效的根本原因:插件被错误置于 块内,导致其不参与构建生命周期;提供精简、可靠、经验证的配置方案,并说明验证方法与关键注意事项。

本文详解 maven 中 `maven-shade-plugin` 未生效的根本原因:插件被错误置于 `` 块内,导致其不参与构建生命周期;提供精简、可靠、经验证的配置方案,并说明验证方法与关键注意事项。

在 Maven 构建中,生成一个包含全部依赖(含 gnu.getopt 等第三方库)且可直接通过 java -jar 运行的 Fat Jar(又称 Uber JAR),maven-shade-plugin 是最推荐的官方方案——它不仅支持依赖打包,还提供类重定位(relocation)、资源合并、MANIFEST 自动注入等高级能力。但实践中,绝大多数“配置无效”问题并非源于插件本身,而是 Maven 配置作用域的误解。

❌ 常见错误:误用

你提供的 pom.xml 中,maven-shade-plugin 被包裹在 标签下:

<build>
  <pluginManagement>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
        <!-- ... -->
      </plugin>
    </plugins>
  </pluginManagement>
</build>

⚠️ 关键事实:

  • 仅用于集中声明插件的默认版本和配置模板,不会触发任何执行;
  • 它不绑定生命周期(如 package 阶段),也不参与实际构建流程;
  • 此时 Maven 仍会调用默认的 maven-jar-plugin(日志中可见 maven-jar-plugin:2.4:jar (default-jar)),生成仅含自身字节码的普通 JAR —— 这正是你看到 jar tf 输出中无 gnu/getopt/ 类、且 java -jar 报错 no main manifest attribute 的根本原因。

✅ 正确配置:移至 (项目级启用)

将 块直接置于 下,而非 内:

<build>
  <finalName>hello-fat-jar</finalName> <!-- 可选:自定义输出文件名 -->
  <plugins>
    <!-- ✅ 正确位置:激活插件并绑定到生命周期 -->
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-shade-plugin</artifactId>
      <version>3.4.1</version> <!-- 推荐使用 3.4.1+(兼容 JDK 17+) -->
      <executions>
        <execution>
          <phase>package</phase>
          <goals>
            <goal>shade</goal>
          </goals>
          <configuration>
            <!-- 指定启动主类,写入 MANIFEST.MF -->
            <transformers>
              <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                <mainClass>org.example.Hello</mainClass>
              </transformer>
            </transformers>
            <!-- 可选:避免生成 dependency-reduced-pom.xml(简化输出) -->
            <createDependencyReducedPom>false</createDependencyReducedPom>
            <!-- 可选:禁用 shaded artifact 附加(避免生成两个 jar) -->
            <shadedArtifactAttached>false</shadedArtifactAttached>
          </configuration>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

? 提示: 可省略,默认为 ${artifactId}-${version};若需同时保留原始 jar 与 fat jar,可设 true(此时 fat jar 名为 xxx-shaded.jar)。

? 验证是否生效

执行构建并检查关键信号:

mvn clean package -X | grep -i "shade"

✅ 成功日志应包含:

[DEBUG] Configuring mojo 'org.apache.maven.plugins:maven-shade-plugin:3.4.1:shade' ...
[INFO] --- maven-shade-plugin:3.4.1:shade (default) @ hello-fat-jar ---
[INFO] Including gnu.getopt:java-getopt:jar:1.0.13 in the shaded jar.

✅ 检查输出文件:

ls target/
# 应出现:hello-fat-jar-0.1-SNAPSHOT.jar(即 fat jar,体积显著大于原 jar)

jar -tf target/hello-fat-jar-0.1-SNAPSHOT.jar | head -20
# 应包含:gnu/getopt/Getopt.class、META-INF/MANIFEST.MF 等

# 查看 MANIFEST 是否含 Main-Class
unzip -p target/hello-fat-jar-0.1-SNAPSHOT.jar META-INF/MANIFEST.MF
# 输出应含:Main-Class: org.example.Hello

✅ 最终运行验证:

java -jar target/hello-fat-jar-0.1-SNAPSHOT.jar -x
# 输出:Hello X! \n Goodbye

⚠️ 注意事项与最佳实践

  • 版本兼容性:JDK 17+ 项目请使用 maven-shade-plugin ≥ 3.4.1(旧版如 2.4.3 对模块化支持不佳);
  • 依赖冲突处理:若多个依赖含同名资源(如 META-INF/services/*),需添加 ServicesResourceTransformer 避免覆盖;
  • 类重定位(Re-location):当需规避依赖间类名冲突(如嵌入不同版本的 Guava),使用 配置将包路径重命名;
  • 与 maven-assembly-plugin 对比:Shade 更适合生产环境——它原生支持资源合并策略与类隔离,而 Assembly 更侧重灵活归档格式(如 tar.gz);
  • 多模块项目:确保 Shade 插件配置在具体子模块的 pom.xml 中(如 simple-server/pom.xml),而非父 POM 的 。

至此,你已掌握构建可执行 Fat Jar 的核心要点:配置位置决定执行权, 是开关, 只是说明书。一次修正,永久生效。

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

热门AI工具

更多
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

豆包大模型

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

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

WorkBuddy

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

DeepSeek

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

Lovart
Lovart Hot

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

相关专题

更多
Java Maven专题
Java Maven专题

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

4060

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

369

2026.05.09

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

100

2026.10.22

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

60

2026.10.22

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

60

2026.10.22

Gradle怎么构建Java项目
Gradle怎么构建Java项目

本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。

20

2026.10.22

PHP时间戳漏洞修复教程
PHP时间戳漏洞修复教程

本专题汇总PHP常见时间戳漏洞,包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等,并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案,帮助开发者快速排查和加固时间相关代码。

60

2026.10.22

Golangci-lint配置文件与规则设置
Golangci-lint配置文件与规则设置

本专题聚焦Golangci-lint YAML配置文件,讲清运行参数、规则启停、目录排除、问题过滤及严重级别设置,便于团队统一检查标准。

20

2026.10.22

Golangci-lint安装与入门教程
Golangci-lint安装与入门教程

本专题讲解Golangci-lint的安装、初始化、基础命令和首次代码检查,覆盖本地环境、Docker及多平台用法,帮助Go开发者快速上手。

40

2026.10.22

热门下载

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

精品课程

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

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