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 中统一声明:
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.apache.commons</groupId>
      <artifactId>commons-collections4</artifactId>
      <version>4.4</version>
    </dependency>
  </dependencies>
</dependencyManagement>
  • 可通过 exclusions 精简依赖树:移除冗余或冲突的传递依赖:
<dependency>
  <groupId>com.example</groupId>
  <artifactId>problematic-lib</artifactId>
  <exclusions>
    <exclusion>
      <groupId>com.google.guava</groupId>
      <artifactId>guava</artifactId>
    </exclusion>
  </exclusions>
</dependency>

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

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

拍我AI
拍我AI

AI视频生成平台PixVerse的国内版本

下载
  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 实际冲突的包,而非整个依赖。例如:
    <relocation>
      <pattern>com.google.common.</pattern>
      <shadedPattern>${shade.base}.guava.</shadedPattern>
    </relocation>

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

⚠️ 重要注意事项

  • 避免过度 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 是一把精准手术刀,不是万能胶。先诊断、再调解、最后隔离——这才是稳健交付插件或嵌入式模块的正确路径。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

156

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

88

2026.01.26

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

455

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

334

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

eclipse教程
eclipse教程

php中文网为大家带来eclipse教程合集,eclipse是一个开放源代码的、基于Java的可扩展开发平台。就其本身而言,它只是一个框架和一组服务,用于通过插件组件构建开发环境。php中文网还为大家带来eclipse的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

194

2023.06.14

eclipse怎么设置中文
eclipse怎么设置中文

eclipse设置中文的方法:除了设置界面为中文外,你还可以为Eclipse添加中文插件,以便更好地支持中文编程。例如,你可以安装EBNF插件来支持中文变量名,或安装Chinese Helper来提供中文帮助文档。本专题为大家提供eclipse设置中文相关的各种文章、以及下载和课程。

807

2023.07.24

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

3

2026.03.11

热门下载

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

精品课程

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

共23课时 | 4.3万人学习

C# 教程
C# 教程

共94课时 | 11.1万人学习

Java 教程
Java 教程

共578课时 | 80.7万人学习

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

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