对象映射基础

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

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

1. 使用公开的其中一个构造函数创建实例。
2. 填充实例以实例化所有公开的属性。

对象创建

Spring Data 会自动尝试检测持久化实体要用于实例化该类型对象的构造函数。解析算法如下所示：

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

值解析假定构造函数/工厂方法参数名与实体的属性名匹配，即解析将按照属性要被填充的方式进行，包括映射中的所有自定义设置（不同的数据存储列名或字段名等）。这也要求类文件中包含参数名信息，或者构造函数上存在 @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% 的性能。领域类要符合此优化条件，需要遵守一系列约束：

1. 不能是私有类。
2. 不能是非静态内部类。
3. 不能是 CGLib 代理类。
4. Spring Data 要使用的构造函数不能是私有的。

如果符合其中任何一项条件，Spring Data 将回退到通过反射进行实体实例化。

属性填充

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

1. 如果属性是不可变的但公开了 with… 方法（见下文），则使用 with… 方法创建一个带有新属性值的新实体实例。
2. 如果定义了属性访问（即通过 getter 和 setter 访问），则调用 setter 方法。
3. 如果属性是可变的，我们直接设置字段。
4. 如果属性是不可变的，我们使用持久化操作要使用的构造函数（参见对象创建）创建一个实例的副本。
默认情况下，我们直接设置字段值。

属性填充内部机制

与我们的对象构建优化类似，我们也使用 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% 的性能。领域类要符合此优化条件，需要遵守一系列约束：

1. 类型不能位于默认包或 java 包下。
2. 类型及其构造函数必须是 public 的。
3. 作为内部类的类型必须是 static 的。
4. 使用的 Java Runtime 必须允许在原始 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	标识符属性是 final 的，但在构造函数中设置为 `null`。该类公开了一个 `withId(…)` 方法，用于设置标识符，例如将实例插入数据存储并生成标识符时。由于创建了一个新实例，原始的 `Person` 实例保持不变。通常，对于其他由存储管理但可能需要为持久化操作而更改的属性，也会应用相同的模式。wither 方法是可选的，因为持久化构造函数（参见 6）实际上是一个复制构造函数，并且设置属性将被转换为创建一个应用了新标识符值的新实例。
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… 方法使用 final 字段 —
使用 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 模块通常支持持有不同值的覆盖属性。从编程模型的角度来看，需要考虑以下几点：

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

Kotlin 支持

Spring Data 适应 Kotlin 的特性，支持对象创建和修改。

Kotlin 对象创建

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

Spring Data 会自动尝试检测持久化实体要用于实例化该类型对象的构造函数。解析算法如下所示：

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

考虑以下 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 Data class 的委托属性。在所有其他情况下，您可以通过使用 @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 模块通常支持持有不同值的覆盖属性。从编程模型的角度来看，需要考虑以下几点：

1. 哪些属性应该被持久化（默认为所有声明的属性）？您可以使用 @Transient 注解来排除属性。
2. 如何在数据存储中表示属性？对不同的值使用相同的字段/列名通常会导致数据损坏，因此您应该至少对其中一个属性使用显式的字段/列名进行注解。
不能使用 @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` 值类定义属性的 Data class。

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