Spring Boot整合Neo4j查询时出现双向关联无限循环问题

Spring Boot应用集成Neo4j数据库时，调用Neo4j Repository拉取嵌套关联数据会触发无限循环问题，具体场景如下：

业务规则 #

存在Person节点，单个Person节点可向其他Person节点发送访问请求。查询单个Person详情时，需要同时返回该用户向他人发出的访问请求、以及他人向该用户发送的所有访问请求数据。

原有实体代码 #

@Data
@Node
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Person {
    @Id
    @GeneratedValue
    private Long id;

    private String email;

    @Relationship(type = "ACCESS_REQUESTED", direction = Relationship.Direction.OUTGOING)
    @JsonProperty("requested_contacts")
    private List<AccessRequested> requestedContacts;

    @Relationship(type = "ACCESS_REQUESTED", direction = Relationship.Direction.INCOMING)
    @JsonProperty("contact_requests")
    private List<AccessRequested> contactRequests;
}

@RelationshipProperties
@Data
public class AccessRequested {
    @RelationshipId
    @GeneratedValue
    @JsonIgnore
    private Long id;

    @TargetNode
    private Person person;

    private String reason;
}

原有Repository定义 #

@Repository
public interface PersonRepository extends Neo4jRepository<Person, Long> {}

异常表现 #

业务层调用findById(Long id)方法查询数据时，只要被查询的Person存在和其他用户的访问请求关联关系，就会触发无限循环，返回的JSON结构出现无限递归嵌套，示例结构如下：

{
    "id": 13,
    "requested_contacts": [],
    "contact_requests": [
        {
            "person": {
                "id": 5,
                "requested_contacts": [
                    {
                        "person": {
                            "id": 13,
                            "requested_contacts": [],
                            "contact_requests": [
                                {
                                    "person": {
                                        "id": 5,
                                        "contact_cards": [],
                                        "requested_contacts": [
                                            {
                                                "person": {
                                                    "id": 13,
                                                    "requested_contacts": [],
                                                    "contact_requests": [
                                                        {
                                                            "person": {
                                                                "id": 5,
                                                                "contact_cards": [],
                                                                "requested_contacts": [
                                                                    {
                                                                        "person": {
                                                                            "id": 13,
                                                                                    …….

修复预期 #

解决无限递归问题，最终返回效果满足：查询返回的顶层Person对象包含全部字段，所有嵌套层级的Person对象仅返回id和email两个字段。

通过Jackson的JSON视图注解即可精准控制不同层级的序列化字段，无需修改Neo4j实体映射逻辑，实现步骤如下：

1. 定义视图类区分序列化层级

// 定义JSON序列化视图层级
public class View {
    // 嵌套关联对象使用的精简视图，仅保留基础字段
    public static class SimplifiedPerson {}
    // 顶层对象使用的完整视图，继承精简视图，包含全量关联字段
    public static class FullPerson extends SimplifiedPerson {}
}

2. 给实体类字段添加视图注解标记序列化范围

@Data
@Node
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Person {
    @Id
    @GeneratedValue
    // 基础字段在两个视图层级都需要返回
    @JsonView(View.SimplifiedPerson.class)
    private Long id;

    @JsonView(View.SimplifiedPerson.class)
    private String email;

    @Relationship(type = "ACCESS_REQUESTED", direction = Relationship.Direction.OUTGOING)
    @JsonProperty("requested_contacts")
    // 关联请求列表仅在顶层完整视图下序列化
    @JsonView(View.FullPerson.class)
    private List<AccessRequested> requestedContacts;

    @Relationship(type = "ACCESS_REQUESTED", direction = Relationship.Direction.INCOMING)
    @JsonProperty("contact_requests")
    @JsonView(View.FullPerson.class)
    private List<AccessRequested> contactRequests;
}

@RelationshipProperties
@Data
public class AccessRequested {
    @RelationshipId
    @GeneratedValue
    @JsonIgnore
    private Long id;

    @TargetNode
    // 关联的Person对象强制使用精简视图序列化，仅返回基础字段
    @JsonView(View.SimplifiedPerson.class)
    private Person person;

    // 请求原因字段在所有视图层级都需要返回
    @JsonView(View.SimplifiedPerson.class)
    private String reason;
}

3. 在对外返回的接口方法上指定使用完整视图

@GetMapping("/person/{id}")
@JsonView(View.FullPerson.class)
public Person getPersonById(@PathVariable Long id) {
    return personRepository.findById(id).orElseThrow();
}

实现原理：嵌套在AccessRequested里的Person对象被标记为精简视图，序列化时只会输出id、email这类基础字段，不会继续序列化关联的请求列表，从根源上切断递归循环，完全匹配返回要求。不要使用@JsonIgnore或者@JsonBackReference/@JsonManagedReference这类注解：前者会直接把顶层需要返回的关联字段屏蔽，后者仅能固定双向引用的序列化顺序，无法灵活实现嵌套对象仅返回基础字段的需求。

内容的提问来源于stack exchange，提问作者Apri