介绍

Spring Boot 是一种广泛使用的框架，用于构建独立的、可用于生产的 Java 应用程序，它与 Jackson 库无缝集成以进行对象序列化和反序列化。在处理复杂的对象图时，@JsonIdentityInfo注释在管理数据完整性和避免无限循环方面发挥着关键作用。在这篇文章中，我们将深入研究此注释的实际应用，并了解它如何显着增强您的 Spring Boot 项目。

@JsonIdentityInfo简介

在基于 Spring Boot 构建的现代 Web 应用程序中，服务器和客户端之间的数据交换通常依赖于 JSON 作为标准介质。尽管 JSON 是轻量级且易于理解，但 Java 类和 JSON 之间的对象关系映射可能会变得复杂。Jackson 库是 Spring Boot 的一个组成部分，充当对象序列化（Java 到 JSON）和反序列化（JSON 到 Java）的主力。其强大的功能之一是能够通过@JsonIdentityInfo注释管理对象身份。

什么是对象身份？

对象标识是指给定上下文中对象实例的唯一性。在处理复杂的数据模型（例如嵌套或相互关联的 Java 对象）时，保持这种唯一性至关重要，尤其是在序列化和反序列化过程中。这个概念不仅限于像User或 之类的琐碎模型Product；它还适用于复杂的场景，如双向关系、循环依赖和对象图。

Jackson 默认如何处理对象身份？

默认情况下，Jackson 将每个对象作为单独的实例进行处理，并且不考虑其身份。此行为可能会导致问题，例如序列化期间的无限循环，尤其是当对象之间具有双向关系时。发生无限循环是因为每个对象都尝试序列化其相关对象，从而创建无限的序列化链。

@JsonIdentityInfo 的作用

注释@JsonIdentityInfo在解决此类问题中起着至关重要的作用。它使杰克逊能够记住每个序列化对象的身份。当遇到已经序列化的对象时，Jackson 不会尝试再次序列化它。相反，它将用标识符替换对象，从而在整个序列化过程中保持对象的唯一性。

这是一个简单的例子来展示其基本用法：

import com.fasterxml.jackson.annotation.JsonIdentityInfo;
import com.fasterxml.jackson.annotation.ObjectIdGenerators;
@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class User {
    private Integer id;
    private String name; // Getters and setters}
}

在这个增强的示例中，该类User用 进行注释@JsonIdentityInfo，它指定该id属性将在序列化和反序列化期间充当每个User实例的唯一标识符。

@JsonIdentityInfo 中的生成器

注释中的属性generator指定如何生成对象 ID。在我们的示例中，ObjectIdGenerators.PropertyGenerator.class意味着将根据对象的属性（在本例中为属性）生成对象 ID id。Jackson 还提供其他生成器，例如IntSequenceGenerator和UUIDGenerator，在生成对象 ID 方面提供了灵活性。

为什么使用@JsonIdentityInfo？— 解决无限循环问题

JSON 数据结构本质上是树形的，但我们应用程序中的对象模型并不总是与这种层次结构完美对齐。当我们处理 Java 类中的双向关系和循环依赖关系时，这种差异变得非常明显。在这种情况下，简单的序列化方法可能会导致堆栈溢出错误、无限循环或异常大的 JSON 有效负载。让我们更详细地研究这些问题并了解如何@JsonIdentityInfo解决我们的问题。

无限循环的问题

假设您正在构建一个社交网络应用程序，其中一个User类包含对User代表朋友的其他实例的引用。一个简单的序列化如下所示：

public class User {
        private Integer id;
        private String name;
        private List<User> friends; // Getters and setters}
}

如果爱丽丝是鲍勃的朋友，而鲍勃是爱丽丝的朋友，则序列化爱丽丝的User对象也需要序列化鲍勃的User对象，这反过来又需要序列化爱丽丝，如此下去。序列化器将进入无限循环，最终导致堆栈溢出错误。

传统解决方案及其局限性

在深入研究之前@JsonIdentityInfo，有必要了解一些解决此问题的传统方法：

• 手动过滤：可以有选择地序列化属性，故意忽略导致循环的属性。虽然这种方法有效，但它缺乏优雅性，并且可能需要大量手动代码，从而容易出错。
• DTO（数据传输对象）：另一种方法是创建一个单独的数据结构，仅用于传输，从而扁平化或简化对象图。虽然有效，但这种方法可能会带来额外的复杂性。
• @JsonIgnore：Jackson 提供了@JsonIgnore在序列化过程中排除某些字段的注释。但使用它可能是一把双刃剑，因为它会从序列化和反序列化中删除属性，通常会导致有价值的数据丢失。

输入@JsonIdentityInfo

借助@JsonIdentityInfo，您可以有效地管理对象标识，而无需求助于这些手动解决方案。当 Jackson 遇到带有 注释的对象时@JsonIdentityInfo，它会跟踪该对象的身份。第一次出现的情况会正常序列化，后续出现的情况会被替换为身份引用，从而防止无限循环。

以下是如何注释类User以避免无限循环：

@JsonIdentityInfo(@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class User{
      private  Integer id;
      private String name;
      private List<User>friends; // Getters and setters
}

通过使用@JsonIdentityInfo，您不仅可以避免无限循环，还可以维护对象图中的双向引用，从而生成正确且有意义的 JSON 表示形式。

使用 @JsonIdentityInfo 的基础知识

添加@JsonIdentityInfo到您的类是影响 Jackson 的序列化和反序列化行为的直接方法。然而，注释提供的底层机制和选择要微妙得多。本节将讨论如何实现@JsonIdentityInfo、它支持的属性以及一些需要注意的常见注意事项。

基本实现

要注释一个类，只需将@JsonIdentityInfo注释添加到类定义上方，如下所示：

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class Department {
    private Integer id;
    private String name;
    private List<Employee> employees;  // Getters and setters
}

在此示例中，我们添加了@JsonIdentityInfo一个Department类，指定该类的实例的唯一标识符将是属性id。

@JsonIdentityInfo 的关键属性

该@JsonIdentityInfo注释提供了几个用于细粒度控制的属性：

• 生成器：ObjectIdGenerator指定用于生成对象 ID的类型。最常见的是ObjectIdGenerators.PropertyGenerator.class，它根据对象内的属性生成 ID。
• property：指定用作对象标识符的属性。通常，这将是一个独特的属性，例如id.
• 范围：（可选）定义对象 ID 需要唯一的范围。默认为Object.class，表示全局唯一。
• 解析器：（可选）指定自定义ObjectIdResolver来管理对象 ID。这允许自定义策略来管理对象身份。

常见用例

虽然@JsonIdentityInfo经常用于避免无限循环，但它也有其他用途：

• 优化有效负载：当同一对象实例在数据结构中重复多次时，@JsonIdentityInfo确保对象仅序列化一次，从而优化 JSON 有效负载的大小。
• 数据完整性：如果您需要在生成的 JSON 中保持关系一致性，此注释可确保正确表示对象的关系。

注意事项和陷阱

• 数据库 ID 依赖：如果您的标识符 ( propertyin @JsonIdentityInfo) 是数据库生成的，则在持久化对象之前的反序列化过程中可能会遇到问题。
• 线程安全：Jackson 的对象标识的默认行为不是线程安全的。如果您需要在多线程环境中处理对象标识，则可能需要实现自定义解决方案。

现实世界的例子

理解背后的理论@JsonIdentityInfo至关重要，但没有什么比实际例子更能说明问题了。让我们考虑一些现实世界的用例，在这些用例中，该注释被证明是非常有价值的。

示例 1：博客平台中的双向关系

想象一个博客平台，其中一个人Author写了多个内容Articles，每个人都Article引用了它的Author。

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class Author {
    private Integer id;
    private String name;
    private List<Article> articles;// Getters and setters
}
@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class Article {
    private Integer id;
    private String title;
    private Author author; // Getters and setters}
}

如果没有@JsonIdentityInfo，序列化 anAuthor将包括它们的所有Articles，并且每个Article将包括Author，导致无限循环。使用@JsonIdentityInfo，JSON 输出将保持对象标识，避免循环。

示例 2：电子商务系统中的订单和产品关系

在电子商务应用程序中， anOrder包含多个Product实例，每个实例Product可以是多个Orders.

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class Order {
    private Integer id;
    private List<Product> products; // Getters and setters
}
@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class Product {
    private Integer id;
    private String name;
    private List<Order> orders; // Getters and setters
}

这里，@JsonIdentityInfo防止冗余并确保同一个Product对象出现在不同的Orders.

示例 3：公司层级中的员工与经理关系

anEmployee有一个Manager，每个Manager可以管理多个Employees。

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class Employee {
    private Integer id;
    private String name;
    private Manager manager; // Getters and setters
}
@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class Manager {
    private Integer id;
    private String name;
    private List<Employee> subordinates; // Getters and setters
}

同样，使用@JsonIdentityInfo通过维护对象的标识来解决无限递归的问题。

结论

Spring Boot 中的注释@JsonIdentityInfo提供了一种强大的方法来处理复杂对象图中的 JSON 序列化和反序列化。它对于解决由对象之间的双向关系引起的无限循环问题特别有用。通过为每个对象指定唯一标识符，您可以让 Jackson 在序列化过程中维护对象标识，从而产生更清晰、更易于管理的 JSON 输出。

了解如何以及何时使用@JsonIdentityInfo可以显着提高 Spring Boot 应用程序的质量，使您能够以更有效的方式处理复杂的对象关系。