调整Java中Swagger生成JSON响应方式以解决循环引用问题

嘿，我刚好在你这套技术栈（Swagger 2.0 YAML、swagger-codegen-cli v2.3.0、springfox 2.5.0）里踩过循环引用导致无限JSON的坑，给你几个亲测有效的解决方案：

Swagger 2.0本身没有内置的循环引用处理机制，最直接的方式是从API定义层面打破循环。比如：

原来的循环引用定义可能是这样的：

definitions:
  ObjectA:
    type: object
    properties:
      id:
        type: integer
      objectB:
        $ref: '#/definitions/ObjectB'
  ObjectB:
    type: object
    properties:
      id:
        type: integer
      objectA:
        $ref: '#/definitions/ObjectA'

你可以把其中一方的关联字段改成只返回ID，而非完整对象：

definitions:
  ObjectA:
    type: object
    properties:
      id:
        type: integer
      objectB:
        $ref: '#/definitions/ObjectB'
  ObjectB:
    type: object
    properties:
      id:
        type: integer
      objectAId:  # 替换为ID字段，避免完整ObjectA引用
        type: integer
        description: "关联的ObjectA的ID"

这种方式无需后续代码调整，但要确保API调用方接受这种数据结构的变化。

swagger-codegen-cli v2.3.0支持生成带Jackson注解的代码，你可以先开启配置，再手动补充循环引用相关注解：

1. 生成代码时添加jacksonAnnotations=true参数：

java -jar swagger-codegen-cli-2.3.0.jar generate \
  -i your-swagger.yaml \
  -l spring \
  -o your-api-project \
  --additional-properties jacksonAnnotations=true

2. 在生成的模型类中，给双向关联字段添加@JsonManagedReference和@JsonBackReference：

// ObjectA.java
public class ObjectA {
    private Integer id;
    @JsonManagedReference  // 标记为主动引用，正常序列化
    private ObjectB objectB;
    // getter/setter
}

// ObjectB.java
public class ObjectB {
    private Integer id;
    @JsonBackReference  // 标记为被动引用，序列化时跳过
    private ObjectA objectA;
    // getter/setter
}

Jackson会自动识别这对注解，避免无限递归生成JSON。

springfox 2.5.0依赖Jackson处理JSON序列化，你可以通过Spring全局配置统一处理循环引用：

创建Jackson配置类：

@Configuration
public class JacksonCycleConfig {
    @Bean
    public Jackson2ObjectMapperBuilderCustomizer cycleHandlingCustomizer() {
        return builder -> {
            // 可选INCLUDE（用ID标记重复引用）或IGNORE（跳过重复对象）
            builder.referenceCycleHandling(ReferenceCycleHandling.INCLUDE);
            // 可选：忽略空字段，精简JSON输出
            builder.serializationInclusion(JsonInclude.Include.NON_NULL);
        };
    }
}

或者给模型类添加@JsonIdentityInfo注解，让Jackson用对象ID标记重复引用：

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class ObjectA {
    private Integer id;
    private ObjectB objectB;
    // getter/setter
}

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class ObjectB {
    private Integer id;
    private ObjectA objectA;
    // getter/setter
}

这种方式不需要修改API定义，适合需要保留完整对象关联关系的场景。

内容的提问来源于stack exchange，提问作者Daniel Törws