maven-shade使用解決項(xiàng)目版本沖突
背景
當(dāng)我們?cè)趍aven項(xiàng)目中引入第三方組件時(shí),三方組件中的依賴可能會(huì)與項(xiàng)目已有組件發(fā)生沖突。
比如三方組件中依賴httpclient的版本是4.5.x,而項(xiàng)目中已有的httpclient版本是3.1.x,那么此時(shí)就會(huì)產(chǎn)生一下兩種情況:
- 如果用三方組件的高版本httpclient覆蓋原有的低版本httpclient,有可能會(huì)導(dǎo)致原來(lái)項(xiàng)目啟動(dòng)運(yùn)行失敗。即使高版本兼容低版本,也不能允許開發(fā)人員有這樣高風(fēng)險(xiǎn)的操作
- 如果在三方maven依賴中對(duì)其對(duì)依賴的httpclient在引入時(shí)使用進(jìn)行排除,使三方組件使用項(xiàng)目中的低版本httpclient,此時(shí)可能會(huì)因?yàn)榘姹静灰恢聦?dǎo)致三方組件無(wú)法使用
在這樣的情況下我們應(yīng)當(dāng)如何保證不影響項(xiàng)目原有依賴版本的情況下正常使用三方組件呢?此時(shí)可以考慮使用maven-shade-plugin插件
maven-shade-plugin介紹
maven-shade-plugin在maven官方網(wǎng)站中提供的一個(gè)插件,官方文檔中定義其功能如下:
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.
簡(jiǎn)單來(lái)說(shuō)就是將依賴的包在package階段一起打入jar包中,以及對(duì)依賴的jar包進(jìn)行重命名從而達(dá)到隔離的作用。這里為了解決上面的問(wèn)題我們主要使用第二個(gè)功能特性,使得相同依賴不同版本達(dá)到共存的目的。
解決問(wèn)題
1.環(huán)境準(zhǔn)備
這里用fastjson來(lái)模擬使用maven-shade-plugin解決項(xiàng)目中不同版本共存問(wèn)題。原項(xiàng)目此時(shí)使用的是1.1.15版本的fastjson
<!-- 原項(xiàng)目 --> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.1.15</version> </dependency>
假引入一個(gè)三方依賴,該依賴使用1.2.75版本的fastjson
<!-- 將引入依賴 --> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.75</version> </dependency>
2.解決方案
搭建一個(gè)新的模塊rename-dependencies,專門用于存放1.2.75依賴。在pom文件中添加1.2.75的依賴,然后添加maven-shade-plugin插件。rename-dependencies的pom如下
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <groupId>com.sk</groupId> <artifactId>rename-dependencies</artifactId> <version>1.0-SNAPSHOT</version> <modelVersion>4.0.0</modelVersion> <dependencies> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.75</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-shade-plugin</artifactId> <version>3.2.4</version> <executions> <execution> <phase>package</phase> <goals> <goal>shade</goal> </goals> <configuration> <filters> <filter> <artifact>*:*</artifact> <excludes> <exclude>META-INF/*.SF</exclude> <exclude>META-INF/*.DSA</exclude> <exclude>META-INF/*.RSA</exclude> </excludes> </filter> </filters> <relocations> <relocation> <pattern>com.alibaba</pattern> <shadedPattern>shade.com.alibaba</shadedPattern> </relocation> </relocations> </configuration> </execution> </executions> </plugin> </plugins> </build> </project>
從配置文件中可以看到,由于maven-shade-plugin插件在解決這個(gè)問(wèn)題上其實(shí)是通過(guò)對(duì)依賴進(jìn)行重命名而達(dá)到隔離的目的,所以配置主要是集中在relocations中。這里將以com.alibaba開頭的包全部重命名為以shade.com.alibaba開頭。
3.引入依賴
將rename-dependencies進(jìn)行打包,打包好之后在原項(xiàng)目中引入rename-dependencies的依賴。此時(shí)在引入rename-dependencies之后,可以在項(xiàng)目下看到該依賴中的fastjson包名發(fā)生了變化
此時(shí)在代碼中調(diào)用fastjson相關(guān)方法,會(huì)提示選擇所需要包,如下圖,此時(shí)問(wèn)題解決,兩個(gè)版本的fastjson可同時(shí)使用已經(jīng)兼容。
一些需要注意的坑
描述: 引入依賴找不到重命名的shade包
原因:重命名的模塊和需要引入依賴的模塊在一個(gè)項(xiàng)目中,idea優(yōu)先找本項(xiàng)目,所以沒(méi)有走倉(cāng)庫(kù)
解決方案:
將模塊從項(xiàng)目maven中移除,右鍵項(xiàng)目-maven-unlink maven projects
新建一個(gè)項(xiàng)目專門來(lái)做依賴
maven-shade-plugins的其他使用
- 打入和排除指定jar包。maven-shade-plugins還有個(gè)功能就是打入和排除指定的jar包,通過(guò)和指定。
官方配置示例
<project> ... <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-shade-plugin</artifactId> <version>3.2.4</version> <executions> <execution> <phase>package</phase> <goals> <goal>shade</goal> </goals> <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> </execution> </executions> </plugin> </plugins> </build> ... </project>
官方配置示例
<project> ... <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-shade-plugin</artifactId> <version>3.2.4</version> <executions> <execution> <phase>package</phase> <goals> <goal>shade</goal> </goals> <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> </execution> </executions> </plugin> </plugins> </build> ... </project>
- 排除包內(nèi)資源。在上面的pom中使用maven-shade-plugin時(shí),使用來(lái)對(duì)包內(nèi)META-INF下的一些資源進(jìn)行排除。如上面的配置中排除META-INF下的資源文件
<filters> <filter> <artifact>*:*</artifact> <excludes> <exclude>META-INF/*.SF</exclude> <exclude>META-INF/*.DSA</exclude> <exclude>META-INF/*.RSA</exclude> </excludes> </filter> </filters>
到此這篇關(guān)于maven-shade使用解決項(xiàng)目版本沖突的文章就介紹到這了,更多相關(guān)maven-shade版本沖突內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
java calendar 日期實(shí)現(xiàn)不斷加一天的代碼
這篇文章主要介紹了java calendar 日期實(shí)現(xiàn)不斷加一天的代碼,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-10-10SpringBoot之通過(guò)BeanPostProcessor動(dòng)態(tài)注入ID生成器案例詳解
這篇文章主要介紹了SpringBoot之通過(guò)BeanPostProcessor動(dòng)態(tài)注入ID生成器案例詳解,本篇文章通過(guò)簡(jiǎn)要的案例,講解了該項(xiàng)技術(shù)的了解與使用,以下就是詳細(xì)內(nèi)容,需要的朋友可以參考下2021-09-09Springboot實(shí)現(xiàn)Activemq死信隊(duì)列詳解
這篇文章主要介紹了Springboot實(shí)現(xiàn)Activemq死信隊(duì)列詳解,Activemq服務(wù)端配置重新投遞次數(shù)超過(guò)?MaximumRedeliveries?,則會(huì)進(jìn)入死信隊(duì)列,默認(rèn)情況,有一個(gè)死信隊(duì)列:AcitveMQ.DLQ,所有的消息都投遞到此隊(duì)列,包括過(guò)期消息,重投遞失敗消息,需要的朋友可以參考下2023-12-12Spring Security使用Lambda DSL配置流程詳解
Spring Security 5.2 對(duì) Lambda DSL 語(yǔ)法的增強(qiáng),允許使用lambda配置HttpSecurity、ServerHttpSecurity,重要提醒,之前的配置方法仍然有效。lambda的添加旨在提供更大的靈活性,但是用法是可選的。讓我們看一下HttpSecurity的lambda配置與以前的配置樣式相比2023-02-02Java8如何利用Lambda快速生成map、多層嵌套map
這篇文章主要介紹了Java8如何利用Lambda快速生成map、多層嵌套map問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-09-09SpringBoot項(xiàng)目如何訪問(wèn)jsp頁(yè)面的示例代碼
本篇文章主要介紹了SpringBoot項(xiàng)目如何訪問(wèn)jsp頁(yè)面的示例代碼,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-10-10