如何消除REST API响应中的循环引用问题？

方法1：使用@JsonManagedReference和@JsonBackReference #

这是Jackson提供的专门处理双向关联的注解组合，通过明确父/子引用关系避免循环：

• 在父对象的关联字段上标注@JsonManagedReference：该字段会被正常序列化
• 在子对象的反向关联字段上标注@JsonBackReference：该字段会被忽略序列化，但不影响父对象的关联数据返回

代码示例：

// User 类（父对象）
public class User {
    private Long id;
    private String username;
    @JsonManagedReference
    private List<Role> roles;
    // Getters & Setters
}

// Role 类（子对象）
public class Role {
    private Long id;
    private String roleName;
    @JsonBackReference
    private User user;
    // Getters & Setters
}

方法2：使用@JsonIdentityInfo #

这个注解会给每个对象分配唯一标识（比如ID），当序列化遇到重复引用的对象时，直接输出该标识而非重复序列化整个对象，既保留关联关系又避免循环。

代码示例：

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class User {
    private Long id;
    private String username;
    private List<Role> roles;
    // Getters & Setters
}

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class Role {
    private Long id;
    private String roleName;
    private User user;
    // Getters & Setters
}

序列化后效果：第一次输出完整的User/Role对象，后续重复引用时只输出ID，比如：

{
  "id": 1,
  "username": "john",
  "roles": [
    {
      "id": 2,
      "roleName": "admin",
      "user": 1
    }
  ]
}

方法3：自定义DTO（数据传输对象） #

这是最灵活的方案，通过创建与实体类解耦的DTO类，严格控制返回字段，完全避免循环引用：

• 为User和Role分别创建DTO，比如UserDTO和RoleDTO
• 在DTO中只保留需要对外暴露的字段，关联字段只引用对方的简化版DTO（比如只包含ID、名称等核心信息）

代码示例：

// UserDTO
public class UserDTO {
    private Long id;
    private String username;
    private List<RoleSimpleDTO> roles;
    // Getters & Setters
}

// RoleSimpleDTO（简化版角色DTO）
public class RoleSimpleDTO {
    private Long id;
    private String roleName;
    // 可选：只保留用户的核心标识信息
    private Long userId;
    private String userUsername;
    // Getters & Setters
}

// 实体转DTO的工具方法（可手动实现或用MapStruct等框架）
public UserDTO userToDTO(User user) {
    UserDTO dto = new UserDTO();
    dto.setId(user.getId());
    dto.setUsername(user.getUsername());
    dto.setRoles(user.getRoles().stream()
        .map(role -> {
            RoleSimpleDTO roleDto = new RoleSimpleDTO();
            roleDto.setId(role.getId());
            roleDto.setRoleName(role.getRoleName());
            roleDto.setUserId(user.getId());
            roleDto.setUserUsername(user.getUsername());
            return roleDto;
        }).collect(Collectors.toList()));
    return dto;
}

这种方式可以完全按照你期望的接口返回结构定义DTO，既能保留关联数据，又彻底消除循环问题。

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