maven-plugin-shade 详解

一、介绍 [1]

This plugin provides the capability to package the artifact in an uber-jar, including its dependencies and to shade - i.e. rename - the packages of some of the dependencies.

maven-plugin-shade 插件提供了两个能力：

  1. 把整个项目（包含它的依赖）都打包到一个 "uber-jar" 中
  2. shade - 即重命名某些依赖的包

由此引出了两个问题：

  1. 什么是 uber-jar ？

    uber-jar 也叫做 fat-jar 或者 jar-with-dependencies，意思就是包含依赖的 jar。

  2. 什么是 shade ？

    shade 意为遮挡，在此处可以理解为对依赖的 jar 包的重定向（主要通过重命名的方式）。

💁‍♂️ 下文中可能使用 shade 来代替 maven-plugin-shade。

二、基本使用 [2]

maven-plugin-shade 必须和 Maven 构建生命周期中的 package 阶段绑定，也就是说，当执行 mvn package 时会自动触发 shade。

要使用 maven-plugin-shade，只需要在 pom.xml 的 <plugins> 标签下添加它的配置即可，示例如下：

<project>...<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.2.4</version><configuration><!-- 此处按需编写更具体的配置 --></configuration><executions><execution><!-- 和 package 阶段绑定 --><phase>package</phase><goals><goal>shade</goal></goals></execution></executions></plugin></plugins></build>...
</project>

默认情况下会把项目所有的依赖都包含进最终的 jar 包中。当然，我们也可以在 <configuration> 标签内配置更具体的规则。

三、常用功能

3.1 按需选择要添加到最终 jar 包中依赖 [3]

使用 <includes> 排除不需要的依赖，示例如下：

<configuration><artifactSet><excludes><exclude>classworlds:classworlds</exclude><exclude>junit:junit</exclude><exclude>jmock:*</exclude><exclude>*:xml-apis</exclude><exclude>org.apache.maven:lib:tests</exclude><exclude>log4j:log4j:jar:</exclude></excludes></artifactSet>
</configuration>

使用 <filters> 结合 <includes> & <excludes> 标签可实现更灵活的依赖选择，示例如下：

<configuration><filters><filter><artifact>junit:junit</artifact><includes><include>junit/framework/**</include><include>org/junit/**</include></includes><excludes><exclude>org/junit/experimental/**</exclude><exclude>org/junit/runners/**</exclude></excludes></filter><filter><artifact>*:*</artifact><excludes><exclude>META-INF/*.SF</exclude><exclude>META-INF/*.DSA</exclude><exclude>META-INF/*.RSA</exclude></excludes></filter></filters>
</configuration>

除了可以通过自定义的 filters 来过滤依赖，此插件还支持自动移除项目中没有使用到的依赖，以此来最小化 jar 包的体积，只需要添加一项配置即可。示例如下：

<configuration><minimizeJar>true</minimizeJar>
</configuration>

3.2 重定位 class 文件 [4]

如果最终的 jar 包被其他的项目所依赖的话，直接地引用此 jar 包中的类可能会导致类加载冲突，这是因为 classpath 中可能存在重复的 class 文件。为了解决这个问题，我们可以使用 shade 提供的重定位功能，把部分类移动到一个全新的包中。示例如下：

<configuration><relocations><relocation><pattern>org.codehaus.plexus.util</pattern><shadedPattern>org.shaded.plexus.util</shadedPattern><excludes><exclude>org.codehaus.plexus.util.xml.Xpp3Dom</exclude><exclude>org.codehaus.plexus.util.xml.pull.*</exclude></excludes></relocation></relocations>
</configuration>

涉及标签：

  • <pattern>：原始包名
  • <shadedPattern>：重命名后的包名
  • <excludes>：原始包内不需要重定位的类，类名支持通配符

例如，在上述示例中，我们把 org.codehaus.plexus.util 包内的所有子包及 class 文件（除了 ~.xml.Xpp3Dom 和 ~.xml.pull 包下的所有 class 文件）重定位到了 org.shaded.plexus.util 包内。

当然，如果包内的大部分类我们都不需要，一个个排除就显得很繁琐了。此时我们也可以使用 <includes> 标签来指定我们仅需要的类，示例如下：

<project>...<relocation><pattern>org.codehaus.plexus.util</pattern><shadedPattern>org.shaded.plexus.util</shadedPattern><includes><include>org.codehaud.plexus.util.io.*</include></includes></relocation>...
</project>

3.3 生成可执行 jar 包 [5]

使用 maven-plugin-shade 后，最终生成的 jar 包可以包含所有项目所需要的依赖。我们会想，能不能直接运行这个 uber-jar 呢？答案是当然可以，并且十分简单，只需要指定 <mainClass> 启动类就可以了。示例如下：

<project>...<configuration><transformers><transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><mainClass>org.sonatype.haven.HavenCli</mainClass></transformer></transformers></configuration>...
</project>

熟悉 jar 包的朋友们都知道，jar 包中默认会包含一个 MANIFEST.MF 文件，里面描述了一些 jar 包的信息。使用 java 自带的 jar 命令打包的时候可以指定 MANIFEST.MF，其中也可以指定 Main-Class 来使得 jar 包可运行。那么使用 shade 来指定和直接在 MANIFEST.MF 文件中指定有什么区别呢？

答案是没有区别，细心的读者会发现 <mainClass> 标签的父标签是 <transformer> 有一个 implementation 属性，其值为 "~.ManifestResourceTransformer"，意思是 Manifest 资源文件转换器。上述示例只自指定了启动类，因此 shade 会为我们自动生成一个包含 Main-Class 的 MANIFEST.MF 文件，然后在打 jar 包时指定这个文件。

那如果我们想要完全定制 MANIFEST.MF 文件内容怎么办呢？我们可以使用 <manifestEntries> 标签，示例如下：

<project>...<configuration><transformers><transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><manifestEntries><Main-Class>org.sonatype.haven.ExodusCli</Main-Class><Build-Number>123</Build-Number></manifestEntries></transformer></transformers></configuration>...
</project>

4.4 生成资源文件 [6]

项目中涉及到的依赖可能会有它们所必需的资源文件，使用 shade 可以把它们聚合在同一个 jar 包中。

默认地，shade 为我们提供了 12 个 ResourceTransformer 类：

类名作用
ApacheLicenseResourceTransformer防止 LICENSE 文件重复
ApacheNoticeResourceTransformer准备合并的 NOTICE
AppendingTransformer为某个资源文件附加内容
ComponentsXmlResourceTransformer聚合 Plexus components.xml
DontIncludeResourceTransformer防止包含指定的资源
GroovyResourceTransformer合并 Apache Groovy 的扩展模块
IncludeResourceTransformer添加项目中的文件为资源文件
ManifestResourceTransformer自定义 MANIFEST 文件
PluginXmlResourceTransformer聚合 Maven 的 plugin.xml 配置
ResourceBundleAppendingTransformer合并 ResourceBundles
ServicesResourceTransformer重定位且合并 META-INF/services 资源文件中的 class 文件.
XmlAppendingTransformer为 XML 资源文件附加内容

每种 ResourceTransformer 的具体使用可以点击对应链接查看官方示例，这里不再赘述。

如果上述 12 个类都不能够满足我们的需求，我们可以实现 shade 提供的接口，按需自定义一个 ResourceTransformer，实现方法详见官网 Using your own Shader implementation。

参考来源

  1. Apache Maven Shade Plugin – Introduction ↩︎

  2. Apache Maven Shade Plugin – Usage ↩︎

  3. http://maven.apache.org/plugins/maven-shade-plugin/examples/includes-excludes.htm ↩︎

  4. Apache Maven Shade Plugin – Relocating Classes ↩︎

  5. Apache Maven Shade Plugin – Executable JAR ↩︎

  6. Apache Maven Shade Plugin – Resource Transformers

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/113959.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

C语言--冒泡排序和简答选择排序

C语言--冒泡排序和简答选择排序

冒泡排序 一种典型的交换排序 类似水冒泡&#xff0c;大元素经不断的交换由水底慢慢的浮出 从头到尾&#xff0c;循环比较两相邻的元素 大的元素移到后面&#xff0c;小的放前面-每次循环&#xff0c;大的元素会排到最后 代码如下&#xff1a; #include<stdio.h> …
阅读更多...
js 删除树状图无用数据，如果子级没有数据则删除

js 删除树状图无用数据，如果子级没有数据则删除

有一个需求&#xff0c;当你从后端拿到一个树状图的时候&#xff0c;有些子级没数据&#xff0c;这时就需要我们处理一下数据&#xff0c;当然了&#xff0c;如果第一层底下的第二层没数据&#xff0c;第二层底下的所有都没数据&#xff0c;那这一层都不需要。 我的写法&#x…
阅读更多...
常用消息中间件

常用消息中间件

RocketMQ 阿里开源&#xff0c;阿里参照kafka设计的&#xff0c;Java实现 能够保证严格的消息顺序 提供针对消息的过滤功能 提供丰富的消息拉取模式 高效的订阅者水平扩展能力 实时的消息订阅机制 亿级消息堆积能力 RabbitMQ Erlang实现&#xff0c;非常重量级&#xff0c;更适…
阅读更多...
竞赛 深度学习交通车辆流量分析 - 目标检测与跟踪 - python opencv

竞赛 深度学习交通车辆流量分析 - 目标检测与跟踪 - python opencv

文章目录 0 前言1 课题背景2 实现效果3 DeepSORT车辆跟踪3.1 Deep SORT多目标跟踪算法3.2 算法流程 4 YOLOV5算法4.1 网络架构图4.2 输入端4.3 基准网络4.4 Neck网络4.5 Head输出层 5 最后 0 前言 &#x1f525; 优质竞赛项目系列&#xff0c;今天要分享的是 &#x1f6a9; *…
阅读更多...
程序连接oracle查询数据的环境配置

程序连接oracle查询数据的环境配置

连接oracle 数据库真麻烦&#xff0c;还是MySQL方便 Oracle Instant Client 这个东西的版本跟oracle的版本是有讲究的&#xff0c;引用文档的说明 Oracle 标准的客户端-服务器网络互操作性允许不同版本的 Oracle 客户端和 Oracle 数据库之间的连接。有关经过认证的配置&#…
阅读更多...
R语言的计量经济学技术

R语言的计量经济学技术

量经济学通常使用较小样本&#xff0c;但这种区别日渐模糊&#xff0c;机器学习在经济学领域、特别是经济学与其它学科的交叉领域表现日益突出&#xff0c;R语言是用于统计建模的主流计算机语言&#xff0c;在本次培训中&#xff0c;我们将从实际应用出发&#xff0c;重点从数据…
阅读更多...
ArmSoM-RK3588编解码之mpp解码demo解析：mpi_dec_test

ArmSoM-RK3588编解码之mpp解码demo解析：mpi_dec_test

1. 简介 [RK3588从入门到精通] 专栏总目录 mpi_dec_test 是rockchip官方解码 demo 本篇文章进行mpi_dec_test 的代码解析&#xff0c;解码流程解析 2. 环境介绍 硬件环境&#xff1a; ArmSoM-W3 RK3588开发板 软件版本&#xff1a; OS&#xff1a;ArmSoM-W3 Debian11 3.…
阅读更多...
失配树学习笔记

失配树学习笔记

失配树&#xff0c;是一种奇妙的数据结构&#xff0c;它利用 KMP、LCA 解决求两前缀的最长公共 Border 的问题。 首先介绍一下什么是 Border&#xff0c;我们知道 nxt 数组是前后缀相同的最大长度&#xff0c;Border 相当于是 nxt 数组的弱化版&#xff0c;只是去掉了“最大”…
阅读更多...
[TCP1P 2023] 部分crypto,pwn,reverse

[TCP1P 2023] 部分crypto,pwn,reverse

Crypto Final Consensus 这是个AES爆破密钥的题&#xff0c;加密方法是先后用两个密钥加密。远程先给出加密后的flag&#xff0c;然后允许输入值并进行加密。 from Crypto.Cipher import AES import random from Crypto.Util.Padding import pada b"" b b"&…
阅读更多...
SystemVerilog Assertions应用指南 Chapter1.29“ disable iff构造

SystemVerilog Assertions应用指南 Chapter1.29“ disable iff构造

在某些设计情况中,如果一些条件为真,则我们不想执行检验。换句话说,这就像是一个异步的复位,使得检验在当前时刻不工作。SVA提供了关键词“ disable iff来实现这种检验器的异步复位。“ disable iff”的基本语法如下。 disable iff (expression) <property definition> …
阅读更多...
Modelsim无法生成LICENSE的问题

Modelsim无法生成LICENSE的问题

按照网上的破解教程&#xff0c;将mgls.dll和mgls64.dll属性都是去掉只读后&#xff0c;点击patch64_dll.bat文件生成LICENSE&#xff0c;发现在弹出的对话框中一直提示找不到其文件&#xff0c;无法正常生成LICENSE。 解决方法&#xff1a; 1.按winR键或者在电脑搜索界面中输…
阅读更多...
面试算法34：外星语言是否排序

面试算法34：外星语言是否排序

题目 有一门外星语言&#xff0c;它的字母表刚好包含所有的英文小写字母&#xff0c;只是字母表的顺序不同。给定一组单词和字母表顺序&#xff0c;请判断这些单词是否按照字母表的顺序排序。例如&#xff0c;输入一组单词[“offer”&#xff0c;“is”&#xff0c;“coming”…
阅读更多...
Qwik开发使用入门

Qwik开发使用入门

前言 前面我们介绍了一下 Qwik 这个新的框架&#xff0c;如果没有看过的童鞋可以移步这里&#xff08;追求极致性能&#xff01;Qwik 1.0版本发布&#xff09;。 本文结合官方的教学文档&#xff0c;翻译整理&#xff0c;原文链接在文末。 安装Qwik的前提条件 本地安装 Nod…
阅读更多...
【论文解读】The Power of Scale for Parameter-Efficient Prompt Tuning

【论文解读】The Power of Scale for Parameter-Efficient Prompt Tuning

一.介绍 1.1 promote tuning 和 prefix tuning 的关系 “前缀调优”的简化版 1.2 大致实现 冻结了整个预训练模型&#xff0c;并且只允许每个下游任务附加k个可调令牌到输入文本。这种“软提示”是端到端训练的&#xff0c;可以压缩来自完整标记数据集的信号&#xff0c;使…
阅读更多...
ssrf漏洞学习

ssrf漏洞学习

目录 ssrf漏洞 相关函数 相关协议 file协议 dict协议 gopher协议 ctfshow ssrf web351 web352 web353 web354过滤01 web355五位长度 web356 三位长度 web357 DNS重定向 web358 正则 ssrf漏洞 SSRF&#xff08;Server-Side Request Forgery&#xff0c;服务器端请…
阅读更多...
位操作符^以及正负数在计算机中的存储

位操作符^以及正负数在计算机中的存储

(数据是怎么在计算机中存储的)​ 正数和负数在内存中都是以补码的形式存储的&#xff0c;但不同的是正数的原码&#xff0c;补码&#xff0c;反码都是相同的&#xff0c;而负数的原码&#xff0c;补码和反码是不同的。 负数的原码&#xff0c;补码&#xff0c;反码之间存在什么…
阅读更多...
人大金仓与哪吒科技达成战略合作，加快推动智慧港口建设

人大金仓与哪吒科技达成战略合作，加快推动智慧港口建设

近日&#xff0c;人大金仓与哪吒港航智慧科技&#xff08;上海&#xff09;有限公司&#xff08;以下简称“哪吒科技”&#xff09;达成战略合作。双方旨在共享优势资源&#xff0c;联合为港口企业转型升级提供完备的技术支撑与行业解决方案。人大金仓总裁杜胜、哪吒科技总经理…
阅读更多...
elementui中el-select和el-tree实现下拉树形多选功能

elementui中el-select和el-tree实现下拉树形多选功能

实现效果如下&#xff1a; 代码如下&#xff1a; html中 <el-col :lg"12"><el-form-item label"可用单位" prop"useOrgListTemp"><div class"departAll"><el-selectref"selectTree"v-model"valu…
阅读更多...
英语——分享篇——每日200词——2601-2800

英语——分享篇——每日200词——2601-2800

2601——resistant——[rɪzɪstənt]——adj.抵抗的——resistant——resi热死(拼音)st石头(拼音)ant蚂蚁(熟词)——热死了石头上的蚂蚁还在抵抗——The body may be less resistant if it is cold. ——天冷时&#xff0c;身体的抵抗力会下降。 2602——prospect——[prɒspe…
阅读更多...
42911-2023 碳纤维增强复合材料 密封压力容器加速吸湿和过饱和调节方法

42911-2023 碳纤维增强复合材料 密封压力容器加速吸湿和过饱和调节方法

1 范围 本文件描述了碳纤维增强复合材料加速吸湿和过饱和调节的方法&#xff0c;该方法在温度高于100 ℃但低 于试验材料玻璃化转变温度(T) 的饱和水蒸气密封压力容器中进行。 本文件适用于玻璃化转变温度大于150℃的热固性碳纤维增强复合材料。热塑性碳纤维增强复合 材料也…
阅读更多...
最新文章

Copyright @ 2022~2023