如何避免Java項(xiàng)目中的循環(huán)依賴問(wèn)題
前言
當(dāng)我們開(kāi)發(fā)一個(gè)Java項(xiàng)目時(shí),我們要做的第一件事就是添加我們需要使用的依賴項(xiàng),庫(kù)或框架。為此,我們使用依賴管理工具(例如Maven或Gradle),來(lái)管理我們的項(xiàng)目依賴。
我們?yōu)轫?xiàng)目添加的每個(gè)依賴項(xiàng)都包含其他依賴項(xiàng)。我們都知道依賴傳遞這個(gè)概念。在許多情況下,項(xiàng)目的依賴傳遞不會(huì)有任何的問(wèn)題,因?yàn)橐蕾嚬芾砉ぞ?Maven或Gradle)很好地解決了不同庫(kù)之間的版本沖突。但是,在其他情況下,當(dāng)使用我們的API /庫(kù)時(shí)或者不同的庫(kù)依賴的同一個(gè)庫(kù)不同版本,這些沖突會(huì)產(chǎn)生一些錯(cuò)誤。
舉個(gè)例子:

圖中我們的API 庫(kù)導(dǎo)入了一些庫(kù),但這些庫(kù)同時(shí)依賴了庫(kù)X的不同版本,這樣就好出現(xiàn)依賴沖突。
如何解決這個(gè)問(wèn)題
在沒(méi)有Maven & Gradle 庫(kù)管理工具之前,我們開(kāi)發(fā)一個(gè)Java項(xiàng)目需要耗費(fèi)大量的時(shí)間去解決我們項(xiàng)目的依賴沖突,Maven & Gradle工具的引入極大的解決了我們依賴的問(wèn)題,但很多時(shí)候我們還是會(huì)看到諸如:ClassNotFoundException,MethodNotSupportedException,NoClassDefNotFound這個(gè)時(shí)候很多情況下依賴開(kāi)發(fā)人員的經(jīng)驗(yàn)手動(dòng)去解決,同時(shí)我們也可以依賴一些開(kāi)發(fā)工具去幫助我們排查問(wèn)題,如:
Eclipse / IntelliJ 開(kāi)發(fā)工具中的Dependency Analyzer
他可以展示所有的依賴項(xiàng)并協(xié)助開(kāi)發(fā)人員定位到有沖突的庫(kù)。

當(dāng)您檢測(cè)哪些庫(kù)包含導(dǎo)致問(wèn)題的依賴項(xiàng)時(shí),需要從我們的依賴項(xiàng)管理文件(pom.xml或build.gradle)中排除所有包含不同版本依賴項(xiàng)的庫(kù)。
maven-enforcer-plugin插件
Maven提供了Maven-Enforcer-Plugin插件,用來(lái)校驗(yàn)約定遵守情況(或者說(shuō)校驗(yàn)開(kāi)發(fā)環(huán)境)。比如JDK的版本,Maven的版本,開(kāi)發(fā)環(huán)境(Linux,Windows等),依賴jar包的版本等等
插件使用只需要在pom中引入即可:
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-enforcer-plugin</artifactId>
- <version>1.3.1</version>
- <executions>
- <execution>
- <id>enforce</id>
- <configuration>
- <rules>
- <DependencyConvergence/>
- </rules>
- </configuration>
- <goals>
- <goal>enforce</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
在進(jìn)行mvn clean package的時(shí)候,會(huì)在console中打印出來(lái)沖突的jar版本和其父pom,如下:
- [INFO] --- maven-enforcer-plugin:1.3.1:enforce (enforce) @ uaf-uafei-provider ---
- [WARNING]
- Dependency convergence error for com.google.guava:guava:16.0 paths to dependency are:
- +-com.uaf.uafei:uaf-uafei-provider:0.2.09-SNAPSHOT
- +-com.uaf:microservice-sleuth:0.2.09-SNAPSHOT
- +-org.springframework.cloud:spring-cloud-starter-openfeign:2.1.5.RELEASE
- +-io.github.openfeign:feign-hystrix:10.4.0
- +-com.netflix.archaius:archaius-core:0.7.6
- +-com.google.guava:guava:16.0
- and
- +-com.uaf.uafei:uaf-uafei-provider:0.2.09-SNAPSHOT
- +-com.uaf:microservice-apollo:0.2.09-SNAPSHOT
- +-com.google.inject:guice:4.1.0
- +-com.google.guava:guava:19.0
- [WARNING] Rule 0: org.apache.maven.plugins.enforcer.DependencyConvergence failed with message:
- Failed while enforcing releasability the error(s) are [
- Dependency convergence error for com.google.guava:guava:16.0 paths to dependency are:
- +-com.uaf.uafei:uaf-uafei-provider:0.2.09-SNAPSHOT
- +-com.uaf:microservice-sleuth:0.2.09-SNAPSHOT
- +-org.springframework.cloud:spring-cloud-starter-openfeign:2.1.5.RELEASE
- +-io.github.openfeign:feign-hystrix:10.4.0
- +-com.netflix.archaius:archaius-core:0.7.6
- +-com.google.guava:guava:16.0
- and
- +-com.uaf.uafei:uaf-uafei-provider:0.2.09-SNAPSHOT
- +-com.uaf:microservice-apollo:0.2.09-SNAPSHOT
- +-com.google.inject:guice:4.1.0
- +-com.google.guava:guava:19.0
- ]
結(jié)論
依賴沖突是開(kāi)發(fā)過(guò)程中比較耗時(shí)的一個(gè)問(wèn)題,通過(guò)諸如以上的一些功能協(xié)助我們盡快定位到問(wèn)題,但最好的解決方式還是要遵循開(kāi)發(fā)中的規(guī)范,約定優(yōu)于配置。