jar包沖突常用的解決方案

更新時間：2023年12月15日 09:59:00 作者：shyの同學

引言在使用java語言開發(fā),maven做項目管理時,我們經(jīng)常遇到一個頭疼的問題就是jar包沖突,這篇文章主要給大家介紹了關(guān)于jar包沖突常用的解決方案,需要的朋友可以參考下

使用背景

在構(gòu)建工程中，不可避免的引入多方依賴。從jar包沖突產(chǎn)生結(jié)果可大致分為兩類：

1.同一個jar包出現(xiàn)了多個不同的版本。應用選擇了錯誤的版本導致jvm加載不到需要的類或者加載了錯誤版本的類。

2.不同的jar包出現(xiàn)了類路徑一致的類，同樣的類出現(xiàn)在多個不同的依賴jar里，由于jar加載的先后順序?qū)е铝薐VM加載了錯誤版本的類。

maven-enforcer- plugin能夠顯式的在maven構(gòu)建時展現(xiàn)jar包沖突之類的問題。

使用該插件檢查是否有 maven直接/傳遞依賴帶來的jar包沖突,在編譯打包階段可以顯式構(gòu)建失敗。

允許創(chuàng)建一系列規(guī)則強制遵守，包括設(shè)定Java版本、設(shè)定Maven版本、禁止某些依賴、統(tǒng)一jar包版本、禁止 SNAPSHOT快照等等。maven-enforcer-plugin的enforce目標負責檢查規(guī)則，它默認綁定到生命周期的validate階段。當規(guī)則遭到破壞的時候，Maven就會報錯。

除了標準的規(guī)則之外，還可以擴展該插件，編寫自己的規(guī)則。

maven仲裁機制

針對第一個jar包沖突，maven提供了一套仲裁機制來決定使用哪個版本。有以下原則：

1.按照依賴管理元素中指定的版本。此時下面兩個原則無效。

2.路徑最短原則

若是沒有版本申明，按照路徑最短原則，即選擇依賴樹中最短的路徑。

1)加載該jar包的類加載器在jvm類加載器樹結(jié)構(gòu)中所處的層級。

由于jvm的雙親委派機制，層級越高的類加載器越先加載其加載路徑下的類。

即：bootstrap ClassLoader最先加載，其次是extension ClassLoader，最后是system ClassLoader。

2)文檔系統(tǒng)的文檔加載順序。tomcat等容器的classLoader獲取加載路徑下的文檔列表時不排序，依賴于底層的文檔系統(tǒng)返回順序。當不同環(huán)境之間的文檔系統(tǒng)不一致時，就會出現(xiàn)有的環(huán)境沒問題，有的環(huán)境有沖突。

比如：測試和線上環(huán)境不一致導致的問題。

最先聲明原則

若路徑長短一致，則按照第一聲明原則進行仲裁，即選擇pom文件中最先聲明的版本。

使用說明

• 在最終打包運行的應用模塊pom.xml文件中引入maven-enforcer-plugin依賴，模板可參考下方通用模板。

• 運行命令 mvn validate 進行校驗，編譯、打包命令也會觸發(fā)校驗

• 關(guān)閉校驗執(zhí)行命令加入 -Denforcer.skip=true，如：mvn clean validate -Denforcer.skip=true

通用模板

對于具有parent pom 的多模塊應用，在應用模塊的pom.xml中引入依賴。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-enforcer-plugin</artifactId>
            <version>1.4.1</version>
            <executions>
                <execution>
                    <id>enforce</id>
                    <configuration>
                        <rules>
                            <dependencyConvergence/>
                        </rules>
                    </configuration>
                    <goals>
                        <!--執(zhí)行的命令-->
                        <goal>enforce</goal>
                    </goals>
                    <!--執(zhí)行的階段-->
                    <phase>validate</phase>
                </execution>
                <execution>
                    <id>enforce-ban-duplicate-classes</id>
                    <goals>
                        <goal>enforce</goal>
                    </goals>
                    <configuration>
                        <!--規(guī)則-->
                        <rules>
                            <!--banDuplicateClasses規(guī)則 校驗第二種jar包沖突（不同的jar包出現(xiàn)了類路徑一致的類）-->
                            <banDuplicateClasses>
                                <!--忽略校驗的路徑-->
                                <ignoreClasses>
                                    <ignoreClass>javax.*</ignoreClass>
                                    <ignoreClass>org.junit.*</ignoreClass>
                                    <ignoreClass>net.sf.cglib.*</ignoreClass>
                                    <ignoreClass>org.apache.commons.logging.*</ignoreClass>
                                    <ignoreClass>org.springframework.remoting.rmi.RmiInvocationHandler</ignoreClass>
                                </ignoreClasses>
                                <findAllDuplicates>true</findAllDuplicates>
                            </banDuplicateClasses>
                            <!--dependencyConvergence 校驗第一種jar包沖突（同一個jar包出現(xiàn)了多個不同的版本）-->
                            <dependencyConvergence/>
                        </rules>
                        <fail>false</fail>
                    </configuration>
                </execution>
            </executions>
            <dependencies>
                <dependency>
                    <groupId>org.codehaus.mojo</groupId>
                    <artifactId>extra-enforcer-rules</artifactId>
                    <version>1.0-beta-6</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

更多詳細規(guī)則說明參見官網(wǎng)：maven官網(wǎng)

沖突解決

使用exclude將明確不需要的jar進行排除
推薦使用dependencyMangment來管理依賴項，統(tǒng)一項目范圍內(nèi)的依賴版本。
如moduleA和moduleB共同依賴X這個依賴的話，那么可以將X抽取出來，放在父pom中同時設(shè)置其版本號，子pom不需聲明版本號，直接引用的是父pom中的版本。這樣X依賴在升級的時候，不需要分別對moduleA和moduleB模塊中的依賴X進行升級，避免太多地方（moduleC、moduleD…）引用X依賴的時候忘記升級造成jar包沖突。

第一種jar沖突報錯信息：

測試運行 maven validate，enforcer報錯信息如下：

Dependency convergence error for org.slf4j:slf4j-api:1.7.12 paths to dependency are:
+-com.cainiao:boyan-native-test:0.0.1-SNAPSHOT
  +-com.aliyun.opensearch:aliyun-sdk-opensearch:3.1.3
    +-org.slf4j:slf4j-api:1.7.12
and
+-com.cainiao:boyan-native-test:0.0.1-SNAPSHOT
  +-org.springframework.boot:spring-boot-starter:2.2.5.RELEASE
    +-org.springframework.boot:spring-boot-starter-logging:2.2.5.RELEASE
      +-ch.qos.logback:logback-classic:1.2.3
        +-org.slf4j:slf4j-api:1.7.12
and
+-com.cainiao:boyan-native-test:0.0.1-SNAPSHOT
  +-org.springframework.boot:spring-boot-starter:2.2.5.RELEASE
    +-org.springframework.boot:spring-boot-starter-logging:2.2.5.RELEASE
      +-org.apache.logging.log4j:log4j-to-slf4j:2.12.1
        +-org.slf4j:slf4j-api:1.7.25
and
+-com.cainiao:boyan-native-test:0.0.1-SNAPSHOT
  +-org.springframework.boot:spring-boot-starter:2.2.5.RELEASE
    +-org.springframework.boot:spring-boot-starter-logging:2.2.5.RELEASE
      +-org.slf4j:jul-to-slf4j:1.7.30
        +-org.slf4j:slf4j-api:1.7.30

可以看到org.slf4j:slf4j-api的jar引入了多個，并且版本還不一致。這時需要將明確不需要的jar進行排除。

排除時可以借助maven helper插件，在pom.xml文件的Dependency Analyzer中會顯示所有jar包沖突。

如圖，右鍵點擊exclude即可排除，等同于手動添加exclude操作。

排除后依賴顯示如下：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <version>2.2.5.RELEASE</version>
    <exclusions>
        <exclusion>
            <artifactId>slf4j-api</artifactId>
            <groupId>org.slf4j</groupId>
        </exclusion>
    </exclusions>
</dependency>

第二種jar包沖突報錯信息：