SpringDoc OpenAPI 中 @JsonUnwrapped 注解的解析问题与解决方案

在 Spring Boot 3.4.1 升级过程中，开发者发现了一个与 SpringDoc OpenAPI 库相关的重要问题：当使用 @JsonUnwrapped 注解时，嵌套对象的属性在生成的 OpenAPI 文档中丢失了。这个问题在 Spring Boot 3.2 到 3.4.1 的版本升级过程中出现，影响了 API 文档的完整性。

问题现象

开发者在使用记录类型(record)定义DTO时，为嵌套对象添加了@JsonUnwrapped注解，期望在生成的OpenAPI文档中能够展开嵌套对象的属性。然而升级后发现，这些展开的属性在最终文档中完全消失了。

示例代码结构如下：

public record Example(
        @JsonUnwrapped
        @Schema(requiredMode = Schema.RequiredMode.REQUIRED)
        Wrapped unwrapped,
        
        @Schema(requiredMode = Schema.RequiredMode.REQUIRED)
        Integer number
) {
    public record Wrapped(
            @Schema(requiredMode = Schema.RequiredMode.REQUIRED)
            String value
    ) {}
}

问题分析

这个问题主要涉及以下几个方面：

1. 注解处理机制变化：Spring Boot 3.4.1 中可能对注解处理流程进行了调整，导致@JsonUnwrapped注解没有被正确处理。

2. 文档生成逻辑：SpringDoc OpenAPI 在解析模型时，可能没有正确识别和处理带有@JsonUnwrapped注解的字段。

3. 版本兼容性问题：不同版本的库之间可能存在不兼容的情况，特别是在处理特殊注解时。

解决方案

SpringDoc OpenAPI 团队在2.8.4-SNAPSHOT版本中修复了这个问题。修复后的版本能够正确识别@JsonUnwrapped注解，并在生成的OpenAPI文档中展开嵌套属性。

需要注意的是，当配置springdoc.use-fqn=true（使用完全限定名）时，这个修复可能不会生效。这是另一个需要开发者注意的边界情况。

最佳实践

1. 版本选择：如果项目中使用@JsonUnwrapped注解，建议升级到SpringDoc OpenAPI 2.8.4或更高版本。

2. 配置检查：检查项目中是否设置了springdoc.use-fqn属性，了解其对文档生成的影响。

3. 测试验证：升级后，应全面测试API文档生成结果，确保所有嵌套展开的属性都正确显示。

4. 替代方案：对于关键API，可以考虑不使用@JsonUnwrapped，而是显式定义所有字段，以避免潜在的文档生成问题。

总结

这个问题的解决体现了开源社区响应问题的效率。开发者在遇到类似问题时，应及时检查版本兼容性，并考虑提供最小可复现示例以便快速定位问题。同时，这也提醒我们在进行框架升级时，需要全面测试API文档生成功能，确保不影响API消费者对接口的理解和使用。