如何解决JPA双向关联循环引用问题？Jackson注解最佳实践详解

来源：建站技术作者：菲律宾程序员头衔：程序员
导读：本期聚焦于小伙伴创作的《如何解决JPA双向关联循环引用问题？Jackson注解最佳实践详解》，敬请观看详情，探索知识的价值。以下视频、文章将为您系统阐述其核心内容与价值。如果您觉得《如何解决JPA双向关联循环引用问题？Jackson注解最佳实践详解》有用，将其分享出去将是对创作者最好的鼓励。

在JPA实体设计中，双向关联是表达实体间关系的常用方式，比如一个用户可以有多个订单，同时每个订单都会关联所属的用户，这种双向关联在查询数据时能够带来很多便利，但在将实体序列化为JSON时，很容易出现循环引用的问题，导致序列化失败。

如何解决JPA双向关联循环引用问题？Jackson注解最佳实践详解

双向关联循环引用产生的原因

当Jackson尝试序列化双向关联的实体时，会陷入无限循环的引用链。比如序列化用户对象时，会去序列化用户的订单列表，而每个订单对象又会包含关联的用户对象，这个用户对象又会再去序列化它的订单列表，如此往复，最终触发栈溢出错误。

我们可以通过一个简单的实体示例来理解这个问题，首先是用户实体：

import javax.persistence.*;
import java.util.List;

@Entity
@Table(name = "t_user")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String username;

    // 一对多关联订单
    @OneToMany(mappedBy = "user")
    private List<Order> orders;

    // 省略getter和setter方法
}

然后是订单实体：

import javax.persistence.*;

@Entity
@Table(name = "t_order")
public class Order {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String orderNo;

    // 多对一关联用户
    @ManyToOne
    @JoinColumn(name = "user_id")
    private User user;

    // 省略getter和setter方法
}

使用Jackson注解解决循环引用

1. @JsonIgnore注解

@JsonIgnore是最简单的解决方式，它可以直接忽略指定属性的序列化。比如在订单实体的user字段上添加该注解，序列化订单时就不会再去序列化关联的用户对象，从而避免循环。

import com.fasterxml.jackson.annotation.JsonIgnore;
import javax.persistence.*;

@Entity
@Table(name = "t_order")
public class Order {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String orderNo;

    // 多对一关联用户，忽略该字段的序列化
    @ManyToOne
    @JoinColumn(name = "user_id")
    @JsonIgnore
    private User user;

    // 省略getter和setter方法
}

这种方式适合不需要在订单的JSON中展示用户信息的场景，但缺点是如果需要部分场景展示用户信息，部分场景不展示，就无法灵活适配。

2. @JsonIgnoreProperties注解

@JsonIgnoreProperties可以在类级别指定序列化时忽略的属性，比如在用户实体上指定忽略orders属性，或者在订单实体上指定忽略user属性，效果和@JsonIgnore类似，但可以批量指定多个忽略的属性。

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import javax.persistence.*;
import java.util.List;

@Entity
@Table(name = "t_user")
@JsonIgnoreProperties({"orders"}) // 序列化时忽略orders属性
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String username;

    @OneToMany(mappedBy = "user")
    private List<Order> orders;

    // 省略getter和setter方法
}

3. @JsonManagedReference和@JsonBackReference注解

这两个注解是配对使用的，用来标记双向关联的两端。@JsonManagedReference标记在关联的主体端（比如用户的orders属性），会被正常序列化；@JsonBackReference标记在关联的反向端（比如订单的user属性），序列化时会被忽略，反序列化时会被重新关联。

import com.fasterxml.jackson.annotation.JsonManagedReference;
import javax.persistence.*;
import java.util.List;

@Entity
@Table(name = "t_user")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String username;

    // 主体端，正常序列化
    @OneToMany(mappedBy = "user")
    @JsonManagedReference
    private List<Order> orders;

    // 省略getter和setter方法
}

import com.fasterxml.jackson.annotation.JsonBackReference;
import javax.persistence.*;

@Entity
@Table(name = "t_order")
public class Order {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String orderNo;

    // 反向端，序列化时忽略
    @ManyToOne
    @JoinColumn(name = "user_id")
    @JsonBackReference
    private User user;

    // 省略getter和setter方法
}

这种方式的好处是反序列化时可以自动恢复关联关系，适合需要双向序列化反序列化的场景。

4. @JsonIdentityInfo注解

@JsonIdentityInfo通过给每个对象添加唯一标识，在序列化时如果遇到已经序列化过的对象，就只输出标识而不再完整序列化，从而避免循环。通常和ObjectIdGenerators.PropertyGenerator配合使用，指定用实体的id作为唯一标识。

import com.fasterxml.jackson.annotation.JsonIdentityInfo;
import com.fasterxml.jackson.annotation.ObjectIdGenerators;
import javax.persistence.*;
import java.util.List;

@Entity
@Table(name = "t_user")
@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String username;

    @OneToMany(mappedBy = "user")
    private List<Order> orders;

    // 省略getter和setter方法
}

import com.fasterxml.jackson.annotation.JsonIdentityInfo;
import com.fasterxml.jackson.annotation.ObjectIdGenerators;
import javax.persistence.*;

@Entity
@Table(name = "t_order")
@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class Order {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String orderNo;

    @ManyToOne
    @JoinColumn(name = "user_id")
    private User user;

    // 省略getter和setter方法
}

这种方式会保留完整的关联结构，第一次出现时输出完整对象，后续出现时只输出id，适合需要保留关联关系且避免循环的场景。

不同注解的适用场景对比

注解适用场景优点缺点
@JsonIgnore完全不需要序列化某个关联属性使用简单，逻辑清晰不够灵活，无法适配多场景需求
@JsonIgnoreProperties需要批量忽略多个属性可以一次性指定多个忽略字段同样是类级别配置，灵活性不足
@JsonManagedReference+@JsonBackReference需要双向序列化反序列化，且反向端不需要展示反序列化可自动恢复关联反向端完全不会出现在JSON中
@JsonIdentityInfo需要保留完整关联结构，避免循环保留关联关系，适配多场景JSON结构会包含id标识，需要前端适配

最佳实践建议

在实际开发中，我们可以根据具体需求选择对应的注解：

  • 如果某个关联属性永远不需要序列化，优先使用@JsonIgnore，简单直接。
  • 如果需要保留双向关联且反序列化时需要恢复关系，使用@JsonManagedReference和@JsonBackReference组合。
  • 如果需要在JSON中保留关联结构，同时避免循环，优先使用@JsonIdentityInfo，适配性更强。
  • 尽量不要在实体类上直接添加过多Jackson注解，如果有多场景的序列化需求，可以定义专门的DTO类，在DTO上配置注解，避免污染实体类。

JPAJackson双向关联循环引用JsonIgnore修改时间：2026-06-15 11:21:23

免责声明：​ 已尽一切努力确保本网站所含信息的准确性。网站内容多为原创整理与精心编撰，观点力求客观中立。本站旨在免费分享，内容仅供个人学习、研究或参考使用。若引用了第三方作品，版权归原作者所有。如内容涉及您的权益，请联系我们处理。

上一篇Java基础中注释添加的位置以及原则详解

下一篇如何在Java开发中配置Redis测试环境并使用Testcontainers容器化测试

猜你喜欢

内容垂直聚焦
专注技术核心技术栏目，确保每篇文章深度聚焦于实用技能。从代码技巧到架构设计，为用户提供无干扰的纯技术知识沉淀，精准满足专业提升需求。
知识结构清晰
覆盖从开发到部署的全链路。AI、前端、编程、数据库、服务器、建站、系统层层递进，构建清晰学习路径，帮助用户系统化掌握开发与运维所需的核心技术。
深度技术解析
拒绝泛泛而谈，深入技术细节与实践难点。无论是数据库优化还是服务器配置，均结合真实场景与代码示例进行剖析，致力于提供可直接应用于工作的解决方案。
专业领域覆盖
精准对应开发生命周期。从前端界面到后端编程，从数据库操作到服务器运维，形成完整闭环，一站式满足全栈工程师和运维人员的技术需求。
即学即用高效
内容强调实操性，步骤清晰、代码完整。用户可根据教程直接复现和应用于自身项目，显著缩短从学习到实践的距离，快速解决开发中的具体问题。
持续更新保障
专注既定技术方向进行长期、稳定的内容输出。确保各栏目技术文章持续更新迭代，紧跟主流技术发展趋势，为用户提供经久不衰的学习价值。

负责任网站 - 免责声明 - 隐私政策 - 网站地图

举报邮箱：chomcom@qq.com

Copyright (C) www.ipipp.com All Rights Reserved.