實際上手體驗maven面對衝突Jar包的載入規則

這篇文章主要記錄了本次遇到的問題：即maven在面對不同版本的jar包在pom文件中同時聲明會存在載入覆蓋的問題，於是通過查詢網上相關資料對maven包的載入規則介紹，並通過實際場景對其進行分析驗證 ...

一、問題背景

相信大家在日常的開發過程中都遇到過Jar包衝突的問題，emm，在最近處理業務需求時我也遇到了不同版本jar包衝突導致項目載入出錯的問題。主要是一個完整的項目會不可避免的使用第三方的Jar包來實現功能開發，各種第三方包之間可能會存在依賴關係，不同版本的依賴就會可能導致依賴間的相互衝突，進而導致整個項目載入的失敗。

這篇文章主要記錄了本次遇到的問題：即maven在面對不同版本的jar包在pom文件中同時聲明會存在載入覆蓋的問題，於是通過查詢網上相關資料對maven包的載入規則介紹，並通過實際場景對其進行分析驗證；

二、maven載入原則

1.最短路徑原則：面對多級（兩級及以上）的不同依賴，會優先選擇路徑最短的依賴；

2.聲明優先原則：面對多級（兩級及以上）的同級依賴，先聲明的依賴會覆蓋後聲明的依賴；

3.同級依賴中，後聲明的依賴會覆蓋先聲明的依賴；

三、本地驗證maven載入原則

1.最短路徑原則：使用最短路徑載入的前提是，項目中存在兩級以上的不同依賴jar包，此時項目會優先載入路徑最短的jar包；

◦實例驗證： 分別在common模塊和service模塊中間接和直接的引入不同版本的elasticsearch-rest-client，觀察項目中面對不同路徑長度情況下實際載入時所使用的版本情況。

▪common模塊： 在common模塊中引入elasticsearch-rest-high-level-client 依賴包，而該依賴包它引入了 elasticsearch-rest-client 7.4.2， 從而實現在common模塊中間接引用該包；

common的pom文件：

    <dependencies>
        <dependency>
            <groupId>org.elasticsearch.client</groupId>
            <artifactId>elasticsearch-rest-high-level-client</artifactId>
            <version>7.4.2</version>
        </dependency>
    </dependencies>

▪service模塊： 為了驗證不同路徑長度下maven的包載入順序，我們在service模塊中直接引入elasticsearch-rest-client 6.8.13；

service的pom文件：

    <dependencies>
        <dependency>
            <groupId>org.elasticsearch.client</groupId>
            <artifactId>elasticsearch-rest-client</artifactId>
            <version>6.8.13</version>
        </dependency>
    </dependencies>

▪實際載入結果：在IDEA中載入pom文件時，可以在maven管理中看到已經提示jar包衝突；

▪mvn dependency：tree：我們可以通過mvn dependency ：tree命令來查看該項目的依賴樹，觀察發現實際載入的版本是elasticsearch-rest-client 6.8.13，符合maven中的最短路徑優先原則；

聲明優先原則：聲明優先原則的前提是對於兩級以上的同級依賴，先聲明的依賴會覆蓋後聲明的依賴包；

◦實例驗證： 針對該原則的驗證場景構造不再關註模塊是否直接或者間接引用不同版本的es，我們在common模塊和service模塊中都直接引用不同版本的es，然後通過改變兩個模塊在pom文件中聲明的先後順序來觀察項目啟動後實際載入的jar包；

▪common模塊：在common模塊中直接引入依賴包elasticsearch-rest-client 7.4.2

    <dependencies>
        <dependency>
            <groupId>org.elasticsearch.client</groupId>
            <artifactId>elasticsearch-rest-client</artifactId>
            <version>7.4.2</version>
        </dependency>
    </dependencies>

▪service模塊：在service模塊中引入依賴包elasticsearch-rest-client 6.8.13

    <dependencies>
        <dependency>
            <groupId>org.elasticsearch.client</groupId>
            <artifactId>elasticsearch-rest-client</artifactId>
            <version>6.8.13</version>
        </dependency>
    </dependencies>

◦實際載入結果：

▪場景1：我們將common模塊在pom文件中先引入，然後將在service模塊置於common模塊後面引入，觀察項目實際載入情況；

    <dependencies>
        <dependency>
            <groupId>org.example</groupId>
            <artifactId>backend_common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

        <dependency>
            <groupId>org.example</groupId>
            <artifactId>backend_service</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

▪觀察載入結果圖，發現實際載入的是es-rest-client 7.4.2，即確實是common模塊的聲明生效，service模塊後聲明導致其中的es未被載入。符合聲明優先原則；

◦場景2：我們將service模塊在pom文件中先引入，然後將在common模塊置於service模塊後面引入，觀察項目實際載入情況；；

    <dependencies>
         <dependency>
            <groupId>org.example</groupId>
            <artifactId>backend_service</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.example</groupId>
            <artifactId>backend_common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

▪觀察項目實際載入結果圖，發現實際載入的是es-rest-client 6.8.13，即確實是模塊的聲明生效，common模塊後聲明導致其中的es未被載入。發現符合聲明優先原則；

◦聲明優先原則場景驗證結束；

3. 同級依賴中後載入覆蓋先載入原則；

◦實例驗證： 為了構造在同級依賴中的載入場景，我們在項目中直接引入兩個不同es版本的依賴，然後同樣通過改變兩個es版本在pom中的聲明順序來觀察項目實際載入的es版本。

▪場景1：我們首先驗證client 7.4.2依賴包在client 6.8.13之前聲明的情況；

    <dependencies>
        <dependency>
            <groupId>org.elasticsearch.client</groupId>
            <artifactId>elasticsearch-rest-client</artifactId>
            <version>7.4.2</version>
        </dependency>

        <dependency>
            <groupId>org.elasticsearch.client</groupId>
            <artifactId>elasticsearch-rest-client</artifactId>
            <version>6.8.13</version>
        </dependency>
    </dependencies>

▪觀察maven的實際載入結果如下，發現項目中實際載入的es-rest-client 版本是6.8.13，先聲明的7.4.2版本並未實際載入到項目中。符合同級依賴中後載入覆蓋先載入原則。

▪場景2：然後我們改變聲明順序，將client 6.8.13依賴包在client 7.4.2之前聲明；

    <dependencies>
        <dependency>
            <groupId>org.elasticsearch.client</groupId>
            <artifactId>elasticsearch-rest-client</artifactId>
            <version>6.8.13</version>
        </dependency>

        <dependency>
            <groupId>org.elasticsearch.client</groupId>
            <artifactId>elasticsearch-rest-client</artifactId>
            <version>7.4.2</version>
        </dependency>
    </dependencies>

▪觀察maven實際載入結果如下，發現項目中實際載入的es-rest-client 版本是7.4.2，先聲明的6.8.13版本並未實際載入到項目中。符合同級依賴中後載入覆蓋先載入原則。