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 Runtime 必须允许在原始的 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 data 类的属性填充

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

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

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