Spring Data 对象映射基础

本节涵盖 Spring Data 对象映射、对象创建、字段和属性访问、可变性和不变性的基础知识。

Spring Data 对象映射的核心职责是创建领域对象实例，并将存储原生数据结构映射到这些实例上。这意味着我们需要两个基本步骤

通过使用公开的构造函数之一创建实例。
实例填充以具体化所有公开的属性。

对象创建

Spring Data 会自动尝试检测持久化实体的构造函数，该构造函数将用于具体化该类型的对象。解析算法的工作方式如下

如果存在无参数构造函数，则将使用它。其他构造函数将被忽略。
如果存在单个带参数的构造函数，则将使用它。
如果存在多个带参数的构造函数，则 Spring Data 将使用的那个必须用 @PersistenceCreator 进行注释。

值解析假定构造函数参数名与实体的属性名匹配，即解析将按照属性将要填充的方式执行，包括映射中的所有自定义（不同的数据存储列或字段名等）。这还要求类文件中提供参数名信息，或者构造函数上存在 @ConstructorProperties 注解。

对象创建内部

为了避免反射的开销，Spring Data 对象创建默认使用运行时生成的工厂类，该类将直接调用域类的构造函数。即，对于此示例类型

class Person {
  Person(String firstname, String lastname) { … }
}

我们将在运行时创建一个在语义上等同于此的工厂类

class PersonObjectInstantiator implements ObjectInstantiator {

  Object newInstance(Object... args) {
    return new Person((String) args[0], (String) args[1]);
  }
}

这使我们获得了大约 10% 的反射性能提升。为了使领域类符合此优化条件，它需要遵循一组约束

它不能是私有类
它不能是非静态内部类
它不能是 CGLib 代理类
Spring Data 将使用的构造函数不能是私有的

如果以上任何标准匹配，Spring Data 将回退到通过反射实例化实体。

属性填充

一旦创建了实体实例，Spring Data 会填充该类的所有剩余持久化属性。除非已由实体的构造函数填充（即通过其构造函数参数列表消耗），否则将首先填充标识符属性，以允许解析循环对象引用。之后，所有尚未由构造函数填充的非瞬态属性将在实体实例上设置。为此，我们使用以下算法

如果属性是不可变的但公开了一个 wither 方法（见下文），我们使用 wither 创建一个具有新属性值的新实体实例。
如果定义了属性访问（即通过 getter 和 setter 访问），我们正在调用 setter 方法。
默认情况下，我们直接设置字段值。

属性填充内部

与我们的对象构造优化类似，我们还使用 Spring Data 运行时生成的访问器类与实体实例进行交互。

class Person {

  private final Long id;
  private String firstname;
  private @AccessType(Type.PROPERTY) String lastname;

  Person() {
    this.id = null;
  }

  Person(Long id, String firstname, String lastname) {
    // Field assignments
  }

  Person withId(Long id) {
    return new Person(id, this.firstname, this.lastame);
  }

  void setLastname(String lastname) {
    this.lastname = lastname;
  }
}

示例 1. 生成的属性访问器

class PersonPropertyAccessor implements PersistentPropertyAccessor {

  private static final MethodHandle firstname;              (2)

  private Person person;                                    (1)

  public void setProperty(PersistentProperty property, Object value) {

    String name = property.getName();

    if ("firstname".equals(name)) {
      firstname.invoke(person, (String) value);             (2)
    } else if ("id".equals(name)) {
      this.person = person.withId((Long) value);            (3)
    } else if ("lastname".equals(name)) {
      this.person.setLastname((String) value);              (4)
    }
  }
}

1	PropertyAccessor 包含底层对象的可变实例。这是为了允许修改原本不可变的属性。
2	默认情况下，Spring Data 使用字段访问来读取和写入属性值。根据 `private` 字段的可见性规则，使用 `MethodHandles` 与字段交互。
3	该类公开了一个 `withId(…)` 方法，用于设置标识符，例如当一个实例插入到数据存储中并生成了标识符时。调用 `withId(…)` 会创建一个新的 `Vertex` 对象。所有后续的修改都将在新实例中进行，而原始实例保持不变。
4	使用属性访问允许直接方法调用而无需使用 `MethodHandles`。

这使我们获得了大约 25% 的反射性能提升。为了使领域类符合此优化条件，它需要遵循一组约束

类型不能位于默认包或 java 包下。
类型及其构造函数必须是 public 的
作为内部类的类型必须是 static 的。
所使用的 Java 运行时必须允许在原始 ClassLoader 中声明类。Java 9 及更高版本施加了某些限制。

默认情况下，Spring Data 会尝试使用生成的属性访问器，如果检测到限制，则回退到基于反射的访问器。

让我们看看以下实体

示例 2. 示例实体

class Person {

  private final @Id Long id;                                                (1)
  private final String firstname, lastname;                                 (2)
  private final LocalDate birthday;
  private final int age; (3)

  private String comment;                                                   (4)
  private @AccessType(Type.PROPERTY) String remarks;                        (5)

  static Person of(String firstname, String lastname, LocalDate birthday) { (6)

    return new Person(null, firstname, lastname, birthday,
      Period.between(birthday, LocalDate.now()).getYears());
  }

  Person(Long id, String firstname, String lastname, LocalDate birthday, int age) { (6)

    this.id = id;
    this.firstname = firstname;
    this.lastname = lastname;
    this.birthday = birthday;
    this.age = age;
  }

  Person withId(Long id) {                                                  (1)
    return new Person(id, this.firstname, this.lastname, this.birthday);
  }

  void setRemarks(String remarks) {                                         (5)
    this.remarks = remarks;
  }
}

1	标识符属性是 final 的，但在构造函数中设置为 `null`。该类公开了一个 `withId(…)` 方法，用于设置标识符，例如当一个实例插入到数据存储中并生成了标识符时。原始的 `Vertex` 实例保持不变，因为创建了一个新的实例。同样的模式通常也适用于其他由存储管理但可能需要为持久化操作更改的属性。
2	`firstname` 和 `lastname` 属性是普通的不可变属性，可能通过 getter 公开。
3	`age` 属性是不可变的，但由 `birthday` 属性派生。按照所示设计，数据库值将优先于默认值，因为 Spring Data 使用唯一声明的构造函数。即使目的是优先计算，重要的是此构造函数也接受 `age` 作为参数（可能忽略它），否则属性填充步骤将尝试设置 age 字段，并因其不可变且不存在 wither 而失败。
4	`comment` 属性是可变的，并通过直接设置其字段进行填充。
5	`remarks` 属性是可变的，通过直接设置 `comment` 字段或调用 setter 方法进行填充
6	该类公开了一个工厂方法和一个构造函数用于对象创建。这里的核心思想是使用工厂方法而不是额外的构造函数，以避免通过 `@PersistenceCreator` 进行构造函数歧义消除。相反，属性的默认值在工厂方法中处理。

一般建议

尽量坚持使用不可变对象——不可变对象创建起来很简单，因为实例化一个对象只需要调用其构造函数。此外，这可以防止您的领域对象被散落的 setter 方法污染，这些方法允许客户端代码操纵对象的内部状态。如果您需要这些方法，最好将它们设为包保护，以便它们只能由有限数量的同位置类型调用。仅通过构造函数进行实例化比通过属性填充快 30%。
提供一个全参构造函数 — 即使您不能或不想将您的实体建模为不可变值，提供一个接受实体所有属性（包括可变属性）作为参数的构造函数仍然很有价值，因为这允许对象映射跳过属性填充以获得最佳性能。
使用工厂方法而不是重载构造函数来避免 @PersistenceCreator —— 为了获得最佳性能，需要一个全参数构造函数，我们通常希望公开更多针对应用程序用例的构造函数，这些构造函数省略了自动生成的标识符等。使用静态工厂方法来公开全参数构造函数的这些变体是一种既定的模式。
确保您遵守允许使用生成的实例化器和属性访问器类的约束
对于要生成的标识符，仍将 final 字段与 wither 方法结合使用
使用 Lombok 避免样板代码 — 由于持久化操作通常需要一个接受所有参数的构造函数，它们的声明变成了繁琐的样板参数到字段赋值的重复，最好通过使用 Lombok 的 @AllArgsConstructor 来避免。

关于不可变映射的注意事项

尽管我们建议尽可能使用不可变映射和构造，但在映射方面存在一些限制。给定一个双向关系，其中 A 对 B 有一个构造函数引用，而 B 对 A 有一个引用，或者更复杂的场景。这种鸡生蛋/蛋生鸡的情况对于 Spring Data Neo4j 来说是无法解决的。在 A 的实例化过程中，它急切地需要一个完全实例化的 B，而 B 反过来又需要 A 的实例（准确地说，是相同的实例）。SDN 通常允许此类模型，但如果从数据库返回的数据包含上述描述的这种结构，则会在运行时抛出 MappingException。在这种情况下或您无法预测返回的数据是什么样子的场景中，您最好为关系使用可变字段。

Kotlin 支持

Spring Data 适应 Kotlin 的特性，以允许对象创建和修改。

Kotlin 对象创建

支持 Kotlin 类的实例化，所有类默认是不可变的，需要显式属性声明来定义可变属性。考虑以下 data 类 Vertex

data class Person(val id: String, val name: String)

上面的类编译成一个带有显式构造函数的典型类。我们可以通过添加另一个构造函数并用 @PersistenceCreator 注解它来指示构造函数首选项，从而自定义此类

data class Person(var id: String, val name: String) {

    @PersistenceCreator
    constructor(id: String) : this(id, "unknown")
}

Kotlin 通过允许在未提供参数时使用默认值来支持参数可选性。当 Spring Data 检测到带有参数默认值的构造函数时，如果数据存储不提供值（或简单地返回 null），它会保留这些参数，以便 Kotlin 可以应用参数默认值。考虑以下对 name 应用参数默认值的类

data class Person(var id: String, val name: String = "unknown")

每次 name 参数不在结果中或其值为 null 时，name 都会默认为 unknown。

Kotlin 数据类的属性填充

在 Kotlin 中，所有类默认是不可变的，需要显式属性声明来定义可变属性。考虑以下 data 类 Vertex

data class Person(val id: String, val name: String)

这个类实际上是不可变的。它允许创建新实例，因为 Kotlin 会生成一个 copy(…) 方法，该方法会创建新对象实例，复制现有对象的所有属性值，并应用作为方法参数提供的属性值。