MAVEN依赖冲突问题:
依赖的传递原则:
- 最短路径原则
- 最先声明原则
maven的依赖引入策略
最短路径原则:
我有下面两个依赖jar包,A和B,他们都引入了C这个依赖,这时候如果有如下的引用
A -> C(3.3)
B -> A(3.3)
B -> C(3.4)
此时如果把B打包,得到版本号是3.4,但是如果B去掉C的依赖,那就是走A->C的传递依赖,很简单
验证:
- 我假设我有一个web包引入了common-lang3,版本是3.4的版本
<dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> <version>3.4</version> </dependency> 复制代码
- 此时又引入了一个公用包,里面也有这个引用:
<dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> <version>3.3</version> </dependency> 复制代码
- 如果此时在本地引用3.4版本,那就是3.4的版本,否则就死3.3的版本,不管声明顺序谁先谁后
最先声明原则:
如果两个jar包的寻址路径一致,那么谁先优先声明,先引入谁
验证:
下面两个依赖分配对应两个module,引入模块的这个模块暂定为 C 模块。
<!-- 引入core包内容 --> <dependency> <groupId>org.zxd</groupId> <artifactId>taglib-core</artifactId> <version>1.0.0</version> <!-- <scope>compile</scope>--> </dependency> <!-- 引入db包的内容 --> <dependency> <groupId>org.zxd</groupId> <artifactId>taglib-db</artifactId> <version>1.0.0</version> </dependency> 复制代码
此时 taglib-core
中的依赖版本如下,暂定为 A 模块:
<dependency> <groupId>org.apache.curator</groupId> <artifactId>curator-client</artifactId> <version>2.5.0</version> </dependency> 复制代码
而taglib-db
中的依赖版本如下,暂定为 B 模块:
<dependency> <groupId>org.apache.curator</groupId> <artifactId>curator-client</artifactId> <version>4.0.1</version> </dependency> 复制代码
此时将整个web项目打包,可以看到web项目里面的版本如下:
可以很明显的看到如果引入关系是这样的:
C -> A,B
A -> curator-client 2.5
B -> curator-client 4.1
这样的链路最终打包出来的效果是 C -> A -> curator-client 2.5
这样也就造成了很多情况下我们编译和运行时完全没有问题的,甚至有可能打包都是正常的,但是到最后运行的时候突然报错,要谨防这种依赖版本的问题,好在一般公司的项目都有经理负责控制版本依赖,这种错误算是低级错误,但是在如今框架满天飞的时代,依赖管理的版本控制问题依然需要注意!!!
如何解决依赖冲突的问题
锁定版本法
一般情况下我们会在父pom文件里面管理,可以使用<dependencyManagement>
这个这个标签来管理所有子模块的版本依赖,子模块如果指定自己的版本,这里发现打出来的包依然是父pom指定的版本,版本管理使用如下:
<dependencyManagement> <dependencies> <dependency> <groupId>org.apache.curator</groupId> <artifactId>curator-client</artifactId> <version>4.1.0</version> </dependency> </dependencies> </dependencyManagement> 复制代码
锁定版本法可以打破2个依赖传递的原则,优先级为最高
版本锁定可以排除一些exclude标签,不同模块用不同版本的jar包本身也不符合规范,所以这种方式较为稳妥
什么情况下会出现Jar包冲突问题
只有高版本Jar包不向下兼容,或者新增了某些低版本没有的API才有可能导致这样的问题
如何查找和发现jar包冲突?
1. 利用idea的maven视图工具
直接使用一个图说明一下:
可以通过这个工具查看依赖在哪个模块重复引用,同时如果有冲突会显示红线,这个视图非常的直观,可以帮助依赖管理人员去处理依赖重复引用或者引用版本不一致的问题,进行<exclude>
操作
2. Idea Maven Helper
插件
如何使用?
安装完成之后,随便找一个pom.xml文件,按照如下的图例提示进行操作,对于冲突的内容,右击exclude
就可以排除依赖:
排除完依赖之后,点击左上角的Refresh UI
刷新一下UI的界面:
3. maven命令工具:
mvn dependency:tree -Dverbose
,有时候如果我们没有idea的情况下,可以使用这个命令来处理,执行的结果参考如下:
PS: 此处一定不要省略
-Dverbose
参数,要不然是不会显示被忽略的包的
or:curator-client:jar:4.1.0:compile [INFO] | | +- org.apache.zookeeper:zookeeper:jar:3.5.4-beta:compile [INFO] | | | +- commons-cli:commons-cli:jar:1.2:compile [INFO] | | | +- log4j:log4j:jar:1.2.17:compile [INFO] | | | +- org.apache.yetus:audience-annotations:jar:0.5.0:compile [INFO] | | | \- io.netty:netty:jar:3.10.6.Final:compile [INFO] | | +- com.google.guava:guava:jar:20.0:compile [INFO] | | \- org.slf4j:slf4j-api:jar:1.7.30:compile [INFO] | +- commons-codec:commons-codec:jar:1.15:compile [INFO] | +- commons-collections:commons-collections:jar:3.2.2:compile [INFO] | +- commons-beanutils:commons-beanutils:jar:1.9.4:compile [INFO] | +- commons-configuration:commons-configuration:jar:1.10:compile [INFO] | | \- commons-lang:commons-lang:jar:2.6:compile 复制代码
总体上来说还是比较直观的,非常方便和好用。
如何写一个干净依赖关系的POM
文件
- 尽量在父POM中定义
<dependencyManagement>
,来进行本项目一些依赖版本的管理,这样可以从很大程度上解决一定的冲突 - 最少依赖jar包原则
- 使用
mvn dependency:analyze-only
命令用于检测那些声明了但是没被使用的依赖,如有有一些是你自己声明的,那尽量去掉 - 使用
mvn dependency:analyze-duplicate
命令用来分析重复定义的依赖,清理那些重复定义的依赖
dependency:analyze-only
命令
在idea - Terminal
里面,可以看到对应的依赖被下载
执行完之后我的运行结果如下,这里报错的原因是打包时候默认去阿里云仓库寻找依赖,这里需要配置一下:
[ERROR] Failed to execute goal on project taglib-web: Could not resolve dependencies for project org.zxd:taglib-web:war:1.0.0: The following artifacts could not be resolved: org.zxd: taglib-core:jar:1.0.0, org.zxd:taglib-db:jar:1.0.0: Failure to find org.zxd:taglib-core:jar:1.0.0 in http://maven.aliyun.com/nexus/content/repositories/central/ was cached in the loc al repository, resolution will not be reattempted until the update interval of alimaven has elapsed or updates are forced -> [Help 1] 复制代码
大致意思就是说再阿里云仓库找不到对应的依赖引入。
解决方式如下:
找到maven的安装路径下的apache-maven-3.6.3\conf
下面的setting.xml
,找到如下配置:
<!-- localRepository | The path to the local repository maven will use to store artifacts. | | Default: ${user.home}/.m2/repository <localRepository>/path/to/local/repo</localRepository> --> <!-- 这里配置本地仓库的位置 --> <localRepository>D:\soft\apache-maven-3.6.3\rep</localRepository> 复制代码
此时重新执行一下:dependency:analyze-only
命令
[INFO] --- maven-dependency-plugin:3.1.2:analyze-only (default-cli) @ taglib-web --- [WARNING] Unused declared dependencies found: [WARNING] org.zxd:taglib-core:jar:1.0.0:compile [WARNING] org.apache.commons:commons-lang3:jar:3.4:compile [WARNING] org.springframework.boot:spring-boot-starter-web:jar:2.4.0:compile [WARNING] org.springframework.boot:spring-boot-starter-test:jar:2.4.0:test [WARNING] org.neo4j.driver:neo4j-java-driver:jar:1.5.0:compile [WARNING] commons-codec:commons-codec:jar:1.10:compile [WARNING] commons-collections:commons-collections:jar:3.2.2:compile [WARNING] commons-beanutils:commons-beanutils:jar:1.9.4:compile [WARNING] commons-configuration:commons-configuration:jar:1.10:compile [WARNING] commons-fileupload:commons-fileupload:jar:1.3:compile [WARNING] commons-logging:commons-logging:jar:1.2:compile [WARNING] org.apache.httpcomponents:httpclient:jar:4.4.1:compile [WARNING] org.apache.poi:poi-ooxml:jar:3.17:compile [WARNING] org.mybatis:mybatis:jar:3.4.0:compile [WARNING] org.mybatis:mybatis-spring:jar:1.3.0:compile [WARNING] com.github.pagehelper:pagehelper:jar:5.1.2:compile 复制代码
mvn dependency:analyze-duplicate
命令
[INFO] No duplicate dependencies found in <dependencies/> or in <dependencyManagement/> 复制代码
如果没有其他信息,代表没有重复依赖的引入