Spring Boot JPA多对多关联下Jackson序列化无限循环如何解决
多对多关联Jackson无限序列化循环解决方案
你之前使用的@JsonManagedReference和@JsonBackReference不适合多对多场景的原因是:这组注解会完全截断反向关联的序列化,会导致其中一方的关联字段完全不会出现在返回结果中,以下提供三种低侵入的解决方案:
方案1:使用@JsonIdentityInfo注解(推荐,适配多对多场景,无业务侵入)
该注解是Jackson原生提供的能力,序列化时会给每个对象分配唯一标识(比如实体id),第二次遇到同一个对象时会直接用标识代替,不会重复展开序列化,既可以避免循环,又可以保留关联关系的基本信息,完全不需要修改Repository和查询逻辑。
只需要在两个实体类上添加注解即可:
import com.fasterxml.jackson.annotation.JsonIdentityInfo; import com.fasterxml.jackson.annotation.ObjectIdGenerators; @Entity @JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id") public class Room { @Id @GeneratedValue(strategy = GenerationType.AUTO) private long id; private String name; @ManyToMany(mappedBy = "rooms") private Set<Team> teams; // 省略getter、setter }
@Entity @JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id") public class Team { @Id @GeneratedValue(strategy = GenerationType.AUTO) private long id; private String name; @ManyToMany @JoinTable(name = "teams_rooms", joinColumns = @JoinColumn(name= "team_id"), inverseJoinColumns = @JoinColumn(name = "room_id")) private Set<Room> rooms; // 省略getter、setter }
序列化后的结果示例:
{ "id": 1, "name": "Team1", "rooms": [ { "id": 1, "name": "Room 1", "teams": [1] } ] }
方案2:对不需要序列化的反向字段加@JsonIgnore
如果你的业务场景中查询会议室时不需要返回关联的团队列表,直接在Room类的teams字段上加@JsonIgnore注解即可,序列化时会直接忽略该字段,自然不会产生循环:
@Entity public class Room { @Id @GeneratedValue(strategy = GenerationType.AUTO) private long id; private String name; @JsonIgnore @ManyToMany(mappedBy = "rooms") private Set<Team> teams; }
该方案改动极小,缺点是后续如果有需要返回会议室关联团队的接口时无法支持,适合明确不需要反向序列化的场景。
方案3:使用DTO做结果投影(完全解耦,最规范)
如果你不想修改实体类的任何注解,可以自定义DTO类专门承接接口返回结果,查询到实体后手动转换为DTO再返回,完全避免实体类关联关系的影响:
// 团队返回DTO public class TeamDTO { private Long id; private String name; private List<RoomDTO> rooms; // 省略getter、setter } // 会议室返回DTO public class RoomDTO { private Long id; private String name; // 不需要定义teams字段,自然不会循环 // 省略getter、setter }
控制器代码改造:
@GetMapping public ResponseEntity<TeamDTO> getAllRoomsOfTeam() { final long exampleId = 1; final Team team = teamRepository.findById(exampleId).orElseThrow(); // 实体转DTO TeamDTO teamDTO = new TeamDTO(); teamDTO.setId(team.getId()); teamDTO.setName(team.getName()); teamDTO.setRooms(team.getRooms().stream().map(room -> { RoomDTO roomDTO = new RoomDTO(); roomDTO.setId(room.getId()); roomDTO.setName(room.getName()); return roomDTO; }).collect(Collectors.toList())); return ResponseEntity.ok(teamDTO); }
该方案完全不影响原有实体、Repository逻辑,缺点是需要额外编写转换代码,适合对接口返回格式有定制要求的场景。
内容的提问来源于stack exchange,提问作者Manuel
相关产品推荐
相关产品推荐

