Maven提高篇系列之（五）——處理依賴沖突

 

這是一個Maven提高篇的系列，包含有以下文章：

 

1. Maven提高篇系列之（一）——多模塊 vs 繼承
2. Maven提高篇系列之（二）——配置Plugin到某個Phase（以Selenium集成測試為例）
3. Maven提高篇系列之（三）——使用自己的Repository(Nexus)
4. Maven提高篇系列之（四）——使用Profile
5. Maven提高篇系列之（五）——處理依賴沖突
6. Maven提高篇系列之（六）——編寫自己的Plugin（本系列完）

 

  

在本系列的上一篇文章中，我們講到了如何使用Profile，在本文中，我們將講到如何處理Maven的依賴沖突。

 

不知道你在使用Maven時是否遇到過諸如"NoSuchMethodError"或"ClassNotFoundException"之類的問題，甚至發生這些問題的Java類你沒都沒有聽說過。要搞清楚這里面的緣由，我們得學習Maven對依賴沖突的處理機制。

 

Maven采用“最近獲勝策略（nearest wins strategy）”的方式處理依賴沖突，即如果一個項目最終依賴於相同artifact的多個版本，在依賴樹中離項目最近的那個版本將被使用。讓我們來看看一個實際的例子。

 

請下載本文的github源代碼：https://github.com/davenkin/maven-dependency-conflict-demo

 

我們有一個web應用resolve-web，該工程依賴於project-A和project-B，project-A依賴於project-common的1.0版本並調用其中的sayHello()方法。project-B依賴於project-C，而project-C又進一步依賴於project-common的2.0版本並調用其中的sayGoodBye()方法。project-common的1.0和2.0版本是不同的，1.0中之包含sayHello()方法，而2.0中包含了sayHello()和sayGoodBye()兩個方法。整個項目的依賴關系如下圖：

 

 

根據Maven的transitive依賴機制，resolve-web將同時依賴於project-common的1.0和2.0版本，這就造成了依賴沖突。而根據最近獲勝策略，Maven將選擇project-common的1.0版本作為最終的依賴。這和Gradle不同，Gradle在默認情況下將選擇最新的版本作為獲勝版本。而對於Maven，由於proejct-common的1.0版本比2.0版本在依賴樹中離resolve-web更近，故1.0版本獲勝。在resolve-web中執行"mvn dependency:tree -Dverbose"可以看到resolve-web的依賴關系：

 

[INFO] resolve-web:resolve-web:war:1.0-SNAPSHOT

[INFO] +- junit:junit:jar:3.8.1:test

[INFO] +- project-B:project-B:jar:1.0:compile

[INFO] |  \- project-C:project-C:jar:1.0:compile

[INFO] |     \- (project-common:project-commmon:jar:2.0:compile - omitted for conflict with 1.0)

[INFO] +- project-A:project-A:jar:1.0:compile

[INFO] |  \- project-common:project-commmon:jar:1.0:compile

[INFO] \- javax.servlet:servlet-api:jar:2.4:provided

 

 

由上可知，project-common:project-commmon:jar:2.0被忽略掉了。此時在resolve-web的war包中將只包含project-common的1.0版本，於是問題來了。由於project-common的1.0版本中不包含sayGoodBye()方法，而該方法正是project-C所需要的，所以運行時將出現“NoSuchMethodError”。（請根據本文github工程中的README.md中的步驟重現該錯誤信息。）

 

對於這種有依賴沖突所導致的問題，我們有兩種解決方法。

 

方法1：顯式加入對project-common 2.0版本的依賴。先前的2.0版本不是離resolve-web遠了點嗎，那我們就直接將它作為resolve-web的依賴，這不就比1.0版本離resolve-web還近嗎？在resove-web的pom.xml文件中直接加上對project-common 2.0 的依賴：

 

<dependency>       
   <groupId>project-common</groupId>      
   <artifactId>project-commmon</artifactId>  
   <version>2.0</version>   
</dependency>  

 

方法2：resolve-web對project-A的dependency聲明中，將project-common排除掉。在resolve-web的pom.xml文件中修改對project-A的dependency聲明：

 

<dependency>  
          <groupId>project-A</groupId>  
          <artifactId>project-A</artifactId>  
          <version>1.0</version>  
          <exclusions>  
              <exclusion>  
                  <groupId>project-common</groupId>  
                  <artifactId>project-commmon</artifactId>  
              </exclusion>  
          </exclusions>  
</dependency>  

 

此時再在resolve-web中執行"mvn dependency:tree -Dverbose"，結果如下：

 

......

[INFO] resolve-web:resolve-web:war:1.0-SNAPSHOT

[INFO] +- junit:junit:jar:3.8.1:test

[INFO] +- project-B:project-B:jar:1.0:compile

[INFO] |  \- project-C:project-C:jar:1.0:compile

[INFO] |     \- project-common:project-commmon:jar:2.0:compile

[INFO] +- project-A:project-A:jar:1.0:compile

[INFO] \- javax.servlet:servlet-api:jar:2.4:provided

......

 

此時的依賴樹中已經不包含project-common的1.0版本了。

 

另外，我們還可以在project-A中將對project-common的依賴聲明為optional，optional即表示非transitive，此時當在resolve-web中引用project-A時，Maven並不會將project-common作為transitive依賴自動加入，除非有別的項目（比如project-B）聲明了對project-common的transitive依賴或者我們在resolve-web中顯式聲明對project-common的依賴（方法一）。

 

在下一篇文章中，我們將講到如何編寫自己的Plugin。