杰克逊 JSON 和 Hibernate JPA 问题的无限递归

JsonIgnoreProperties [2017 更新]：

您现在可以使用 JsonIgnoreProperties抑制属性的序列化（在序列化期间），或忽略对 JSON 属性读取的处理（在反序列化期间）。如果这不是您想要的，请继续阅读下文。

（感谢 As Zammel AlaaEddine 指出这一点）。

JsonManagedReference 和 JsonBackReference

从 Jackson 1.6 开始，您可以使用两个注释来解决无限递归问题，而无需在序列化期间忽略 getter/setter：@JsonManagedReference 和 @JsonBackReference。

解释

为了使 Jackson 正常工作，不应序列化关系的两侧之一，以避免导致您的 stackoverflow 错误的无限循环。

因此，Jackson 采用了引用的前向部分（您在 Trainee 类中的 Set<BodyStat> bodyStats），并将其转换为类似 json 的存储格式；这就是所谓的编组过程。然后，Jackson 查找引用的后面部分（即 BodyStat 类中的 Trainee trainee）并保持原样，而不是对其进行序列化。这部分关系将在前向引用的反序列化（unmarshalling）期间重新构建。

您可以像这样更改代码（我跳过了无用的部分）：

业务对象 1：

@Entity
@Table(name = "ta_trainee", uniqueConstraints = {@UniqueConstraint(columnNames = {"id"})})
public class Trainee extends BusinessObject {

    @OneToMany(mappedBy = "trainee", fetch = FetchType.EAGER, cascade = CascadeType.ALL)
    @Column(nullable = true)
    @JsonManagedReference
    private Set<BodyStat> bodyStats;

业务对象 2：

@Entity
@Table(name = "ta_bodystat", uniqueConstraints = {@UniqueConstraint(columnNames = {"id"})})
public class BodyStat extends BusinessObject {

    @ManyToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL)
    @JoinColumn(name="trainee_fk")
    @JsonBackReference
    private Trainee trainee;

现在一切都应该正常工作了。

如果您想了解更多信息，我写了一篇关于 Json and Jackson Stackoverflow issues on Keenformatics 的文章，我的博客。

编辑：

您可以检查的另一个有用的注释是 @JsonIdentityInfo：使用它，Jackson 每次序列化您的对象时，它都会向它添加一个 ID（或您选择的另一个属性），这样它就不会每次都完全“扫描”它。当您在更多相互关联的对象之间有一个链式循环时（例如：Order -> OrderLine -> User -> Order 并一遍又一遍），这可能很有用。

在这种情况下，您必须小心，因为您可能需要多次读取对象的属性（例如，在包含多个共享同一卖家的产品的产品列表中），并且此注释会阻止您这样做。我建议始终查看 firebug 日志以检查 Json 响应并查看代码中发生了什么。

资料来源：

Keenformatics - 如何解决 JSON 无限递归 Stackoverflow（我的博客）

杰克逊参考资料

个人经验

---

您可以使用 @JsonIgnore 打破循环 (reference)。

您需要导入 org.codehaus.jackson.annotate.JsonIgnore（旧版本）或 com.fasterxml.jackson.annotation.JsonIgnore（当前版本）。

---

新注释 @JsonIgnoreProperties 解决了其他选项的许多问题。

@Entity

public class Material{
   ...    
   @JsonIgnoreProperties("costMaterials")
   private List<Supplier> costSuppliers = new ArrayList<>();
   ...
}

@Entity
public class Supplier{
   ...
   @JsonIgnoreProperties("costSuppliers")
   private List<Material> costMaterials = new ArrayList<>();
   ....
}

在这里查看。它的工作原理与文档中的一样：
http://springquay.blogspot.com/2016/01/new-approach-to-solve-json-recursive.html

---

此外，使用 Jackson 2.0+，您可以使用 @JsonIdentityInfo。这对我的休眠类来说比 @JsonBackReference 和 @JsonManagedReference 好得多，这对我来说有问题并且没有解决问题。只需添加如下内容：

@Entity
@Table(name = "ta_trainee", uniqueConstraints = {@UniqueConstraint(columnNames = {"id"})})
@JsonIdentityInfo(generator=ObjectIdGenerators.IntSequenceGenerator.class, property="@traineeId")
public class Trainee extends BusinessObject {

@Entity
@Table(name = "ta_bodystat", uniqueConstraints = {@UniqueConstraint(columnNames = {"id"})})
@JsonIdentityInfo(generator=ObjectIdGenerators.IntSequenceGenerator.class, property="@bodyStatId")
public class BodyStat extends BusinessObject {

它应该可以工作。

---

此外，Jackson 1.6 支持 handling bi-directional references... 这似乎是您正在寻找的（this blog entry 也提到了该功能）

截至 2011 年 7 月，还有“jackson-module-hibernate”可能有助于处理 Hibernate 对象的某些方面，尽管不一定是这个特定的对象（它确实需要注释）。

---

现在杰克逊支持在不忽略字段的情况下避免循环：

Jackson - serialization of entities with birectional relationships (avoiding cycles)

---

这对我来说非常好。在您提到对父类的引用的子类上添加注释@JsonIgnore。

@ManyToOne
@JoinColumn(name = "ID", nullable = false, updatable = false)
@JsonIgnore
private Member member;

---

对我来说工作得很好Resolve Json Infinite Recursion problem when working with Jackson

这就是我在 oneToMany 和 ManyToOne 映射中所做的

@ManyToOne
@JoinColumn(name="Key")
@JsonBackReference
private LgcyIsp Key;


@OneToMany(mappedBy="LgcyIsp ")
@JsonManagedReference
private List<Safety> safety;

---

对我来说，最好的解决方案是使用 @JsonView 并为每个场景创建特定的过滤器。您也可以使用 @JsonManagedReference 和 @JsonBackReference，但它是一种硬编码解决方案，仅适用于一种情况，即所有者始终引用拥有方，而不是相反。如果您有另一个序列化场景，您需要以不同的方式重新注释属性，您将无法这样做。

问题

让我们使用两个类，Company 和 Employee，它们之间存在循环依赖关系：

public class Company {

    private Employee employee;

    public Company(Employee employee) {
        this.employee = employee;
    }

    public Employee getEmployee() {
        return employee;
    }
}

public class Employee {

    private Company company;

    public Company getCompany() {
        return company;
    }

    public void setCompany(Company company) {
        this.company = company;
    }
}

以及尝试使用 ObjectMapper (Spring Boot) 进行序列化的测试类：

@SpringBootTest
@RunWith(SpringRunner.class)
@Transactional
public class CompanyTest {

    @Autowired
    public ObjectMapper mapper;

    @Test
    public void shouldSaveCompany() throws JsonProcessingException {
        Employee employee = new Employee();
        Company company = new Company(employee);
        employee.setCompany(company);

        String jsonCompany = mapper.writeValueAsString(company);
        System.out.println(jsonCompany);
        assertTrue(true);
    }
}

如果您运行此代码，您将获得：

org.codehaus.jackson.map.JsonMappingException: Infinite recursion (StackOverflowError)

使用 `@JsonView` 的解决方案

@JsonView 使您能够使用过滤器并选择在序列化对象时应包含哪些字段。过滤器只是用作标识符的类引用。所以让我们首先创建过滤器：

public class Filter {

    public static interface EmployeeData {};

    public static interface CompanyData extends EmployeeData {};

} 

请记住，过滤器是虚拟类，仅用于指定带有 @JsonView 注释的字段，因此您可以根据需要创建任意数量的字段。让我们看看它的实际效果，但首先我们需要注释我们的 Company 类：

public class Company {

    @JsonView(Filter.CompanyData.class)
    private Employee employee;

    public Company(Employee employee) {
        this.employee = employee;
    }

    public Employee getEmployee() {
        return employee;
    }
}

并更改测试以使序列化程序使用视图：

@SpringBootTest
@RunWith(SpringRunner.class)
@Transactional
public class CompanyTest {

    @Autowired
    public ObjectMapper mapper;

    @Test
    public void shouldSaveCompany() throws JsonProcessingException {
        Employee employee = new Employee();
        Company company = new Company(employee);
        employee.setCompany(company);

        ObjectWriter writter = mapper.writerWithView(Filter.CompanyData.class);
        String jsonCompany = writter.writeValueAsString(company);

        System.out.println(jsonCompany);
        assertTrue(true);
    }
}

现在，如果您运行此代码，无限递归问题就解决了，因为您已经明确表示您只想序列化使用 @JsonView(Filter.CompanyData.class) 注释的属性。

当它到达 Employee 中公司的反向引用时，它会检查它是否没有注释并忽略序列化。您还可以使用强大而灵活的解决方案来选择要通过 REST API 发送的数据。

使用 Spring，您可以使用所需的 @JsonView 过滤器注释您的 REST 控制器方法，并将序列化透明地应用于返回的对象。

以下是您需要检查时使用的导入：

import static org.junit.Assert.assertTrue;

import javax.transaction.Transactional;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectWriter;

import com.fasterxml.jackson.annotation.JsonView;

---

现在有一个 Jackson 模块（用于 Jackson 2）专门设计用于在序列化时处理 Hibernate 延迟初始化问题。

https://github.com/FasterXML/jackson-datatype-hibernate

只需添加依赖项（注意 Hibernate 3 和 Hibernate 4 有不同的依赖项）：

<dependency>
  <groupId>com.fasterxml.jackson.datatype</groupId>
  <artifactId>jackson-datatype-hibernate4</artifactId>
  <version>2.4.0</version>
</dependency>

然后在初始化 Jackson 的 ObjectMapper 时注册模块：

ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new Hibernate4Module());

目前的文档不是很好。有关可用选项，请参阅 Hibernate4Module code。

---

@JsonIgnoreProperties 就是答案。

使用这样的东西::

@OneToMany(mappedBy = "course",fetch=FetchType.EAGER)
@JsonIgnoreProperties("course")
private Set<Student> students;

---

您应该将@JsonBackReference 与@ManyToOne 实体一起使用，并将@JsonManagedReference 与@onetomany 包含实体类一起使用。

@OneToMany(
            mappedBy = "queue_group",fetch = FetchType.LAZY,
            cascade = CascadeType.ALL
        )
    @JsonManagedReference
    private Set<Queue> queues;



@ManyToOne(cascade=CascadeType.ALL)
        @JoinColumn(name = "qid")
       // @JsonIgnore
        @JsonBackReference
        private Queue_group queue_group;

---

在我的情况下，改变关系就足够了：

@OneToMany(mappedBy = "county")
private List<Town> towns;

至：

@OneToMany
private List<Town> towns;

另一个关系保持原样：

@ManyToOne
@JoinColumn(name = "county_id")
private County county;

---

我也遇到了同样的问题。我使用了 @JsonIdentityInfo 的 ObjectIdGenerators.PropertyGenerator.class 生成器类型。

这就是我的解决方案：

@Entity
@Table(name = "ta_trainee", uniqueConstraints = {@UniqueConstraint(columnNames = {"id"})})
@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class Trainee extends BusinessObject {
...

---

确保在任何地方都使用 com.fasterxml.jackson。我花了很多时间才找到它。

<properties>
  <fasterxml.jackson.version>2.9.2</fasterxml.jackson.version>
</properties>

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-annotations -->
<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-annotations</artifactId>
    <version>${fasterxml.jackson.version}</version>
</dependency>

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>${fasterxml.jackson.version}</version>
</dependency>

然后使用 @JsonManagedReference 和 @JsonBackReference。

最后，您可以将模型序列化为 JSON：

import com.fasterxml.jackson.databind.ObjectMapper;

ObjectMapper mapper = new ObjectMapper();
String json = mapper.writeValueAsString(model);

---

您可以使用@JsonIgnore，但这将忽略由于外键关系而可以访问的json数据。因此，如果您需要外键数据（大多数情况下我们需要），那么 @JsonIgnore 将无济于事。在这种情况下，请遵循以下解决方案。

您将获得无限递归，因为 BodyStat 类再次引用了 Trainee 对象

身体状态

@ManyToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL)
@JoinColumn(name="trainee_fk")
private Trainee trainee;

实习生

@OneToMany(mappedBy = "trainee", fetch = FetchType.EAGER, cascade = CascadeType.ALL)
@Column(nullable = true)
private Set<BodyStat> bodyStats;

因此，您必须在 Trainee 中注释/省略上述部分

---

非常重要：如果您使用的是 LOMBOK，请确保排除 Set、List 等集合的属性...

像这样：

@EqualsAndHashCode(exclude = {"attributeOfTypeList", "attributeOfTypeSet"})

---

在做了更多分析后我也遇到了同样的问题，我知道，我们也可以通过在 OneToMany 注释中保留@JsonBackReference 来获取映射实体

@Entity
@Table(name = "ta_trainee", uniqueConstraints = {@UniqueConstraint(columnNames = {"id"})})
public class Trainee extends BusinessObject {

@Id
@GeneratedValue(strategy = GenerationType.TABLE)
@Column(name = "id", nullable = false)
private Integer id;

@Column(name = "name", nullable = true)
private String name;

@Column(name = "surname", nullable = true)
private String surname;

@OneToMany(mappedBy = "trainee", fetch = FetchType.EAGER, cascade = CascadeType.ALL)
@Column(nullable = true)
@JsonBackReference
private Set<BodyStat> bodyStats;

---

您可以使用 DTO 模式创建类 TraineeDTO 而无需任何注释休眠，您可以使用杰克逊映射器将 Trainee 转换为 TraineeDTO 并宾果游戏错误消息 disapeare :)

---

如果您无法忽略该属性，请尝试修改该字段的可见性。在我们的例子中，我们有旧代码仍然提交具有关系的实体，所以在我的例子中，这是修复：

    @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
    private Trainee trainee;

---

出于某种原因，就我而言，它不适用于 Set。我必须将其更改为 List 并使用 @JsonIgnore 和 @ToString.Exclude 才能使其正常工作。

用列表替换集合：

//before
@OneToMany(mappedBy="client")
private Set<address> addressess;

//after
@OneToMany(mappedBy="client")
private List<address> addressess;

并添加 @JsonIgnore 和 @ToString.Exclude 注释：

@ManyToOne
@JoinColumn(name="client_id", nullable = false)
@JsonIgnore
@ToString.Exclude
private Client client;

---

如果您使用 @JsonManagedReference、@JsonBackReference 或 @JsonIgnore 注释，它会忽略某些字段并使用 Jackson JSON 解决无限递归。

但是如果你使用 @JsonIdentityInfo 也避免了无限递归并且你可以获得所有字段值，所以我建议你使用 @JsonIdentityInfo 注释。

@JsonIdentityInfo(generator= ObjectIdGenerators.UUIDGenerator.class, property="@id")

请参阅这篇文章 https://www.toptal.com/javascript/bidirectional-relationship-in-json 以更好地了解 @JsonIdentityInfo 注释。

---

这篇文章：https://www.baeldung.com/jackson-bidirectional-relationships-and-infinite-recursion 有完整的解释。

如果您在旧版本中使用 Jackson，可以尝试 @jsonmanagedreference + @jsonbackreference。如果您的 Jackson 高于 2（我知道 1.9 也不起作用），请尝试使用 @JsonIdentityInfo。

---

我遇到了这个问题，但我不想在我的实体中使用注释，所以我通过为我的类创建一个构造函数来解决，这个构造函数不能引用回引用这个实体的实体。让我们说这个场景。

public class A{
   private int id;
   private String code;
   private String name;
   private List<B> bs;
}

public class B{
   private int id;
   private String code;
   private String name;
   private A a;
}

如果您尝试使用 @ResponseBody 将类 B 或 A 发送到视图，则可能会导致无限循环。您可以在您的类中编写一个构造函数，并像这样使用您的 entityManager 创建一个查询。

"select new A(id, code, name) from A"

这是带有构造函数的类。

public class A{
   private int id;
   private String code;
   private String name;
   private List<B> bs;

   public A(){
   }

   public A(int id, String code, String name){
      this.id = id;
      this.code = code;
      this.name = name;
   }

}

但是，这个解决方案有一些限制，如您所见，在构造函数中我没有引用 List bs 这是因为 Hibernate 不允许它，至少在版本 3.6.10.Final 中，所以当我需要为了在视图中显示这两个实体，我执行以下操作。

public A getAById(int id); //THE A id

public List<B> getBsByAId(int idA); //the A id.

此解决方案的另一个问题是，如果添加或删除属性，则必须更新构造函数和所有查询。

---

如果您使用 Spring Data Rest，可以通过为循环引用中涉及的每个实体创建存储库来解决问题。

---

我来晚了，这已经是一个很长的话题了。但是我也花了几个小时试图弄清楚这一点，并想举我的例子作为另一个例子。

我尝试了 JsonIgnore、JsonIgnoreProperties 和 BackReference 解决方案，但奇怪的是，它们好像没有被选中。

我使用了 Lombok 并认为它可能会干扰，因为它创建了构造函数并覆盖了 toString（在 stackoverflowerror 堆栈中看到了 toString）。

最后，这不是 Lombok 的错——我使用 NetBeans 从数据库表中自动生成 JPA 实体，没有考虑太多——好吧，添加到生成的类中的注释之一是 @XmlRootElement。一旦我删除它，一切都开始工作了。那好吧。

---

关键是将@JsonIgnore 放在setter 方法中，如下所示。就我而言。

乡镇.java

@Access(AccessType.PROPERTY)
@OneToMany(fetch = FetchType.LAZY)
@JoinColumn(name="townshipId", nullable=false ,insertable=false, updatable=false)
public List<Village> getVillages() {
    return villages;
}

@JsonIgnore
@Access(AccessType.PROPERTY)
public void setVillages(List<Village> villages) {
    this.villages = villages;
}

村庄.java

@ManyToOne(fetch = FetchType.EAGER)
@JoinColumn(name = "townshipId", insertable=false, updatable=false)
Township township;

@Column(name = "townshipId", nullable=false)
Long townshipId;

---

我遇到了同样的问题，添加 jsonbackref 和 jsonmanagedref 并请确保 @override 等于和 hashCode 方法，这绝对可以解决这个问题。

---