解决Spring JPA与Jackson序列化中的无限递归问题-java教程-PHP中文网

解决Spring JPA与Jackson序列化中的无限递归问题

针对spring jpa实体间双向关联导致的jackson序列化无限递归问题，本文将深入探讨其成因，并提供两种主要解决方案：使用`@jsonmanagedreference`和`@jsonbackreference`注解管理json序列化，以及通过lombok的`@equalsandhashcode(of = "id")`和`@tostring(of = "id")`注解优化实体类，从而有效避免`stackoverflowerror`，确保数据正确传输。

理解无限递归问题

在Spring Data JPA应用中，当实体之间存在双向关联（例如@OneToMany、@ManyToOne或@ManyToMany）时，使用Jackson库将这些实体序列化为JSON时，极易发生“无限递归”（Infinite Recursion）错误，通常表现为StackOverflowError。

问题根源： 以Project和Technology实体为例，它们之间存在@ManyToMany双向关联：

Project实体包含一个Set<Technology>。
Technology实体包含一个Set<Project>。

当Jackson尝试序列化一个Project对象时，它会遍历并序列化其assignedTechnologies集合中的每一个Technology对象。接着，当Jackson序列化某个Technology对象时，又会尝试序列化其projects集合中的每一个Project对象，其中就包含了最初被序列化的那个Project。如此循环往复，导致调用栈不断增长，最终耗尽内存，抛出StackOverflowError。

错误示例：

Could not write JSON: Infinite recursion (StackOverflowError); nested exception is com.fasterxml.jackson.databind.JsonMappingException: Infinite recursion (StackOverflowError) (through reference chain: java.util.ArrayList[0]->com.example.technologyradar.model.Project["assignedTechnologies"])

登录后复制

此错误信息清晰地指出了序列化链条ArrayList[0]->Project["assignedTechnologies"]中存在无限递归。

解决方案一：使用Jackson注解处理循环引用

Jackson提供了一对注解@JsonManagedReference和@JsonBackReference，专门用于处理对象图中的双向循环引用。它们的工作原理是：

@JsonManagedReference: 标记关系中的“主控方”或“父”端。当序列化时，此端会被完全序列化，包括其关联对象。
@JsonBackReference: 标记关系中的“被控方”或“子”端。当序列化时，此端会忽略其关联对象，从而打破循环。

应用示例：

假设我们希望在序列化Project时包含其关联的Technology，而在序列化Technology时，不重复序列化其关联的Project（或者只序列化Project的ID等简单信息）。我们可以将Project作为“主控方”。

1. 修改 Project 实体：

在Project实体的assignedTechnologies字段上添加@JsonManagedReference。

package com.example.technologyradar.model;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.annotations.GenericGenerator;
import com.fasterxml.jackson.annotation.JsonManagedReference; // 导入Jackson注解

import javax.persistence.*;
import java.util.HashSet;
import java.util.Set;

@Entity
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Project {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO, generator = "native")
    @GenericGenerator(name="native", strategy = "native")
    private Long id;

    private String name;

    @ManyToMany(mappedBy = "projects")
    @JsonManagedReference // 主控方：序列化时包含关联的Technology
    private Set<Technology> assignedTechnologies = new HashSet<>();
}

登录后复制

2. 修改 Technology 实体：

在Technology实体的projects字段上添加@JsonBackReference。

序列猴子开放平台

具有长序列、多模态、单模型、大数据等特点的超大规模语言模型

查看详情

package com.example.technologyradar.model;

import com.example.technologyradar.dto.constant.TechnologyStatus;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.annotations.GenericGenerator;
import com.fasterxml.jackson.annotation.JsonBackReference; // 导入Jackson注解

import javax.persistence.*;
import java.util.HashSet;
import java.util.Set;

@Entity
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Technology {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO, generator = "native")
    @GenericGenerator(name="native", strategy = "native")
    private Long id;

    private String name;

    @Enumerated(EnumType.STRING)
    private TechnologyStatus technologyStatus;

    @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.PERSIST, targetEntity = Category.class)
    @JoinColumn(name="category_id", referencedColumnName = "id", nullable = false)
    private Category category;

    @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.PERSIST, targetEntity = Coordinate.class)
    @JoinColumn(name="coordinate_id", referencedColumnName = "id", nullable = false)
    private Coordinate coordinate;

    @ManyToMany
    @JoinTable(
            name = "projects_technologies",
            joinColumns = @JoinColumn(name="technology_id"),
            inverseJoinColumns = @JoinColumn(name="project_id")
    )
    @JsonBackReference // 被控方：序列化时忽略关联的Project，打破循环
    private Set<Project> projects = new HashSet<>();
}

登录后复制

通过这种方式，当序列化Project对象时，其assignedTechnologies会被完全序列化。而当序列化Technology对象时，其projects字段则会被忽略，从而避免了循环引用。

解决方案二：优化Lombok注解以避免潜在问题

虽然Jackson注解是解决序列化无限递归的核心，但Lombok的@EqualsAndHashCode和@ToString注解在实体类中的使用也需要注意。如果这些方法在生成时包含了双向关联字段，它们自身也可能导致循环调用，尤其是在调试、日志记录或某些特定场景下。

为了避免这种情况，推荐将equals()、hashCode()和toString()方法的生成限制在仅依赖实体的主键（通常是id字段）。

1. 修改 Project 实体：

package com.example.technologyradar.model;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.EqualsAndHashCode; // 导入Lombok注解
import lombok.ToString;         // 导入Lombok注解
import org.hibernate.annotations.GenericGenerator;
import com.fasterxml.jackson.annotation.JsonManagedReference;

import javax.persistence.*;
import java.util.HashSet;
import java.util.Set;

@Entity
@Data
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode(of = "id") // 仅基于id生成equals和hashCode
@ToString(of = "id")         // 仅基于id生成toString
public class Project {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO, generator = "native")
    @GenericGenerator(name="native", strategy = "native")
    private Long id;

    private String name;

    @ManyToMany(mappedBy = "projects")
    @JsonManagedReference
    private Set<Technology> assignedTechnologies = new HashSet<>();
}

登录后复制

2. 修改 Technology 实体：

同样地，对Technology实体也进行优化。

package com.example.technologyradar.model;

import com.example.technologyradar.dto.constant.TechnologyStatus;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.EqualsAndHashCode;
import lombok.ToString;
import org.hibernate.annotations.GenericGenerator;
import com.fasterxml.jackson.annotation.JsonBackReference;

import javax.persistence.*;
import java.util.HashSet;
import java.util.Set;

@Entity
@Data
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode(of = "id") // 仅基于id生成equals和hashCode
@ToString(of = "id")         // 仅基于id生成toString
public class Technology {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO, generator = "native")
    @GenericGenerator(name="native", strategy = "native")
    private Long id;

    private String name;

    @Enumerated(EnumType.STRING)
    private TechnologyStatus technologyStatus;

    @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.PERSIST, targetEntity = Category.class)
    @JoinColumn(name="category_id", referencedColumnName = "id", nullable = false)
    private Category category;

    @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.PERSIST, targetEntity = Coordinate.class)
    @JoinColumn(name="coordinate_id", referencedColumnName = "id", nullable = false)
    private Coordinate coordinate;

    @ManyToMany
    @JoinTable(
            name = "projects_technologies",
            joinColumns = @JoinColumn(name="technology_id"),
            inverseJoinColumns = @JoinColumn(name="project_id")
    )
    @JsonBackReference
    private Set<Project> projects = new HashSet<>();
}

登录后复制

重要提示：

@EqualsAndHashCode(of = "id")：确保在集合（如HashSet）中比较实体或进行其他equals操作时，不会因遍历关联对象而触发循环。
@ToString(of = "id")：防止在打印实体对象时（例如日志输出）因尝试打印关联对象而引发无限递归或懒加载问题。

其他考虑和最佳实践

除了上述核心解决方案，还有一些其他方法和最佳实践可以帮助管理实体序列化：

DTO (Data Transfer Object) 模式： 这是最推荐的实践。将实体对象与API响应解耦。为每个API端点创建专门的DTO，只包含需要暴露给客户端的数据。这样可以精确控制序列化的内容，避免暴露敏感信息，并完全规避实体层面的循环引用问题。例如，创建一个ProjectDTO，其中只包含TechnologyDTO的列表，而TechnologyDTO只包含Technology的简单信息（如ID、名称），不包含Project列表。
@JsonIgnore 注解： 如果某个关联字段在任何情况下都不需要被序列化，可以直接在其上添加@JsonIgnore。这是最简单粗暴的方法，但会彻底隐藏该字段。
```
// 在Technology实体中
@ManyToMany
@JsonIgnore // 完全忽略此字段的序列化
private Set<Project> projects = new HashSet<>();
```
登录后复制
@JsonIdentityInfo 注解： 此注解可以为每个对象生成一个唯一的标识符，并在序列化时使用此标识符来表示已序列化过的对象，从而处理循环引用。它会为每个对象创建一个ID字段，并在后续引用中只输出ID。
```
// 在Project实体中
@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class Project { /* ... */ }

// 在Technology实体中
@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class Technology { /* ... */ }
```
登录后复制
这种方法会改变JSON的结构，为每个对象添加一个id字段（如果它不是主键）。
懒加载（Lazy Loading）： JPA的@ManyToMany默认是懒加载（FetchType.LAZY）。这意味着关联对象在被访问之前不会从数据库加载。然而，如果您的业务逻辑或序列化器在序列化过程中不小心触发了懒加载（例如，通过调用getAssignedTechnologies()），并且此时会话已经关闭（No Session错误），或者在开启会话的情况下仍然存在循环，问题依然会出现。上述Jackson注解主要解决的是JSON序列化器在遍历对象图时的循环问题，与JPA的加载策略是不同层面的问题。

总结

处理Spring JPA实体与Jackson序列化中的无限递归问题是构建健壮RESTful API的关键一环。最直接有效的解决方案是利用Jackson的@JsonManagedReference和@JsonBackReference注解来明确控制双向关联的序列化行为。同时，通过Lombok的@EqualsAndHashCode(of = "id")和@ToString(of = "id")注解优化实体类，可以避免在其他场景下可能出现的循环引用或性能问题。对于更复杂的场景，采用DTO模式是最佳实践，它提供了最大的灵活性和控制力，能够彻底将内部实体结构与外部API响应解耦。理解并正确应用这些策略，将帮助开发者构建出高效、稳定的数据交互层。

以上就是解决Spring JPA与Jackson序列化中的无限递归问题的详细内容，更多请关注php中文网其它相关文章！

大家都在看：

使用MPXJ在Java中生成MS Project文件并默认显示特定列的教程 Java中后缀表达式求值：解决字符数值转换错误 Java中利用正则表达式实现精确空白符分割：避免过度移除的策略 Java代码优化实践：通过接口和辅助方法重构重复逻辑 Java方法重构实践：统一处理多类型参数的策略