如何避免多个jar通过maven打包成jar,同名配置文件发生覆盖问题
ninehua 2024-12-13 15:33 13 浏览
前言
不知道大家在开发的过程中,有没有遇到这种场景,外部的项目想访问内部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制作交互文档?
相关推荐
- Photoshop 2024 v25.7.0[ps 2024最新正式版]中文破解版+安装教程
-
Photoshop2024v25.7.0[ps2024最新正式版]中文破解版+安装教程...
- 和基友合体,骑着基友去战斗!暗黑风砍杀刷宝新游!
-
大家好,这里是每周一更新的《图个好游戏》,我是正惊小弟!又到了我们看图挑游戏的日子,废话不多说,上图!...
- 真能复印钞票吗?纸币复印实战与防伪
-
|责编:王征【中关村在线原创】笔者在测试具有彩色复印功能的产品时,无数人都问过同一个问题,能复印钞票吗?复印的假钞和真品,区别在哪里?ZOL就在这里为您揭开复印假钞的面纱。更希望能够通过我们的努力,...
- 可能从今往后,你想下载的所有资源都不用花钱了
-
文/碎长“楼主好人,一生平安”这是十多年前互联网论坛上最常见的几句回复,如果你也曾是那个时代的用户,相信一定可以秒懂我在说什么。资源分享、免费影视、无损音乐、破解游戏......虽然这些东西如今上不了...
- Adobe Photoshop 2024 Beta 25.9【PS Beta测试版】完整破解版
-
AdobePhotoshop2024Beta25.9【PSBeta测试版】完整破解版...
- 电软回忆录:90年代国内游戏已近绝境,全球游戏行业却在蓬勃发展
-
对于游戏玩家们来说,当年听过最心酸的一句话就是:“国内游戏已近绝境,而全球范围的游戏行业却进入蓬勃兴旺的鼎盛时期。”次时代的降临,让全球的玩家都兴奋不已。然而在国内,游戏这都还没来得及壮大,就已经被扼...
- 裸照一键定制软件疯传网络:每个人都会成为受害者
-
蒙娜丽莎被“一键脱衣”。定制一张裸照需要多长时间?最新的技术只需要30秒。你不需要有高超的PS技术,不必有想象力,也不用知道任何数据或细节。只要有一张个人照片,普通的家用电脑就能制造一张原本不存在的裸...
- Photoshop 最新版PS 2024免破解直装安装包下载+PS 2024图文安装教程
-
AdobePhotoshop2024简称PS2024,是一款由AdobeSystems开发和发行的图像处理软件。Photoshop主要处理以像素所构成的数字图像。AdobePhotoshop...
- 正版PS来了!Adobe全球唯一旗舰店登陆天猫,888元/年
-
说起Photoshop或者Adobe全家桶软件,大家都不陌生吧?我们在学习制图、动画、调音、平面、视频编辑、后期、3D等等都离不开它们。不过经常这款软件的用户应该知道,Adobe旗下的正版软件价格都非...
- 相信我,你会爱上这几个网站的
-
哈喽,大家好啊,我是利兄好久没有分享网站了,今天就给大家安利几个网站。这几个网站都比较实用,可以先收藏哦,说不定哪天你就会用上。...
- 不用花钱买游戏了?索尼PS4全系遭破解:PS5也危险了
-
点击右上方“关注”,第一时间获取科技资讯、技能攻略、产品体验,私信我回复“01”,送你一份玩机技能大礼包。---------------------------------...
- PS神技换头术,学会不要干坏事哦,文末附PS CC2018 下载链接
-
换头术运用:让IU和权志龙合照(同理可以实现和马爸爸合影)警告:仅供技术交流,请勿用于非法用途!(本文没有找到较为合适的权志龙素材,表情不够自然,在素材选取上要尽量贴合原图)...
- 最新版本PS CC软件安装教程及破解方法
-
【最新版本PSCC软件安装教程及破解方法】...