如何避免Java项目中的循环依赖问题

发表于:2021-3-16 09:30

字体: | 上一篇 | 下一篇 | 我要投稿

 作者:wang37444    来源:编码是个技术活

  前言
  当我们开发一个Java项目时,我们要做的第一件事就是添加我们需要使用的依赖项,库或框架。为此,我们使用依赖管理工具(例如Maven或Gradle),来管理我们的项目依赖。
  我们为项目添加的每个依赖项都包含其他依赖项。我们都知道依赖传递这个概念。在许多情况下,项目的依赖传递不会有任何的问题,因为依赖管理工具(Maven或Gradle)很好地解决了不同库之间的版本冲突。但是,在其他情况下,当使用我们的API /库时或者不同的库依赖的同一个库不同版本,这些冲突会产生一些错误。
  举个例子:
  图中我们的API 库导入了一些库,但这些库同时依赖了库X的不同版本,这样就好出现依赖冲突。
  如何解决这个问题
  在没有Maven & Gradle 库管理工具之前,我们开发一个Java项目需要耗费大量的时间去解决我们项目的依赖冲突,Maven & Gradle工具的引入极大的解决了我们依赖的问题,但很多时候我们还是会看到诸如:ClassNotFoundException,MethodNotSupportedException,NoClassDefNotFound这个时候很多情况下依赖开发人员的经验手动去解决,同时我们也可以依赖一些开发工具去帮助我们排查问题,如:
  Eclipse / IntelliJ 开发工具中的Dependency Analyzer
  他可以展示所有的依赖项并协助开发人员定位到有冲突的库。
  当您检测哪些库包含导致问题的依赖项时,需要从我们的依赖项管理文件(pom.xml或build.gradle)中排除所有包含不同版本依赖项的库。
  maven-enforcer-plugin插件
  Maven提供了Maven-Enforcer-Plugin插件,用来校验约定遵守情况(或者说校验开发环境)。比如JDK的版本,Maven的版本,开发环境(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> 
  在进行mvn clean package的时候,会在console中打印出来冲突的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 
  ] 
  结论
  依赖冲突是开发过程中比较耗时的一个问题,通过诸如以上的一些功能协助我们尽快定位到问题,但最好的解决方式还是要遵循开发中的规范,约定优于配置。

  本文内容不用于商业目的,如涉及知识产权问题,请权利人联系51Testing小编(021-64471599-8017),我们将立即处理
《2023软件测试行业现状调查报告》独家发布~

关注51Testing

联系我们

快捷面板 站点地图 联系我们 广告服务 关于我们 站长统计 发展历程

法律顾问:上海兰迪律师事务所 项棋律师
版权所有 上海博为峰软件技术股份有限公司 Copyright©51testing.com 2003-2024
投诉及意见反馈:webmaster@51testing.com; 业务联系:service@51testing.com 021-64471599-8017

沪ICP备05003035号

沪公网安备 31010102002173号