當使用 Hibernate/JPA 實體類直接序列化為 JSON 時,雙向關聯(@OneToMany/@ManyToOne)會導致無限遞迴,拋出 StackOverflowError 或產生極大 JSON。本文說明原因、@JsonIgnore 用法、以及更推薦的 DTO/VO 分層方案。
@Entity
public class Author {
@Id Long id;
String name;
@OneToMany(mappedBy = "author")
List<Book> books; // 反向引用
}
@Entity
public class Book {
@Id Long id;
String title;
@ManyToOne
Author author; // 正向引用
}
序列化 Author → books → 每本 Book.author → 再次 Author.books … 形成循環。
@Entity
public class Author {
// ...
@OneToMany(mappedBy = "author")
@JsonIgnore // Jackson 序列化時忽略此字段
List<Book> books;
}
缺點:實體類耦合序列化邏輯;若不同 API 需不同輸出(如列表不含 books,詳情含 books),單一註解無法滿足。
@Entity
public class Author {
@OneToMany(mappedBy = "author")
@JsonManagedReference // 正向序列化
List<Book> books;
}
@Entity
public class Book {
@ManyToOne
@JsonBackReference // 反向不序列化,僅引用
Author author;
}
適用於固定的父子關係輸出。
永遠不要直接暴露實體類給 API 輸出。 建立獨立的 Data Transfer Object:
// API 輸出模型
public class AuthorVO {
Long id;
String name;
List<BookSummaryVO> books; // 僅包含必要欄位
}
public class BookSummaryVO {
Long id;
String title;
// 無 author 字段,打破循環
}
使用 MapStruct 或手動映射將 Entity → VO。優點:
@EntityGraph 或 join fetch)。@Bean
public Jackson2ObjectMapperBuilderCustomizer customizer() {
return builder -> builder
.serializationInclusion(JsonInclude.Include.NON_NULL)
.failOnEmptyBeans(false)
.featuresToDisable(SerializationFeature.FAIL_ON_SELF_REFERENCES);
}