SpringDoc OpenAPI中GroupConfigs重复加载问题分析与解决方案

问题背景

在使用SpringDoc OpenAPI进行API文档管理时，开发者可能会遇到GroupConfigs配置重复加载的问题。具体表现为：当通过application.properties文件配置多个API分组时，SpringDocConfigProperties.getGroupConfigs()方法返回的列表会包含重复的分组配置。

问题复现

该问题在以下环境中可以稳定复现：

• Spring Boot 3.2.3
• springdoc-openapi-starter-webmvc-ui 2.3.0
• 通过application.properties配置多个分组

典型配置示例：

springdoc.group-configs[0].group=Group0
springdoc.group-configs[0].packages-to-scan=com.my-package
springdoc.group-configs[1].group=Group1
springdoc.group-configs[1].packages-to-scan=com.my-package

问题现象

当通过@Autowired注入SpringDocConfigProperties并调用getGroupConfigs()方法时：

1. 应用启动初期返回正确的分组列表（如[Group0, Group1]）
2. 运行一段时间后返回重复的分组列表（如[Group0, Group1, Group0, Group1]）

技术分析

这个问题源于SpringDoc内部对GroupConfigs的处理机制。通过分析我们可以了解到：

1. 配置加载机制：SpringDoc会从application.properties中读取分组配置并初始化GroupConfig对象
2. 生命周期问题：在应用运行过程中，配置被重复加载导致列表元素翻倍
3. 与编程式配置的差异：通过@Bean方式配置GroupedOpenApi不会出现此问题，因为这种方式直接注册到Spring容器，避免了重复加载

解决方案

目前有以下两种推荐解决方案：

1. 升级版本：使用最新版本的springdoc-openapi（2.3.0之后的版本已修复此问题）
2. 改用编程式配置：通过Java Config方式定义分组

编程式配置示例：

@Bean
public GroupedOpenApi group0() {
    return GroupedOpenApi.builder()
            .group("Group0")
            .packagesToScan("com.myPackage")
            .build();
}

最佳实践建议

1. 对于生产环境，建议采用编程式配置方式，这种方式更加明确且易于维护
2. 如果需要动态配置，可以考虑结合ConfigurationProperties和编程式配置
3. 定期检查springdoc-openapi的版本更新，及时获取bug修复和新特性

总结

SpringDoc OpenAPI作为Spring生态中优秀的API文档工具，在使用过程中可能会遇到各种配置问题。理解其内部工作机制有助于开发者快速定位和解决问题。对于GroupConfigs重复加载这类问题，开发者可以根据项目实际情况选择合适的解决方案，确保API文档系统的稳定运行。