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

SpringDoc OpenAPI 是一个流行的开源库，用于为基于 Spring Boot 的应用程序自动生成 OpenAPI 3.0 文档。近期，随着 Spring Boot 3.5.0 版本的发布，一些开发者在使用 SpringDoc 时遇到了兼容性问题。

问题背景

在 Spring Boot 3.5.0 中，Spring 团队对 HateoasProperties 类进行了修改，将 getUseHalAsDefaultJsonMediaType() 方法重命名为 isUseHalAsDefaultJsonMediaType()。这一看似微小的变更实际上是一个破坏性变更，因为它影响了方法的签名。

当开发者将项目升级到 Spring Boot 3.5.0 并同时使用 SpringDoc OpenAPI 时，应用程序启动时会抛出方法未找到的异常。具体表现为 SpringDoc 的 HateoasHalProvider 类尝试调用 getUseHalAsDefaultJsonMediaType() 方法，但该方法在 Spring Boot 3.5.0 中已不存在。

技术分析

这个问题本质上是一个 API 兼容性问题。Spring Boot 团队在 3.5.0 版本中决定将 getter 方法从 get 前缀改为 is 前缀，以更好地遵循 Java Bean 命名规范（对于布尔类型的属性）。虽然这种变更有其合理性，但它确实破坏了向后兼容性。

SpringDoc OpenAPI 作为一个依赖 Spring Boot 的库，需要适应这种变更。在 Spring Boot 3.5.0 发布后，SpringDoc 团队面临两个选择：

1. 将最低支持的 Spring Boot 版本提高到 3.5.0
2. 使用反射机制来同时支持新旧版本的 Spring Boot

解决方案

SpringDoc 团队选择了更为灵活的第二种方案，通过反射机制来检测并调用适当的方法。这种设计有以下优点：

• 保持向后兼容性，支持 Spring Boot 3.5.0 及更早版本
• 不需要强制用户升级 Spring Boot 版本
• 提供更平滑的迁移路径

在 SpringDoc OpenAPI 2.8.9 版本中，这个问题已经得到修复。开发者只需将依赖升级到 2.8.9 或更高版本即可解决兼容性问题。

最佳实践

对于开发者而言，处理此类兼容性问题时建议：

1. 及时关注依赖库的更新日志和发布说明
2. 在升级主要依赖（如 Spring Boot）时，检查所有相关依赖的兼容性
3. 优先选择提供向后兼容解决方案的库版本
4. 在开发环境中先进行小范围测试，确认无误后再部署到生产环境

总结

SpringDoc OpenAPI 团队对 Spring Boot 3.5.0 的兼容性问题做出了快速响应，通过巧妙的反射机制实现了新旧版本的兼容。这体现了开源社区对开发者体验的重视，也为处理类似的 API 变更提供了参考方案。开发者只需升级到 SpringDoc OpenAPI 2.8.9 或更高版本，即可无缝使用 Spring Boot 3.5.x 系列。