SpringDoc OpenAPI 与 Spring Boot 3.x 的兼容性问题解析

问题背景

在 Spring Boot 3.x 项目中集成 SpringDoc OpenAPI 时，开发者可能会遇到应用启动失败的问题，错误信息通常指向 javax.servlet 相关类的缺失。这种情况主要发生在从 Spring Boot 2.x 升级到 3.x 的过程中，因为 Spring Boot 3.x 已经完全迁移到了 Jakarta EE 命名空间。

核心问题分析

Spring Boot 3.x 的一个重要变化是彻底从 javax 命名空间迁移到了 jakarta 命名空间。这意味着所有与 Servlet API 相关的类都从 javax.servlet 迁移到了 jakarta.servlet。然而，某些依赖库可能仍然引用旧的 javax 命名空间，导致兼容性问题。

在 SpringDoc OpenAPI 的场景中，当开发者尝试使用 springdoc-openapi-starter-webmvc-ui 或 springdoc-openapi-starter-webmvc-api 模块时，可能会遇到以下典型错误：

java.lang.NoClassDefFoundError: javax/servlet/http/HttpServletRequest

解决方案

1. 确保正确的依赖配置

对于 Spring Boot 3.x 项目，应该仅使用 SpringDoc OpenAPI 的 2.x 版本，并且配置应该尽可能简单：

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.8.3</version>
</dependency>

2. 避免混合使用不同版本的 SpringDoc 模块

开发者不应同时使用 SpringDoc 1.x 和 2.x 版本的模块。例如，以下配置会导致问题：

<!-- 错误的配置示例 -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.7.0</version>
</dependency>
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.8.3</version>
</dependency>

3. 检查传递依赖

即使开发者没有显式引入 javax.servlet 依赖，某些第三方库可能会间接引入。可以使用以下命令检查依赖树：

mvn dependency:tree | grep "javax.servlet"

4. 确保项目完全使用 Jakarta EE 命名空间

所有代码中的导入语句应该使用 jakarta 而非 javax：

// 正确
import jakarta.servlet.http.HttpServletRequest;

// 错误
import javax.servlet.http.HttpServletRequest;

最佳实践建议

1. 保持依赖简洁：对于 Spring Boot 3.x 项目，只需引入 springdoc-openapi-starter-webmvc-ui 即可，无需额外配置其他 SpringDoc 模块。

2. 版本对齐：确保所有 Spring 相关依赖（包括 Spring Boot、Spring Framework 和 SpringDoc）的版本相互兼容。

3. 彻底清理：在迁移到 Spring Boot 3.x 时，建议彻底清理项目中的所有 javax.servlet 引用，包括代码、配置和依赖。

4. 优先使用 starter：SpringDoc 提供的 starter 模块已经处理了大多数兼容性问题，直接使用它们可以减少配置复杂度。

总结

SpringDoc OpenAPI 与 Spring Boot 3.x 的集成问题主要源于命名空间的迁移。通过正确配置依赖、避免版本混用和确保代码完全使用 Jakarta EE 命名空间，开发者可以顺利解决这些问题。记住，Spring Boot 3.x 生态系统已经完全转向 Jakarta EE，任何 javax.servlet 的残留都可能导致兼容性问题。