SpringBoot配置Swagger/Knife4j依赖冲突解决方案

2023-11-25 23:38:45

解决 SpringBoot 中 Swagger/Knife4j 依赖冲突问题

在构建微服务和 Web 应用程序时，SpringBoot、Swagger 和 Knife4j 都是不可或缺的工具。然而，在配置这些依赖项时，您可能会遇到“Unresolvable class definition for class…”异常，这可能是由版本冲突引起的。

依赖冲突的根源

此异常通常是由依赖项之间的版本不兼容造成的。例如，如果您使用的是 SpringBoot 2.7.x 版本，而 Swagger 依赖的某些类已在 SpringBoot 2.6.x 版本中更改或删除，则可能会出现此异常。

解决方案

解决此问题的步骤如下：

检查依赖项版本

使用 Maven 或 Gradle 等构建工具，检查项目中相关依赖项的版本。确保所有依赖项都使用兼容的版本。

使用 SpringBoot Starter

SpringBoot 提供了官方的 Starter 依赖项，可以简化对常用功能的集成。您可以使用 spring-boot-starter-swagger2 或 spring-boot-starter-knife4j Starter 依赖项来轻松配置 Swagger 或 Knife4j。这些 Starter 依赖项会自动管理相关依赖项的版本兼容性。

排除冲突依赖项

如果无法使用 SpringBoot Starter 依赖项，或者存在其他依赖项冲突，您可以通过排除冲突依赖项的方式来解决问题。在 Maven 项目中，可以使用 <exclusion> 标签排除冲突依赖项；在 Gradle 项目中，可以使用 exclude 方法排除冲突依赖项。

升级 SpringBoot 版本

如果依赖项冲突难以解决，您可以尝试升级 SpringBoot 版本。较新的 SpringBoot 版本通常会解决一些依赖项冲突问题。

代码示例

使用 Maven 排除冲突依赖项

<dependency>
  <groupId>com.google.code.gson</groupId>
  <artifactId>gson</artifactId>
  <version>2.8.9</version>
  <exclusions>
    <exclusion>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-core</artifactId>
    </exclusion>
  </exclusions>
</dependency>

使用 Gradle 排除冲突依赖项

dependencies {
  implementation 'com.google.code.gson:gson:2.8.9'
  implementation('com.fasterxml.jackson.core:jackson-core') {
    exclude group: 'com.google.code.gson'
  }
}