Jackson 的 JsonManagedReference 和 JsonBackReference 注解

在 Hibernate 或者 ORM 映射中,我们可能会存在 1 对多的情况。

在这个时候,如果你使用 Jackson 将对象序列化的时候,就会出现双向引用导致的无限递归(infinite recursion)的情况。

@JsonManagedReference@JsonBackReference 注解就是为了避免这个双向引用的情况。

@JsonBackReference@JsonManagedReference:这两个标注通常配对使用,通常用在父子关系中。

假设我们有 2 个对象。

一个对象是 QIndex 和 QTitle

一个 QIndex 可能对应有多个 QTitle。

那么在 JPA 中的对应关系的 QIndex 应该定义为:

    @OneToMany(mappedBy = "qIndex", cascade = CascadeType.ALL, orphanRemoval = true)
    @OrderBy("questionNumber ASC")
    @JsonManagedReference
    private List<QTitle> qTitleList = new ArrayList<>();

在 JPA 的 QTitle 中应该定义为:

    @ManyToOne()
    @JsonBackReference
    private QIndex qIndex;

在序列化的时候,@JsonManagedReference 注解的属性则会被序列化,@JsonBackReference 的注解将会被忽略。

@JsonManagedReference 注解,通常说明这个字段是一个双向引用的字段,这个字段在这个双向引用中的角色为 “父”,与这个字段对应的引用需要注解为 @JsonBackReference

@JsonBackReference 注解,通常说明这个字段是关联的一个双向引用字段,这个字段在这个双向引用的角色是 “孩子”。这个字段的值只能是对象(Bean),不能是 集合(Collection),图(Map),数组(Array)和枚举类型(enumeration)。

总结

  • @JsonManagedReference@JsonBackReference 总是成对出现的
  • @JsonManagedReference 定义在父级角色
  • @JsonBackReference 定义在孩子级角色
  • @JsonBackReference 不能使用任何集合和数组等的数据结构

有了上面的解释,应该比较容易的理解为了避免双向引用导致无限递归而出现的问题的。