SpringDoc OpenAPI 中 Jackson Kotlin 模块导致的属性重复问题解析

问题现象

在使用 SpringDoc OpenAPI 为 Kotlin 项目生成 API 文档时，开发者可能会遇到一个奇怪的现象：某些数据类属性会在生成的 OpenAPI 规范中出现重复。具体表现为：

• 当数据类属性名以单个字母开头且包含"Index"时（如 aIndex, bIndex）
• 这些属性会在生成的 OpenAPI 规范中出现两次
• 一次是原始大小写形式（如 aIndex）
• 一次是全小写形式（如 aindex）

问题根源

这个问题的根本原因在于 Jackson Kotlin 模块的特殊处理逻辑。Jackson 是 Spring Boot 默认使用的 JSON 处理库，而 jackson-module-kotlin 是为 Kotlin 提供额外支持的扩展模块。

在 Kotlin 中，当属性名以单个字母开头且包含"Index"时，Jackson Kotlin 模块会生成两种不同的属性名称表示：

1. 原始属性名（如 aIndex）
2. 小写转换后的属性名（如 aindex）

这种双重表示导致了 SpringDoc OpenAPI 在生成 API 文档时也会包含这两种形式，从而造成文档中的属性重复。

解决方案

目前有两种可行的解决方案：

1. 显式指定 JSON 属性名

通过在数据类属性上添加 @JsonProperty 注解，可以显式指定 JSON 表示时的属性名：

data class Result(
    val result: Int,
    @get:JsonProperty("aIndex")
    val aIndex: Int,
    val someIndex: Int,
    @get:JsonProperty("bIndex")
    val bIndex: Int
)

这种方式可以强制 Jackson 使用指定的属性名，避免自动生成小写版本。

2. 配置 Jackson 的命名策略

另一种方法是通过配置 Jackson 的命名策略来避免这种自动转换：

@Configuration
class JacksonConfig {
    @Bean
    fun objectMapper(): ObjectMapper {
        return Jackson2ObjectMapperBuilder.json()
            .propertyNamingStrategy(PropertyNamingStrategies.LOWER_CAMEL_CASE)
            .modulesToInstall(KotlinModule.Builder().build())
            .build()
    }
}

这样配置后，Jackson 将始终使用小驼峰命名法，而不会对特定模式的属性名进行特殊处理。

最佳实践建议

1. 保持命名一致性：在 Kotlin 项目中，建议统一使用小驼峰命名法（如 someIndex），避免使用单个字母开头的属性名。

2. 显式优于隐式：对于关键的数据传输对象，显式使用 @JsonProperty 注解可以避免意外的序列化行为。

3. 测试 API 文档：在重要的 API 变更后，应该检查生成的 OpenAPI 文档是否符合预期。

4. 关注依赖更新：这个问题本质上是由 Jackson Kotlin 模块引起的，随着库的更新可能会被修复，保持依赖更新也很重要。

总结

SpringDoc OpenAPI 与 Jackson Kotlin 模块的交互可能会导致 API 文档中属性重复的问题，特别是在处理特定命名模式的属性时。通过理解问题的根源并采取适当的解决方案，开发者可以确保生成的 API 文档准确反映实际的 API 契约。在 Kotlin 项目中使用 SpringDoc 时，对 Jackson 的序列化行为有深入理解将有助于避免这类问题。