对象映射基础

本节介绍 Spring Data 对象映射、对象创建、字段和属性访问、可变性和不可变性的基础知识。请注意，本节仅适用于不使用底层数据存储的对象映射（如 JPA）的 Spring Data 模块。此外，请务必查阅特定于存储的章节，了解特定于存储的对象映射，例如索引、自定义列或字段名称等。

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

使用公开的构造函数之一创建实例。
实例填充以实现所有公开的属性。

对象创建

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

如果存在一个用 @PersistenceCreator 注解的静态工厂方法，则使用它。
如果存在一个构造函数，则使用它。
如果存在多个构造函数，并且只有一个用 @PersistenceCreator 注解，则使用它。
如果类型是 Java Record，则使用规范构造函数。
如果存在无参数构造函数，则使用它。其他构造函数将被忽略。

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

可以使用 Spring Framework 的 @Value 值注解以及特定于存储的 SpEL 表达式自定义值解析。有关更多详细信息，请查阅特定于存储的映射部分。

对象创建内部机制

为了避免反射带来的开销，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 将填充该类的所有剩余持久化属性。除非实体的构造函数已填充（即通过其构造函数参数列表使用），否则将首先填充标识符属性以允许解析循环对象引用。之后，所有尚未由构造函数填充的非瞬态属性都将设置在实体实例上。为此，我们使用以下算法

如果属性是不可变的，但公开了 with… 方法（见下文），我们将使用 with… 方法创建一个具有新属性值的新实体实例。
如果定义了属性访问（即通过 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;
  }
}

生成的属性访问器

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(…)` 会创建一个新的 `Person` 对象。所有后续修改都将在新实例中进行，而不会影响之前的实例。
4	使用属性访问允许直接方法调用，而无需使用 `MethodHandles`。

这使我们的性能比反射提高了约 25%。要使域类有资格进行此类优化，它需要满足一组约束条件

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

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

让我们看一下以下实体

示例实体

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, this.age);
  }

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

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

通用建议

尝试坚持使用不可变对象 — 不可变对象易于创建，因为实现对象只需要调用其构造函数。此外，这避免了您的域对象充斥着允许客户端代码操作对象状态的 setter 方法。如果您需要这些方法，请首选将其设为包保护级别，以便只有少量共处类型的代码可以调用它们。仅使用构造函数进行实例化比属性填充快 30%。
提供一个包含所有参数的构造函数 — 即使您无法或不想将您的实体建模为不可变值，提供一个将实体的所有属性（包括可变属性）作为参数的构造函数仍然有价值，因为这允许对象映射跳过属性填充以获得最佳性能。
使用工厂方法而不是重载构造函数来避免 @PersistenceCreator — 由于需要包含所有参数的构造函数以获得最佳性能，我们通常希望公开更多特定于应用程序用例的构造函数，这些构造函数省略了自动生成的标识符等内容。使用静态工厂方法公开这些包含所有参数的构造函数的变体是一种既定的模式。
确保您遵守允许使用生成的实例化器和属性访问器类的约束 —
对于要生成的标识符，仍然使用最终字段结合包含所有参数的持久化构造函数（首选）或 with… 方法 —
使用 Lombok 避免样板代码 — 由于持久化操作通常需要一个包含所有参数的构造函数，因此它们的声明变成了繁琐的样板参数到字段赋值的重复，这可以通过使用 Lombok 的 @AllArgsConstructor 最好地避免。

覆盖属性

Java 允许灵活设计域类，其中子类可以定义在其超类中已声明的同名属性。考虑以下示例

public class SuperType {

   private CharSequence field;

   public SuperType(CharSequence field) {
      this.field = field;
   }

   public CharSequence getField() {
      return this.field;
   }

   public void setField(CharSequence field) {
      this.field = field;
   }
}

public class SubType extends SuperType {

   private String field;

   public SubType(String field) {
      super(field);
      this.field = field;
   }

   @Override
   public String getField() {
      return this.field;
   }

   public void setField(String field) {
      this.field = field;

      // optional
      super.setField(field);
   }
}

这两个类都使用可分配类型定义了一个 field。但是，SubType 隐藏了 SuperType.field。根据类设计，使用构造函数可能是设置 SuperType.field 的唯一默认方法。或者，在 setter 中调用 super.setField(…) 可以设置 SuperType 中的 field。所有这些机制都在某种程度上造成了冲突，因为属性名称相同，但可能代表两个不同的值。如果类型不可分配，则 Spring Data 会跳过超类型属性。也就是说，被覆盖属性的类型必须可分配给其超类型属性类型才能被注册为覆盖，否则超类型属性被视为瞬态属性。我们通常建议使用不同的属性名称。

Spring Data 模块通常支持持有不同值的覆盖属性。从编程模型的角度来看，需要考虑以下几点

应持久化哪个属性（默认为所有声明的属性）？您可以通过使用 @Transient 对这些属性进行注释来排除它们。
如何在数据存储中表示属性？对不同的值使用相同的字段/列名通常会导致数据损坏，因此您应该至少对其中一个属性使用显式字段/列名进行注释。
无法使用 @AccessType(PROPERTY)，因为通常无法设置超属性，而无需对 setter 实现做出任何进一步的假设。

Kotlin 支持

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

Kotlin 对象创建

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

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

如果存在用 @PersistenceCreator 注释的构造函数，则使用它。
如果类型是 Kotlin 数据类，则使用主构造函数。
如果存在一个用 @PersistenceCreator 注解的静态工厂方法，则使用它。
如果存在一个构造函数，则使用它。
如果存在多个构造函数，并且只有一个用 @PersistenceCreator 注解，则使用它。
如果类型是 Java Record，则使用规范构造函数。
如果存在无参数构造函数，则使用它。其他构造函数将被忽略。

考虑以下 data 类 Person

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。

Spring Data 不支持委托属性。映射元数据会为 Kotlin 数据类过滤委托属性。在所有其他情况下，您可以通过使用 @delegate:org.springframework.data.annotation.Transient 对属性进行注释来排除委托属性的合成字段。

Kotlin 数据类的属性填充

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

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

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

Kotlin 覆盖属性

Kotlin 允许声明属性覆盖以更改子类中的属性。

open class SuperType(open var field: Int)

class SubType(override var field: Int = 1) :
	SuperType(field) {
}

这种安排生成了两个名为 field 的属性。Kotlin 为每个类中的每个属性生成属性访问器（getter 和 setter）。实际上，代码如下所示

public class SuperType {

   private int field;

   public SuperType(int field) {
      this.field = field;
   }

   public int getField() {
      return this.field;
   }

   public void setField(int field) {
      this.field = field;
   }
}

public final class SubType extends SuperType {

   private int field;

   public SubType(int field) {
      super(field);
      this.field = field;
   }

   public int getField() {
      return this.field;
   }

   public void setField(int field) {
      this.field = field;
   }
}

SubType 上的 getter 和 setter 仅设置 SubType.field 而不是 SuperType.field。在这种安排中，使用构造函数是设置 SuperType.field 的唯一默认方法。向 SubType 添加一个方法以通过 this.SuperType.field = … 设置 SuperType.field 是可能的，但这超出了支持的约定。属性覆盖在某种程度上造成了冲突，因为属性名称相同，但可能代表两个不同的值。我们通常建议使用不同的属性名称。

Spring Data 模块通常支持持有不同值的覆盖属性。从编程模型的角度来看，需要考虑以下几点

应持久化哪个属性（默认为所有声明的属性）？您可以通过使用 @Transient 对这些属性进行注释来排除它们。
如何在数据存储中表示属性？对不同的值使用相同的字段/列名通常会导致数据损坏，因此您应该至少对其中一个属性使用显式字段/列名进行注释。
无法使用 @AccessType(PROPERTY)，因为无法设置超属性。

Kotlin 值类

Kotlin 值类旨在构建更具表现力的域模型，以使底层概念明确。Spring Data 可以读取和写入使用值类定义属性的类型。

考虑以下域模型

@JvmInline
value class EmailAddress(val theAddress: String)                                    (1)

data class Contact(val id: String, val name:String, val emailAddress: EmailAddress) (2)

1	一个具有非空值类型的简单值类。
2	使用 `EmailAddress` 值类定义属性的数据类。

使用非原始值类型的非空属性在编译后的类中被展平为值类型。可空原始值类型或可空的值中值类型用其包装类型表示，这会影响值类型在数据库中的表示方式。