SpringDoc OpenAPI 与 WebMvcConfigurationSupport 配置冲突解决方案

在使用 SpringDoc OpenAPI 时，很多开发者会遇到一个常见问题：当自定义 WebMvcConfigurationSupport 配置后，Swagger UI 界面无法正常显示 API 分组信息。这个问题源于 Spring MVC 配置的覆盖机制，需要开发者特别注意。

问题现象

当项目中存在继承自 WebMvcConfigurationSupport 的自定义配置类时，SpringDoc OpenAPI 的默认配置会被覆盖，导致以下异常现象：

1. Swagger UI 界面可以访问，但 API 分组信息丢失
2. API 文档端点返回空数据
3. 静态资源路径可能无法正确映射

问题根源分析

Spring MVC 的配置机制决定了 WebMvcConfigurationSupport 是一个"全有或全无"的配置方式。当开发者继承这个类时，Spring Boot 的自动配置会失效，包括 SpringDoc OpenAPI 的自动配置。

具体来说，问题出在以下几个方面：

1. 资源处理器覆盖：SpringDoc 需要注册特定的资源处理器来提供 Swagger UI 静态资源
2. 消息转换器覆盖：API 文档的生成依赖于特定的消息转换器配置
3. 视图解析器配置：Swagger UI 页面渲染需要正确的视图解析器

解决方案

正确的做法是在自定义 WebMvcConfigurationSupport 中显式地保留 SpringDoc 的配置。以下是完整的解决方案：

@Configuration
@RequiredArgsConstructor
public class DefaultWebMvcConfig extends WebMvcConfigurationSupport {

    private final SwaggerWebMvcConfigurer swaggerWebMvcConfigurer;

    @Override
    protected void configureViewResolvers(ViewResolverRegistry registry) {
        registry.viewResolver(new InternalResourceViewResolver());
        super.configureViewResolvers(registry);
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 自定义静态资源映射
        registry.addResourceHandler("/swagger-ui/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/swagger-ui/5.10.3/");
        
        // 保留SpringDoc的资源处理器
        swaggerWebMvcConfigurer.addResourceHandlers(registry);
    }

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        // 自定义FastJSON配置
        FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();
        FastJsonConfig fastJsonConfig = new FastJsonConfig();
        fastJsonConfig.setSerializerFeatures(
                SerializerFeature.DisableCircularReferenceDetect,
                SerializerFeature.PrettyFormat,
                SerializerFeature.WriteMapNullValue,
                SerializerFeature.WriteNullListAsEmpty,
                SerializerFeature.BrowserCompatible
        );

        SerializeConfig serializeConfig = SerializeConfig.globalInstance;
        serializeConfig.put(Long.class, ToStringSerializer.instance);
        serializeConfig.put(Long.TYPE, ToStringSerializer.instance);
        serializeConfig.put(BigInteger.class, ToStringSerializer.instance);
        serializeConfig.put(BigDecimal.class, ToStringSerializer.instance);
        fastJsonConfig.setSerializeConfig(serializeConfig);
        
        List<MediaType> fastMediaTypes = Collections.singletonList(
                new MediaType("application", "json", StandardCharsets.UTF_8)
        );

        fastConverter.setSupportedMediaTypes(fastMediaTypes);
        fastConverter.setFastJsonConfig(fastJsonConfig);
        converters.add(new ByteArrayHttpMessageConverter());
        converters.add(fastConverter);
        
        // 保留SpringDoc的消息转换器配置
        swaggerWebMvcConfigurer.configureMessageConverters(converters);
    }
}

关键点解析

1. SwaggerWebMvcConfigurer 注入：通过构造函数注入 SpringDoc 提供的配置器，确保能够保留必要的配置

2. 资源处理器合并：在自定义资源处理器后，调用 swaggerWebMvcConfigurer.addResourceHandlers 方法添加 SpringDoc 所需的资源映射

3. 消息转换器合并：在配置完自定义的消息转换器后，调用 swaggerWebMvcConfigurer.configureMessageConverters 方法保留文档生成所需的转换器

4. 视图解析器配置：显式配置 InternalResourceViewResolver 确保视图能够正确解析

最佳实践建议

1. 尽量避免完全覆盖 WebMvcConfigurationSupport，优先考虑实现 WebMvcConfigurer 接口
2. 如果必须使用 WebMvcConfigurationSupport，确保保留框架必要的配置
3. 对于 JSON 序列化，考虑使用 Jackson 而不是 FastJSON，因为 Spring 生态对 Jackson 有更好的支持
4. 在升级 SpringDoc 版本时，注意检查资源路径是否发生变化

通过这种方式，开发者可以在保留自定义 MVC 配置的同时，确保 SpringDoc OpenAPI 能够正常工作，API 文档分组信息也能正确显示。