在實際開發中，多模塊項目常會使用Maven進行包管理。在poml文件中進行包依賴時，常存在引入一個jar包中默認依賴了其他的jar包的情況。這樣很容易導致jar包沖突，從而產生一些詭異問題，如版本問題導致的類、方法找不到等。下面我們將聊聊具體關于依賴沖突產生的原因、排查方式以及解決的方案。

[[284204]]

依賴傳遞的概念

舉個簡單例子，比如一個多模塊項目依賴關系如下圖。其中bepe-dal引入了common-lib，當bepe-manager模塊中引入bepe-dal時，common-lib這個依賴也會被引入到bepe-manager模塊中，這個就是依賴傳遞。

依賴沖突的概念

依賴沖突指當模塊中引入很多jar包時，如果其中存在著groupId和artifactId 一樣，但是version不一樣的兩個jar包，這就是依賴沖突。那么在應用時會選用哪一個version呢?這就是我們接下來要討論的沖突解決方式。

[[284206]]

依賴沖突該是怎么解決的?

• 最短路徑原則
• 聲明優先原則
• 依賴排除

1. 最短路徑原則

當存在groupId和artifactId一致但是version不一致的jar包沖突時，模塊會自動選擇距離自己路徑短的包。如：bepe-manager到common-lib(1.0)的距離為2，bepe-manager到common-lib(2.0)的距離為1，就會選擇距離短的common-lib(2.0)，這就是最短路徑原則。

2. 聲明優先原則

當沖突包路徑距離長度一樣時，這個時候就會依據其在pom文件中聲明的先后順序。

在manager模塊pom.xml中，如果先引用bepe-common，就會用2.0版本的common-lib。

<dependency>  
 <groupId>com.company.bepe</groupId>  
 <artifactId>bepe-common</artifactId>  
 <version>2.2</version>  
</dependency>  
<dependency>  
 <groupId>om.company.bepe</groupId>  
 <artifactId>bepe-dal</artifactId>  
 <version>2.2</version>  
</dependency>  

3. 依賴排除

通過標簽將不需要依賴的包進行排除，通過這種方式我們就靈活進行取舍。但是該如何發現沖突呢?接下來將討論關于依賴沖突排查的方式。

依賴沖突情況該怎么排查?

我們可以借助一些插件工具幫助找出沖突jar的具體位置。下面分享一下我在項目中排查并解決包沖突的兩種方式。

• maven-enforcer-plugin 插件
• Maven Helper 插件

1. maven-enforcer-plugin插件

Maven提供了Maven-Enforcer-Plugin插件 , 用來校驗約定遵守情況，比依賴 jar 包的版本等等。當規則檢查不通過的時候則會構建失敗。

(1) 在pom.xml中引入該插件

rules內則是定義校驗規則，通過配置可實現重復依賴檢測。也支持自定義做一些其他檢驗如版本檢驗等。關于maven-enforcer-plugin插件rules的其他配置用法，感興趣的朋友們，可以去查閱其相關的資料。

<rules> 
            <requireMavenVersion> 
                <version>3.0.4</version> 
            </requireMavenVersion> 
            <!--要求JDK版本)--> 
            <requireJavaVersion> 
                <version>6.0</version> 
            </requireJavaVersion> 
            <bannedDependencies> 
                <!--是否檢查傳遞性依賴(間接依賴)--> 
                <searchTransitive>true</searchTransitive> 
                <excludes> 
                    <exclude>junit:junit</exclude> 
                </excludes> 
                <message>must use TestNG</message> 
            </bannedDependencies> 
        </rules> 

(2) 配置好插件后進行項目構建，當存在包沖突時會在console中打印出來。

(3) 依據信息便可將不需要的jar包通過排除掉。

2. Maven Helper

使用IntelliJ IDE的Maven helper插件方便找到和排除沖突的依賴項

(1) command+, 打開工具的設置窗口

(2) 設置搜索中輸入plugin

(3) 在Marketplace table頁面中搜索Maven Helper，并安裝

(4) 重啟后即可使用，打開pom文件后，文件下面會多出Dependency Analyzer這一個tab，進入Dependency Analyzer視圖之后有三個查看選項，分別是Conflicts(沖突)、All Dependencies as List(列表形式查看所有依賴)、All Dependencies as Tree(樹結構查看所有依賴)。通過查看信息后再做出對應的依賴沖突處理。

總結

關于依賴沖突解決方式有三種：最短路徑原則、聲明優先原則、依賴排除。在沒有手動進行依賴排除的情況下，會依據最短路徑原則、聲明優先原則來選擇jar包。關于依賴沖突排查可借助如maven-enforcer-plugin 與Maven Helper 插件。根據實際情況及環境，選擇組合最優的解決方案解決依賴沖突問題。