1、簡介

1.1、什么是依賴沖突

依賴沖突是指：在 Maven 項(xiàng)目中，當(dāng)多個(gè)依賴包，引入了同一份類庫的不同版本時(shí)，可能會(huì)導(dǎo)致編譯錯(cuò)誤或運(yùn)行時(shí)異常。

1.2、依賴沖突的原因

我們?cè)?nbsp;Maven 項(xiàng)目的 Pom 中 一般會(huì)引用許許多多的 Dependency。例如，項(xiàng)目A有這樣的依賴關(guān)系：

A -> C -> X(1.0)
B -> D -> X(2.0)

X是A的 傳遞性依賴 ，但是兩條依賴路徑上有兩個(gè)版本的X,那么哪個(gè)X會(huì)被 Maven 解析使用呢? 兩個(gè)版本都被解析顯然是不對(duì)的，因?yàn)槟菚?huì)造成依賴重復(fù)，因此必須選擇一個(gè)。

在絕對(duì)大多數(shù)情況下，依賴沖突問題并不需要我們考慮，Maven 工具會(huì)自動(dòng)根絕依賴原則選擇，這里我們先假設(shè)最終引用的 X(1.0) 版本，

1、你想如果B引用 X(2.0) 的新創(chuàng)建的類，但因?yàn)樽罱K被解析的是 X(1.0)，所以就會(huì)出現(xiàn)很典型的 NoClassDefFoundError 或 ClassNotFoundException 依賴沖突報(bào)錯(cuò)。

2、如果B引用 X(2.0) 的新創(chuàng)建的方法，但因?yàn)樽罱K被解析的是 X(1.0)，所以就會(huì)拋出 NoSuchMethodError 系統(tǒng)異常。

但換種角度，如果最終解析的是 X(2.0)，就沒問題了嗎？

1、如果 X(2.0) 刪掉了 X(1.0) 的一些類，但A已經(jīng)引用了，同樣也會(huì)報(bào) NoClassDefFoundError 或者 ClassNotFoundException 錯(cuò)誤。

2、如果 X(2.0) 刪掉了 X(1.0) 的一些方法，但A已經(jīng)引用了，同樣也會(huì)報(bào) NoSuchMethodError 錯(cuò)誤。

所以說具體問題還需具體分析，到底采用哪個(gè)版本還需要看實(shí)際項(xiàng)目。也可能我們需要升級(jí)對(duì)應(yīng)的A或者B的版本才能解決問題。

2、Maven 依賴原則

2.1、層級(jí)優(yōu)先原則(路徑最近者優(yōu)先)

在同一個(gè) Pom 內(nèi)，相同 Jar 不同版本，根據(jù)依賴的路徑長短來決定引入哪個(gè)依賴。

舉例

依賴鏈路一：A -> B -> C -> X(1.0)
依賴鏈路二：F -> D -> X(2.0)

該例中 X(1.0) 的路徑長度為3,而 X(2.0) 的路徑長度為2,因此 X(2.0) 會(huì)被解析使用。依賴調(diào)解第一原則不能解決所有問題，比如這樣的依賴關(guān)系：

A -> B -> Y(1.0)
c -> D -> Y(2.0)

Y(1.0) 和 Y(2.0) 的依賴路徑長度是一樣的，都為2。Maven 定義了依賴調(diào)解的第二原則：

2.2、聲明優(yōu)先原則(第一聲明者優(yōu)先)

在依賴路徑長度相等的前提下，在同一個(gè) Pom 中，間接依賴聲明的順序決定了誰會(huì)被解析使用，順序最前的那個(gè)依賴優(yōu)勝。該例中，如果A的依賴聲明在C之前，那么 Y (1.0) 就會(huì)被解析使用.

比如 我在 demo01 中引入了 demo02 和 demo03，demo02 和 demo03 都引入了 Lombok 的依賴

圖片

demo02 和 demo03 換個(gè)順序

圖片

2.3、特殊情況

• 子Pom內(nèi)聲明的優(yōu)先于父 Pom 中的依賴。
• 同Pom內(nèi)出現(xiàn)不同版本的相同類庫時(shí)，后聲明的會(huì)覆蓋先聲明的。也就是在同一個(gè)Pom里配置了相同資源的不同版本的直接依賴，后配置的覆蓋先配置的。比如下邊這個(gè)例子

圖片

• 調(diào)換下順序就是引用的4.12的依賴。

圖片

3、如何排除依賴

我們先來解釋下什么是傳遞性依賴

3.1、什么是傳遞性依賴

比如當(dāng)我們項(xiàng)目中，引用了A的依賴,A的依賴通常又會(huì)引入B的 Jar 包，B可能還會(huì)引入C的 Jar 包。

這樣，當(dāng)你在 pom.xml 文件中添加了A的依賴，Maven 會(huì)自動(dòng)的幫你把所有相關(guān)的依賴都添加進(jìn)來。

就這樣一層層的，Maven 會(huì)自動(dòng)的幫你把所有相關(guān)的依賴都添加進(jìn)來。傳遞性依賴會(huì)給項(xiàng)目引入很多依賴，簡化項(xiàng)目依賴管理，但是也會(huì)帶來問題。

最明顯的就是容易發(fā)生依賴沖突。

3.2、如何排除依賴

這種情況下，想要解決依賴沖突，可以靠升級(jí)/降級(jí)某些依賴項(xiàng)的版本，從而讓不同依賴引入的同一類庫，保持一致的版本號(hào)。另外，還可以通過隱藏依賴、或者排除特定的依賴項(xiàng)來解決問題。

3.2.1、<exclusions>標(biāo)簽

Exclusions是主動(dòng)斷開依賴的資源，被排除的資源無需指定版本—指不需要

也就是說可以包含一個(gè)或者多 Exclusion 子元素，因此可以排除一個(gè)或者多個(gè)傳遞性依賴。需要注意的是，聲明 Exclusion 的時(shí)候只需要 Groupld 和 Artifactld ,而不需要要 Version 元素。

用法示例：

<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-web</artifactId>
  <version>5.1.8.RELEASE</version>
  <exclusions>
    <!-- 排除web包依賴的beans包 -->
    <exclusion>
      <groupId>org.springframework</groupId>
      <artifactId>spring-beans</artifactId>
    </exclusion>
  </exclusions>
</dependency>

3.2.2、<optional>標(biāo)簽

該標(biāo)簽即是“隱藏依賴”的開關(guān),指對(duì)外隱藏當(dāng)前所依賴的資源---指不透明：

• true：開啟隱藏，當(dāng)前依賴不會(huì)向其他工程傳遞，只保留給自己用；
• false：默認(rèn)值，表示當(dāng)前依賴會(huì)保持傳遞性，其他引入當(dāng)前工程的項(xiàng)目會(huì)間接依賴。

用法示例：
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-aop</artifactId>
  <version>5.1.8.RELEASE</version>
  <optional>true</optional>
</dependency>

3.2.2.1、上邊兩種<exclusions>標(biāo)簽和``<optional>標(biāo)簽的區(qū)別

• A依賴B,B依賴C , C 通過依賴傳遞會(huì)被 A 使用到，現(xiàn)在要想辦法讓 A 不去依賴 C
• 可選依賴是在B上設(shè)置 <optional> , A 不知道有 C 的存在，代表這個(gè)依賴是否需要被發(fā)現(xiàn)。這種適用于**可以修改B的配置文件的情況下**** 先看默認(rèn)情況，也就是false

圖片

• 改為 true 后

圖片

• 排除依賴是在A上設(shè)置 <exclusions> , A 知道有 C 的存在，主動(dòng)將其排除掉。代表這個(gè)依賴已經(jīng)被發(fā)現(xiàn)，但自己是否需要引用。這種適用于不能修改B的配置文件的情況下

圖片

3.2.3、Maven 聚合工程 統(tǒng)一管理版本

聚合工程，即是指：一個(gè)項(xiàng)目允許創(chuàng)建多個(gè)子模塊，多個(gè)子模塊組成一個(gè)整體，可以統(tǒng)一進(jìn)行項(xiàng)目的構(gòu)建。要弄明白聚合工程，得先清楚“父子工程”的概念：

• 父工程：不具備任何代碼、僅有pom.xml的空項(xiàng)目，用來定義公共依賴、插件和配置；
• 子工程：編寫具體代碼的子項(xiàng)目，可以繼承父工程的配置、依賴項(xiàng)，還可以獨(dú)立拓展。

而Maven聚合工程，就是基于父子工程結(jié)構(gòu)，來將一個(gè)完整項(xiàng)目，劃分出不同的層次，這種方式可以很好的管理多模塊之間的依賴關(guān)系，以及構(gòu)建順序，大大提高了開發(fā)效率、維護(hù)性。

為了防止不同子工程引入不同版本的依賴，在父工程中，統(tǒng)一對(duì)依賴的版本進(jìn)行控制，規(guī)定所有子工程都使用同一版本的依賴，可以使用<dependencyManagement>標(biāo)簽來管理。

• <dependencies>：定義強(qiáng)制性依賴，寫在該標(biāo)簽里的依賴項(xiàng)，子工程必須強(qiáng)制繼承；
• <dependencyManagement>：定義可選性依賴，該標(biāo)簽里的依賴項(xiàng)，子工程可選擇使用。

子工程在使用<dependencyManagement>中已有的依賴項(xiàng)時(shí)，不需要寫<version>版本號(hào)，版本號(hào)在父工程中統(tǒng)一管理，這樣做的好處在于：以后為項(xiàng)目的技術(shù)棧升級(jí)版本時(shí)，不需要單獨(dú)修改每個(gè)子工程的POM，只需要修改父POM文件即可，減少了版本沖突的可能性。

4、Maven Helper 插件分析jar包沖突

如果你的項(xiàng)目中依賴許許多多的 Jar ，肉眼排查就沒那么方便了，這里推薦一個(gè) Maven 管理插件

圖片

在 Pom 文件中看到 Dependency Analyzer標(biāo)志，說明 Maven Helper 插件就安裝成功了。

圖片

點(diǎn)擊 Dependency Analyzer 之后就會(huì)進(jìn)入到下面的頁面

圖片

從圖中可以看出有哪些jar存在沖突，存在沖突的情況下最終采用了哪個(gè)依賴的版本。標(biāo)紅的就是沖突版本，白色的是當(dāng)前的解析版本。

如果我們想保留標(biāo)紅的版本，那我們可以標(biāo)白區(qū)域右擊選擇排除(Exclude)即可。

5、總結(jié)

一般我們?cè)诮鉀Q依賴沖突的時(shí)候，都會(huì)選擇保留jar高的版本，因?yàn)榇蟛糠謏ar在升級(jí)的時(shí)候都會(huì)做到向下兼容，所以只要保留高的版本就不會(huì)有什么問題。

但是有些包，版本變化大沒法去做向下兼容，高版本刪了低版本的某些類或者某些方法，那么這個(gè)時(shí)候就不能一股腦的去選擇高版本，但也不能選擇低版本。

就比如下面這個(gè)案例

依賴鏈路一：A -> B -> C -> X(1.0)
依賴鏈路二：F -> D -> X(2.0)

X(2.0) 沒有對(duì) X(1.0) 做向下兼容也就是說可能存在排除哪個(gè)都不行，那怎么辦我們只能考慮升級(jí)A的版本或者降低F的版本。比如A升級(jí)到A(2.0),使它依賴的X版本變成X(2.0)這樣的話就解決依賴沖突。

但話有說回來 A升級(jí)到A(2.0) 可能會(huì)影響許許多多的地方，比如自己項(xiàng)目中代碼是否需要改變，或者因?yàn)?A升級(jí)到A(2.0) 導(dǎo)致 B和C的版本有所改變，這些影響點(diǎn)都需要我們?nèi)タ紤]的。所以說為什么說一個(gè)大型項(xiàng)目穩(wěn)定后，Pom文件的升級(jí)是件繁瑣的事情，那是因?yàn)榭紤]的東西是在太多了，稍有不慎就會(huì)因?yàn)橐蕾嚊_突而導(dǎo)致系統(tǒng)報(bào)錯(cuò)。