0

0

如何正确选择 Maven 中需要 Shade 的依赖包

碧海醫心

碧海醫心

发布时间:2026-01-05 13:48:35

|

385人浏览过

|

来源于php中文网

原创

如何正确选择 Maven 中需要 Shade 的依赖包

maven shade 插件并非默认必需,仅在特定场景(如插件开发、类加载隔离)下才需谨慎使用;判断是否 shade 及选择哪些包,应优先通过依赖调解、版本统一和精简依赖来解决冲突, shade 应是最后手段。

在构建可分发的 Java 应用(尤其是插件型 JAR,如 Bukkit/Spigot 插件、Jenkins 插件或 Fabric Loader 模组)时,“是否 Shade”以及“Shade 哪些包”常令人困惑。核心原则是:Shade 不是常规操作,而是应对特定类加载冲突的防御性策略

✅ 何时真正需要 Shade?

  • 运行环境不可控:你的 JAR 作为插件被加载到第三方宿主(如 Minecraft 服务端、Jenkins、Eclipse 插件平台),而宿主或其他插件可能已加载了同名但不同版本的依赖(如 guava, gson, slf4j),导致 LinkageError 或 NoSuchMethodError。
  • 你无法控制宿主的 classpath:此时,将关键依赖内嵌并重命名(即 Shade + Relocation)可实现类路径隔离。
  • 你发布的是“瘦插件”(thin plugin):自身代码极简,重度依赖外部库,且这些库与宿主生态存在版本不兼容风险。

❌ 何时 不应 盲目 Shade?

  • 构建普通独立应用(java -jar app.jar):应优先使用 maven-assembly-plugin 或 spring-boot-maven-plugin 打 fat jar,而非 Shade —— 后者主要为重定位设计,非单纯打包。
  • 依赖冲突可通过 解决:例如,多个传递依赖引入了不同版本的 commons-collections4,可在 pom.xml 中统一声明:

  
    
      org.apache.commons
      commons-collections4
      4.4
    
  
  • 可通过 exclusions 精简依赖树:移除冗余或冲突的传递依赖:

  com.example
  problematic-lib
  
    
      com.google.guava
      guava
    
  

? 如何确定“该 Shade 哪个包”?(无文档时的实操方法)

当官方未明确建议 relocation 包名时,按以下步骤排查:

  1. 分析冲突根源:运行时抛出 ClassNotFoundException 或 NoClassDefFoundError 时,记录完整类名(如 com.google.common.collect.ImmutableList);
  2. 定位所属依赖:执行 mvn dependency:tree -Dverbose | grep -A5 -B5 "guava",确认该类来自哪个 artifact;
  3. 检查其顶层包结构:下载对应 JAR,用 jar -tf xxx.jar | head -20 查看根目录下的 package 前缀(如 com/google/common/ → pattern 应为 com.google);
  4. 最小化 relocation 范围:仅 relocate 实际冲突的包,而非整个依赖。例如:
    
      com.google.common.
      ${shade.base}.guava.
    

    注意末尾的 .,避免误匹配 com.google.commoner 等无关包。

    DubbingX智声云配
    DubbingX智声云配

    多情绪免费克隆AI音频工具

    下载

⚠️ 重要注意事项

  • 避免过度 Shade:Shading org.slf4j 或 javax.annotation 等 SPI/契约类可能导致日志失效或注解处理器异常;
  • 测试必须覆盖运行时环境:仅在 IDE 或 mvn exec:java 中通过不代表插件真实可用——务必在目标平台(如 Spigot 服务器)中验证;
  • 命名需唯一且有意义:推荐格式 ${project.groupId}.shaded,例如 com.myapp.shaded,避免与其他插件 Shade 冲突;
  • 考虑替代方案:对日志、JSON、HTTP 等通用能力,优先选用宿主已提供的 API(如 Spigot 的 YamlConfiguration、Jenkins 的 TaskListener),减少依赖引入。

总之,Shade 是一把精准手术刀,不是万能胶。先诊断、再调解、最后隔离——这才是稳健交付插件或嵌入式模块的正确路径。

相关专题

更多
java
java

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

827

2023.06.15

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

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

731

2023.07.05

java自学难吗
java自学难吗

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

732

2023.07.31

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

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

396

2023.08.01

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

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

398

2023.08.02

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

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

446

2023.08.02

java有什么用
java有什么用

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

430

2023.08.02

java在线网站
java在线网站

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

16904

2023.08.03

漫蛙2入口地址合集
漫蛙2入口地址合集

本专题整合了漫蛙2入口汇总,阅读专题下面的文章了解更多详细内容。

162

2026.01.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.3万人学习

C# 教程
C# 教程

共94课时 | 6.2万人学习

Java 教程
Java 教程

共578课时 | 42.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号