如何避免多个jar通过maven打包成jar,同名配置文件发生覆盖问题
ninehua 2024-12-13 15:33 50 浏览
前言
不知道大家在开发的过程中,有没有遇到这种场景,外部的项目想访问内部nexus私仓的jar,因为私仓不对外开放,导致外部的项目没法下载到私仓的jar,导致项目因缺少jar而无法运行。
通常遇到这种场景,常用的解法有,外部项目跟内部nexus的网络打通,比如通过VPN。或者将私仓的jar直接下载下来给到外部项目。对于第二种方案有时候因为私仓的jar里面有依赖其他的内部jar,导致要下载多个jar的情况。这时候为了方便,我们可能会将这些jar合并成一个大jar,再给出去。而目前有些jar都是一些starter,会有一些同名的配置文件,比如spring.factories。如果不进行处理,直接打包,就会出现同名配置文件覆盖的情况
本文就是要来聊聊当多个jar合并成一个jar,如何解决多个同名配置文件覆盖的情况
解决思路
通过maven-shade-plugin这个插件,利用插件的org.apache.maven.plugins.shade.resource.AppendingTransformer来处理处理多个jar包中存在重名的配置文件的合并。他的核心是在于合并多个同名配置文件内容,而非覆盖
示例配置如下
<build>
<plugins>
<!-- 防止同名配置文件,在打包时被覆盖,用来处理多个jar包中存在重名的配置文件的合并
参考dubbo:https://github.com/apache/dubbo/blob/master/dubbo-all/pom.xml-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.factories</resource>
</transformer>
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.handlers</resource>
</transformer>
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.schemas</resource>
</transformer>
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.tooling</resource>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
打包后的配置文件的效果如下图
眼尖的朋友应该发现了,同名的配置内容是通过追加的方式,但仅仅追加,其实有时候还满足不了要求,比如spring.factories文件,他需要达到的效果应该是如下图
后面我通过maven-shade-plugin的官方示例(https://maven.apache.org/plugins/maven-shade-plugin/examples/resource-transformers.html)试图想找到解决方案,但是有点遗憾,没找到。于是在我面前就有两条路,一条是放弃maven-shade-plugin插件,比如选择其他类似的插件,比如maven-assembly-plugin,这种方案我试过,发现maven-assembly-plugin这个插件的扩展配置,比maven-shade-plugin复杂一些,于是放弃。最后选择了在maven-shade-plugin基础再扩展一下。
扩展的思路
我并没采用直接修改maven-shade-plugin插件的方式,而是在maven-shade-plugin打包后的基础上,再进行插件定制。实现的思路也不难,就是修改maven-shade-plugin打成jar后的spring.factories文件内容,将
调整成形如下即可
自定义maven插件spring-factories-merge-plugin
核心思路
1、如何读取配置文件spring.factories中key重复的内容,而不被覆盖
如果是直接使java.util.properties的读取,当配置文件中有key重复时,比如有多个org.springframework.boot.autoconfigure.EnableAutoConfiguration时,最后会出现value值被覆盖的情况。
解决方案,我们可以利用org.apacche.commons.configuration.PropertiesConfiguration来进行处理
在项目的pom引入GAV
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-configuration2</artifactId>
<version>${commons-configuration2}</version>
</dependency>
读取配置示例代码
@SneakyThrows
public static Map<String, Set<String>> readFactoriesFile(InputStream input) {
// 读取 spring.factories 内容
//利用PropertiesConfiguration取配置文件中key重复的内容,而不被覆盖
PropertiesConfiguration properties = new PropertiesConfiguration();
properties.read(new InputStreamReader(input));
Map<String, Set<String>> multiSetMap = new LinkedHashMap<>();
Iterator<String> keys = properties.getKeys();
while(keys.hasNext()) {
String key = keys.next();
String[] values = properties.getStringArray(key);
Set<String> collectSet = new LinkedHashSet<>();
buildKeyValues(values, collectSet);
multiSetMap.put(key,collectSet);
}
return multiSetMap;
}
2、如何将修改后的配置文件,重新写入jar
我这边的思路就是直接利用IO进行操作了
示例如下
public static void writeFactoriesFile(String factoriesBaseClassPathDir,String finalJarName) throws IOException {
String jarFilePath = String.format(factoriesBaseClassPathDir + "/target/" + finalJarName).replace("\\", "/").replaceAll("//+", "/");
if(!jarFilePath.endsWith(".jar")){
jarFilePath = jarFilePath + ".jar";
}
JarFile jarFile = new JarFile(jarFilePath);
if(jarFile != null){
List<JarEntry> jarFiles = jarFile.stream().collect(Collectors.toList());
@ Cleanup FileOutputStream fos = new FileOutputStream(jarFile.getName(), true);
@ Cleanup JarOutputStream jos = new JarOutputStream(fos);
for (JarEntry jarEntry : jarFiles) {
if(jarEntry.getName().startsWith(SpringFactoriesLoader.FACTORIES_RESOURCE_LOCATION)){
try {
@ Cleanup InputStream input = jarFile.getInputStream(jarEntry);
Map<String, Set<String>> factoriesMap = readFactoriesFile(input);
jos.putNextEntry(new JarEntry(jarEntry.getName()));
generateFactoriesContent(factoriesMap,jos);
} catch (IOException e) {
e.printStackTrace();
}
}else{
//表示将该JarEntry写入jar文件中 也就是创建该文件夹和文件
jos.putNextEntry(new JarEntry(jarEntry));
jos.write(streamToByte(jarFile.getInputStream(jarEntry)));
}
}
}
}
项目中如何配置插件
<build>
<plugins>
<!-- 防止同名配置文件,在打包时被覆盖,用来处理多个jar包中存在重名的配置文件的合并
参考dubbo:https://github.com/apache/dubbo/blob/master/dubbo-all/pom.xml-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.factories</resource>
</transformer>
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.handlers</resource>
</transformer>
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.schemas</resource>
</transformer>
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.tooling</resource>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>com.github.lybgeek.jar</groupId>
<artifactId>spring-factories-merge-plugin</artifactId>
<version>0.0.1-SNAPSHOT</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>springFactoriesMerge</goal>
</goals>
</execution>
</executions>
<configuration>
<factoriesBaseClassPathDir>${basedir}</factoriesBaseClassPathDir>
<finalJarName>${project.artifactId}-${project.version}</finalJarName>
</configuration>
</plugin>
</plugins>
</build>
这边有个小细节是当maven-shade-plugin和spring-factories-merge-plugin的执行生命周期都是相同阶段,比如都是在package时,则maven-shade-plugin放置顺序得在spring-factories-merge-plugin之前,因为spring-factories-merge-plugin是对maven-shade-plugin打包后的结果进行二次加工。如果maven-shade-plugin不放置顺序得在spring-factories-merge-plugin之前,则spring-factories-merge-plugin的执行阶段就要比maven-shade-plugin靠后,比如maven-shade-plugin在package阶段执行,则spring-factories-merge-plugin就得在install或者deploy阶段执行
打包后的效果图如下
总结
之前在看开源框架的时候,很经常都是聚焦在源码上,而不会去注意一些maven插件,这次因为有这打jar的需求。我发现不管是springboot还是dubbo本身就集成一些宝藏插件,比如这个maven-shade-plugin插件,我就是dubbo那边找到的,地址在
https://github.com/apache/dubbo/blob/master/dubbo-all/pom.xml
。比如版本占位符插件flatten-maven-plugin在dubbo和springboot都有看到使用。如果后面有对maven插件由需求,推荐可以从springboot或者dubbo那边去搜,估计会有意想不到的收获
demo链接
https://github.com/lyb-geek/springboot-learning/tree/master/springboot-jar-merge
- 上一篇:JDK1.8下载、安装、配置
- 下一篇:如何使用Axure制作交互文档?
相关推荐
- 美国国防把360列为榜首,网友:你可以说360坏,但不能说3
-
刷到是缘分,感谢大家的阅读,希望您能动动小手帮忙点赞,关注,评论。你的支持和鼓励是我前进的动力。在此祝福大家天天快乐,日日开心!0102就好比你们村的流子,平时在村里嚣张跋扈,但其他村的流子想进来撒泼...
- 无法定位程序输入点怎么解决 教你6招搞定!
-
电脑的使用过程中,用户可能会遇到“无法定位程序输入点”的错误提示。这个问题通常与动态链接库(DLL)文件有关,可能会阻止程序正常运行。导致这个故障问题的原因有很多,例如系统配置、软件安装或动态链接库(...
- 网络打印机安装指南,让你轻松搞定【详解】
-
关注创盛电脑弱电知识每日获取最新行业干货和资料以下是针对各类电脑问题的解决方案,按问题类型分类整理:一、准备工作确保打印机支持有线或无线(Wi-Fi)网络连接。连接打印机到网络有线连接:用网线将打印机...
- 如何在银河麒麟操作系统上查找并下载软硬件驱动?
-
银河麒麟卓面操作系统如何查找并下载软硬件驱动?后台有些小伙伴都在问怎么下载驱动?实际上麒麟软件官网提供了软硬件驱动下载链接,如何获取?接下来给大家演示如何查找并下载软硬件驱动。·进入麒麟软件官网,点击...
- Wi-Fi总掉线,这个设置要修改!(wi-fi总是掉线)
-
01关闭网卡的省电模式,这是最常见的Wi-Fi掉线元凶,默认开启,操作步骤Win+X→设备管理器,找到“网络适配器”(也可以像下图这样直接搜索打开)→找到你的无线网卡(名称通常带Wir...
- WiFi出现感叹号上不了网怎么办 轻松恢复网络
-
在日常生活中,WiFi已成为不可或缺的一部分。然而,有时我们会遇到WiFi图标上出现了感叹号,无法上网。无论是办公、学习还是娱乐,这种情况都会严重影响体验。这种情况该怎么解决呢?本期驱动哥就给各位介绍...
- 摩尔线程发布图形显卡驱动v300.110
-
IT之家5月20日消息,摩尔线程今日发布版本号为v300.110的图形显卡驱动程序,为游戏玩家和专业用户带来全方位的性能优化与体验提升,特别在3DMark基准测试工具SteelNo...
- 怎么更新电脑网卡驱动 图文教程分享
-
网络连接在现代生活中扮演着重要的角色,而网卡驱动是保证稳定网络连接的关键组成部分。随着技术的不断发展,更新网卡驱动已经成为了一个必要的操作。本文将为您介绍常见的网卡驱动更新方法,帮助您成功解决网卡驱动...
- 柯达Kodak扫描仪i2600驱动及扫描软件下载与安装方法
-
柯达扫描仪I2600驱动及扫描软件的下载与安装方法!有很多的扫描仪我们找驱动的时候不好找,在打印机驱动网里边下载的话也是比较方便的,可以搜索到柯达I2600,我们往下选,这里边也提供了官方的驱动下载,...
- 推荐几款免费驱动软件(免费的驱动)
-
以下是一些免费且值得推荐的驱动程序更新工具,这些软件可以帮助你检测、下载和更新电脑上的驱动程序,确保硬件设备正常运行并保持最新状态:1.360驱动大师轻巧版特点:360安全卫士旗下的产品,界面简洁...
- 适用产品:电脑产品 目录 一、驱动 2 1、电池
-
适用产品:电脑产品目录一、驱动21、电池/电源驱动22、键盘驱动23、摄像头驱动24、触摸板驱动25、快捷键驱动26、USB驱动37、Type-C电源驱动38、其他驱动3二、软件4...
- 手把手教你如何使用免费自动化工具——Appium(安卓版)
-
上次在上传了一篇Appium后,有人来问我有没有Andriod版的安装教程,这个当然有,抱着负责任的心,在上班摸鱼小半天之后,可算是把教程编辑好了准备环境JDKPythonAndriodSDKNod...
- 常见电脑USB遇到故障问题处理方法
-
#什么方法可以改变命运#大家电脑在使用USB存储器的过程中总是会出现这个故障或者那个故障问题,有时候出现无法读取,有时候设备的数据消失了,遇到这个问题是不是非常着急啊,今天教大家自己尝试查看遇到常见u...
- 无法识别的USB设备?怎么解决?(无法识别的usb设备怎么解决代码43)
-
大家有没有遇到过这种问题,就是当你把自己的U盘或者其他USB设备插到电脑上的时候,桌面右下角会弹出一个“无法识别的USB设备”的提示?这会导致该USB设备无法正常使用。如何解决无法识别的USB设备问题...
- 如何调鼠标的灵敏度 快速调节超简单
-
鼠标灵敏度是指鼠标在移动时,指针在屏幕上移动的速度。适当的鼠标灵敏度不仅能够提高工作效率,还能减少手部疲劳,优化游戏体验。那么不同的使用场景,鼠标灵敏度怎么调呢?本文将详细探讨如何调整鼠标灵敏度,以及...