一、引言
“老婆”和“媽媽”同時掉進水里览爵，先救誰？
常言道：編碼五分鐘镇饮，解沖突兩小時蜓竹。作為Java開發(fā)來說，第一眼見到ClassNotFoundException储藐、NoSuchMethodException這些異常來說俱济，第一反應(yīng)就是排包。經(jīng)過一通常規(guī)和非常規(guī)操作以后钙勃，往往會找到同一個Jar包引入了多個不同的版本蛛碌，這時候一般排除掉低版本、保留高版本就可以了辖源，這是因為一般Jar包都是向下兼容的蔚携。但是，如果出現(xiàn)版本不兼容的情況的時候克饶，就會陷入“老婆和媽同時掉進水里酝蜒，先救誰”的兩難境地，如果恰恰這種不兼容發(fā)生在中間件依賴和業(yè)務(wù)自身依賴之間矾湃，那就更難了亡脑。
如下圖所示，Project表示我們的項目邀跃，Dependency A表示我們的業(yè)務(wù)依賴霉咨，Dependency B表示中間件依賴，如果業(yè)務(wù)依賴和中間件依賴都依賴同一個Jar包C坞嘀，但是版本卻不一樣躯护，分別為0.1版本和0.2版本惊来，而且最不巧的是這兩個版本還存在沖突丽涩，有些老的功能只在0.1低版本中存在，有些新功能只在0.2高版本中存在，真是“老婆和媽同時掉進水里矢渊，先救誰都不行”继准。
（圖片摘自：SOFAArk官網(wǎng)）
俗話說：沒有遇到過Jar包沖突的開發(fā)，一定是個假Java開發(fā)矮男；沒有解決過Jar包沖突的開發(fā)移必，不是一個合格的Java開發(fā)。在最近的項目里毡鉴，我們需要使用Guava的高版本Jar包崔泵，但是發(fā)現(xiàn)中間件依賴的是低版本且與高版本不兼容的Jar包，面對這種兩難猪瞬，我們肯定是“老婆”和“媽媽”都要救憎瘸，于是我們開始尋求解決方案。
二陈瘦、不兼容依賴沖突解決方案
“老婆”和“媽媽”都要救幌甘，怎么救？
首先痊项，我們想到的是锅风，能不能把需要用到的Guava高版本的代碼拷出來直接放到我們的工程中去，但是這樣做會帶來幾個問題：
- Guava作為一個功能豐富的基礎(chǔ)庫鞍泉，某一部分的代碼往往與其他很多代碼都存在依賴關(guān)系皱埠，這會造成牽一發(fā)而動全身，工作量會比預(yù)想的要大很多咖驮；
- 拷貝出來的代碼只能自己手動維護漱逸，如果官方修復(fù)了問題或者重構(gòu)了代碼或者增加了功能，我們想要升級的話游沿，那么只能重頭再來一遍饰抒。于是，我們只能另外想其他的方案诀黍，這個只能作為最后的兜底方案袋坑。
然后，我們在想眯勾，一個Java類被加載到JVM虛擬機里區(qū)別于另一個Class枣宫，其一是它們倆全路徑不一樣，是風馬牛不相及的兩個不同的類吃环，但卻是被不同的類加載器加載的也颤，在JVM虛擬機里它們?nèi)匀槐徽J為是兩個不同的Class。所以郁轻，我們就在想從類加載器上來尋求解決方案翅娶。在阿里巴巴內(nèi)部文留，有一個Pandora的組件，正如其名就像一個魔盒竭沫，它會把中間件的依賴都裝到Pandora里（內(nèi)部叫做Sar包）燥翅，這樣的話，就能避免在中間件和業(yè)務(wù)代碼直接出現(xiàn)“老婆和媽同時掉進水里蜕提，先救誰”的兩難境地森书。
同樣，在類似的場景比如應(yīng)用合并部署也能發(fā)揮威力谎势。但是Pandora只在阿里內(nèi)部使用并未開源凛膏。在螞蟻金服，也有一個這樣的組件脏榆，并且開源了译柏，叫做SOFAArk（官方網(wǎng)址，感興趣的可以去官網(wǎng)了解SOFAArk的原理和使用）姐霍，我們感覺已經(jīng)找到了那個Mr.Right鄙麦，于是我們開始研究SOFAArk如何使用。和Pandora一樣镊折，SOFAArk也是通過使用不同的 ClassLoader 加載不同版本的三方依賴胯府，進而隔離類，徹底解決包沖突的問題恨胚，這就要求我們需要將相關(guān)的依賴打包成Ark Plugin（參見SOFAArk官方文檔）骂因。
對于公司來說，這樣的方案收益是比較大的赃泡，打包成Ark Plugin后整個公司都能夠共享寒波，業(yè)務(wù)方都能受益，但是對于我們一個項目來說升熊，采用這樣的方案無疑過重了俄烁。于是，我們與中間件同學(xué)聯(lián)系级野，詢問是否有計劃引入類似的隔離組件解決中間件和業(yè)務(wù)代碼之間的依賴沖突問題页屠，得到的答復(fù)是公司目前包沖突并不是一個強烈的痛點，暫時沒有計劃引入蓖柔。于是辰企，我們只能暫且擱置SOFAArk，繼續(xù)尋找新的解決方案况鸣。
接著牢贸，我們在想既然Pandora/SOFAArk采用類加載隔離了同一路徑的類，那么如果我們把沖突的兩個版本庫的groupId變得不一樣镐捧，那么即使同名的類全路徑也是不一樣的潜索，這樣在JVM里面必然是不同的Class臭增。如果把Pandora/SOFAArk的隔離方式稱之為邏輯隔離的話，這種就相當于物理隔離了帮辟。要實現(xiàn)這一點，借助IDE的重構(gòu)功能或者全局替換的功能就能比較容易的實現(xiàn)這一點玩焰。
正在我們準備擼起袖子動手干的時候由驹，我們不禁在想，這樣的痛點應(yīng)該早就有人遇到昔园，尤其像Guava、Commons這類的基礎(chǔ)類庫默刚，沖突在所難免甥郑，前人應(yīng)該已經(jīng)找到了優(yōu)雅的撓癢姿勢。于是荤西，我們就去搜索相關(guān)的文章澜搅，果不其然，maven-shade-plugin正是那優(yōu)雅的撓癢姿勢邪锌，這個Maven插件的原理正是將類的包路徑進行重新映射勉躺，達到隔離不兼容Jar包的目的。
三觅丰、maven-shade-plugin解決依賴沖突
最后如何來配置和使用maven-shade-plugin將Guava映射成我們自己定制的Jar包饵溅，實現(xiàn)與中間件Guava的隔離。整個的過程還是比較清晰明了的妇萄，主要是創(chuàng)建一個Maven工程蜕企，引入依賴，配置我們要發(fā)布的倉庫地址冠句，引入編譯打包插件和maven-shade-plugin插件轻掩，配置映射規(guī)則（標簽之間部分），然后編譯打包發(fā)布到Maven倉庫懦底。pom.xml的配置如下：
<?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">
<modelVersion>4.0.0</modelVersion>
<groupId>com.shaded.example</groupId>
<artifactId>guava-wrapper</artifactId>
<version>${guava.wrapper.version}</version>
<name>guava-wrapper</name>
<url>https://example.com/guava-wrapper</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<!- 版本與 guava 版本基本保持一致 ->
<guava.wrapper.version>27.1-jre</guava.wrapper.version>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>27.1-jre</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.3</version>
<configuration>
<source>${maven.compiler.source}</source>
<target>${maven.compiler.target}</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.3.2</version>
<executions>
<execution>
<id>default-jar</id>
<goals>
<goal>jar</goal>
</goals>
<phase>package</phase>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>2.4</version>
<executions>
<execution>
<id>default-sources</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>2.4.1</version>
<configuration>
<createDependencyReducedPom>false</createDependencyReducedPom>
</configuration>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<!-- 重命名規(guī)則配置 -->
<relocations>
<relocation>
<!-- 源包路徑 -->
<pattern>com.google.guava</pattern>
<!-- 目標包路徑 -->
<shadedPattern>com.google.guava.wrapper</shadedPattern>
</relocation>
<relocation>
<pattern>com.google.common</pattern>
<shadedPattern>com.google.common.wrapper</shadedPattern>
</relocation>
<relocation>
<pattern>com.google.thirdparty</pattern>
<shadedPattern>com.google.wrapper.thirdparty</shadedPattern>
</relocation>
</relocations>
<transformers>
<transformer
implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"/>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<distributionManagement>
<!- Maven倉庫配置放典，略 ->
</distributionManagement>
</project>
項目引入這個新打包的guava-wrapper后，import選擇從這個包導(dǎo)入我們需要的相關(guān)類即可基茵。如下：
<dependency>
<groupId>com.vivo.internet</groupId>
<artifactId>guava-wrapper</artifactId>
<version>27.1-jre</version>
</dependency>
四奋构、結(jié)語
為了在同一個項目中使用多個版本不兼容的Jar包，我們首先想到手動自行維護代碼拱层，但是工作量和維護成本很高弥臼，接著我們想到通過類加載器隔離（開源方案SOFAArk），但是需要將相關(guān)依賴都打包成Ark Plugin根灯，解決方案無疑有點過重了径缅，最后通過maven-shade-plugin插件重命名并打包掺栅，優(yōu)雅地解決了項目中不兼容多個版本Jar包的沖突問題。從問題出來纳猪，我們一步一步探尋問題的解決方案氧卧，最終的maven-shade-plugin插件方案雖然看似與手動自行維護代碼本質(zhì)一致，看似回到了原點氏堤，但其實最終的方案優(yōu)雅性遠比最開始高得多沙绝，正如人生的道路那樣，螺旋式上升鼠锈，曲線式前進闪檬。
如果遇到類似需要支持版本不兼容Jar包共存的場景，可以考慮使用maven-shade-plugin插件购笆，這種方法比較輕量級粗悯，可用于項目中存在個別不兼容Jar包沖突的場景，簡單有效同欠，成本也很低样傍。但是，如果Jar包沖突現(xiàn)象比較普遍铺遂，已成為明顯或者普遍的痛點铭乾，還是建議考慮文中提到的類似Pandora、SOFAArk等類加載器隔離的方案娃循。
作者：vivo互聯(lián)網(wǎng)服務(wù)器團隊-Zhang Wei
