OpenAPI配置anyOf时如何避免可选响应字段返回null

响应中出现值为null的多余字段，核心原因有两点：

• OpenAPI代码生成器输出的ProfileMetrics数据类，将fieldProfileMetrics、summaryProfileMetrics两个属性的默认值都设为了null
• Spring Boot默认集成的Jackson JSON序列化器默认不会跳过null值属性，会把所有null字段也序列化到响应体中
  你写的OpenAPI Schema约束、Service层返回对象构造逻辑本身没有错误，问题出在序列化规则配置上。

按需选择以下任意一种方案，配置后即可实现「未赋值字段不返回，支持三种合法响应格式」的预期效果：

方案1：全局配置Jackson忽略null值（实现最简单，推荐） #

在Spring Boot配置文件中添加配置，让全局所有接口序列化时自动跳过null值，无需修改业务代码。
如果使用application.yml配置：

spring:
  jackson:
    default-property-inclusion: non_null

如果使用application.properties配置：

spring.jackson.default-property-inclusion=non_null

配置完成重启服务即可生效，你当前的业务代码不需要做任何调整。

方案2：仅对ProfileMetrics类生效（不影响全局序列化规则） #

如果不想修改全局序列化逻辑，只希望ProfileMetrics模型序列化时跳过null字段，可以配置OpenAPI生成插件，让自动生成的模型类自带指定的Jackson注解：
以Gradle插件为例，在openApiGenerate任务配置中添加如下参数：

openApiGenerate {
    configOptions.set(mapOf(
        "jackson" to "true",
        "additionalModelTypeAnnotations" to "@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)"
    ))
}

重新执行generate-sources任务后，生成的ProfileMetrics类会自动添加类级别的@JsonInclude(JsonInclude.Include.NON_NULL)注解，仅该类序列化时会过滤null字段，不会影响其他接口的序列化逻辑。

配置完成后三种请求场景的返回完全符合预期：

• 传入profile=field时，响应仅携带fieldProfileMetrics字段
• 传入profile=summary时，响应仅携带summaryProfileMetrics字段
• 不传profile参数时，两个字段都会正常返回
  不会再出现值为null的多余字段。

内容的提问来源于stack exchange，提问作者Akshay Hazari