SpringDoc OpenAPI 中自定义 TypeNameResolver 的实现方案

在 SpringDoc OpenAPI 项目中，当开发者需要处理带有内部类或嵌套类的复杂模型时，默认的类型名称解析器（TypeNameResolver）可能无法满足特定的命名需求。特别是在使用 use-fqn（完全限定名）配置时，类型名称中的 $ 符号可能不符合预期格式要求。本文将介绍如何通过自定义 TypeNameResolver 来解决这一问题。

问题背景

SpringDoc OpenAPI 默认使用 Swagger Core 提供的标准 TypeNameResolver 实现。当启用 use-fqn 配置时，类型名称会包含完整的包路径，但内部类名称中的 $ 符号可能不符合某些场景下的格式要求。例如，开发者可能希望将 com.example.Outer$Inner 转换为 com.example.Outer.Inner。

解决方案

1. 创建自定义 TypeNameResolver

首先，我们需要创建一个继承自 TypeNameResolver 的自定义解析器。在这个解析器中，我们可以覆盖 nameForClass 方法，实现对类型名称的定制化处理：

public class CustomTypeNameResolver extends TypeNameResolver {
    public CustomTypeNameResolver() {
        setUseFqn(true);  // 启用完全限定名
    }

    @Override
    protected String nameForClass(Class<?> cls, Set<Options> options) {
        // 将 $ 替换为 .
        return super.nameForClass(cls, options).replaceAll("\\$", ".");
    }
}

2. 创建自定义 ModelConverter

由于 SpringDoc OpenAPI 的默认初始化流程会直接使用标准 TypeNameResolver，我们需要通过创建自定义的 ModelConverter 来确保我们的解析器被正确使用：

@Component
class CustomConverter extends ModelResolver {
    public CustomConverter(ObjectMapper mapper) {
        super(mapper, new CustomTypeNameResolver());
    }
}

3. 实现原理

这种解决方案之所以有效，是因为：

1. Spring 的组件扫描机制会自动发现带有 @Component 注解的 CustomConverter
2. 自定义转换器在初始化时会注入我们创建的 CustomTypeNameResolver
3. 在模型转换过程中，SpringDoc 会优先使用我们提供的解析器实现

注意事项

1. 确保自定义转换器被正确扫描并注册为 Spring Bean
2. 如果需要保留原始行为作为后备方案，可以在自定义解析器中调用父类方法后再进行修改
3. 这种修改会影响所有通过 OpenAPI 文档生成的模型名称，请确保与前端或其他消费方兼容

总结

通过实现自定义 TypeNameResolver 和 ModelConverter，开发者可以灵活控制 SpringDoc OpenAPI 生成的模型名称格式。这种方法特别适用于需要特殊处理内部类名称或需要统一命名规范的场景。相比直接修改框架代码，这种解决方案更加优雅且易于维护。