jar包冲突常用的解决方案

更新时间：2023年12月15日 09:59:00 作者：shyの同学

引言在使用java语言开发,maven做项目管理时,我们经常遇到一个头疼的问题就是jar包冲突,这篇文章主要给大家介绍了关于jar包冲突常用的解决方案,需要的朋友可以参考下

使用背景

在构建工程中，不可避免的引入多方依赖。从jar包冲突产生结果可大致分为两类：

1.同一个jar包出现了多个不同的版本。应用选择了错误的版本导致jvm加载不到需要的类或者加载了错误版本的类。

2.不同的jar包出现了类路径一致的类，同样的类出现在多个不同的依赖jar里，由于jar加载的先后顺序导致了JVM加载了错误版本的类。

maven-enforcer- plugin能够显式的在maven构建时展现jar包冲突之类的问题。

使用该插件检查是否有 maven直接/传递依赖带来的jar包冲突,在编译打包阶段可以显式构建失败。

允许创建一系列规则强制遵守，包括设定Java版本、设定Maven版本、禁止某些依赖、统一jar包版本、禁止 SNAPSHOT快照等等。maven-enforcer-plugin的enforce目标负责检查规则，它默认绑定到生命周期的validate阶段。当规则遭到破坏的时候，Maven就会报错。

除了标准的规则之外，还可以扩展该插件，编写自己的规则。

maven仲裁机制

针对第一个jar包冲突，maven提供了一套仲裁机制来决定使用哪个版本。有以下原则：

1.按照依赖管理元素中指定的版本。此时下面两个原则无效。

2.路径最短原则

若是没有版本申明，按照路径最短原则，即选择依赖树中最短的路径。

1)加载该jar包的类加载器在jvm类加载器树结构中所处的层级。

由于jvm的双亲委派机制，层级越高的类加载器越先加载其加载路径下的类。

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

2)文档系统的文档加载顺序。tomcat等容器的classLoader获取加载路径下的文档列表时不排序，依赖于底层的文档系统返回顺序。当不同环境之间的文档系统不一致时，就会出现有的环境没问题，有的环境有冲突。

比如：测试和线上环境不一致导致的问题。

最先声明原则

若路径长短一致，则按照第一声明原则进行仲裁，即选择pom文件中最先声明的版本。

使用说明

• 在最终打包运行的应用模块pom.xml文件中引入maven-enforcer-plugin依赖，模板可参考下方通用模板。

• 运行命令 mvn validate 进行校验，编译、打包命令也会触发校验

• 关闭校验执行命令加入 -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>
                        <!--执行的命令-->
                        <goal>enforce</goal>
                    </goals>
                    <!--执行的阶段-->
                    <phase>validate</phase>
                </execution>
                <execution>
                    <id>enforce-ban-duplicate-classes</id>
                    <goals>
                        <goal>enforce</goal>
                    </goals>
                    <configuration>
                        <!--规则-->
                        <rules>
                            <!--banDuplicateClasses规则 校验第二种jar包冲突（不同的jar包出现了类路径一致的类）-->
                            <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包出现了多个不同的版本）-->
                            <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>

更多详细规则说明参见官网：maven官网

冲突解决

使用exclude将明确不需要的jar进行排除
推荐使用dependencyMangment来管理依赖项，统一项目范围内的依赖版本。
如moduleA和moduleB共同依赖X这个依赖的话，那么可以将X抽取出来，放在父pom中同时设置其版本号，子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包冲突报错信息：

总结

到此这篇关于jar包冲突常用解决方案的文章就介绍到这了,更多相关jar包冲突解决内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

java实现列表、集合与数组之间转化的方法
这篇文章主要介绍了java实现列表、集合与数组之间转化的方法,涉及java中列表、集合与数组相互转换的技巧,非常具有实用价值,需要的朋友可以参考下
2015-03-03
Arthas在线java进程诊断工具在线调试神器详解
Arthas是 Alibaba 开源的Java诊断工具，深受开发者喜爱。这篇文章主要介绍了Arthas在线java进程诊断工具在线调试神器,需要的朋友可以参考下
2021-11-11
Java超详细分析泛型与通配符
本篇文章带大家认识Java语法泛型与通配符，泛型和通配符是一个非常抽象的概念，简单来说，两者都可以将类型作为“参数”进行传递，不过泛型是在你知道传入什么类型的时候使用的，而通配符是你不确定传入什么类型的时候使用，本文将介绍泛型与通配符的使用及两者间的区别
2022-03-03
Java实现一个简易版的多级菜单功能
这篇文章主要给大家介绍了关于Java如何实现一个简易版的多级菜单功能的相关资料,文中通过实例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2022-01-01
解决springboot报错Could not resolve placeholder‘x
这篇文章主要介绍了解决springboot报错:Could not resolve placeholder ‘xxx‘ in value “${XXXX}问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-11-11
Java多线程之FutureTask的介绍及使用
之前介绍了线程池相关的对象,Runable Callable与Future,下面介绍FutureTask的作用,它的特性是怎样的呢,需要的朋友可以参考下
2021-06-06
java 与web服务器链接的实例
这篇文章主要介绍了java 与web服务器链接的实例的相关资料,使用net.Socket类sock.getInetAddress()方法获得与Web服务器连接，需要的朋友可以参考下
2017-07-07
使用Spring Boot搭建Java web项目及开发过程图文详解
这篇文章主要介绍了使用Spring Boot搭建Java web项目及开发过程，本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-06-06
Spring Cloud项目前后端分离跨域的操作
这篇文章主要介绍了Spring Cloud项目前后端分离跨域的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-06-06
Spring配置中transactionAttributes的使用方法介绍
这篇文章主要介绍了Spring配置中transactionAttributes的使用方法介绍的相关内容，具有一定参考价值，需要的朋友可以了解下。
2017-09-09