对象映射基础

本节涵盖 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	标识符属性是 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 — 由于需要全参构造函数以获得最佳性能，我们通常希望公开更多特定于应用程序用例的构造函数，这些构造函数省略了自动生成的标识符等。使用静态工厂方法公开全参构造函数的这些变体是一种既定的模式。
确保您遵循允许使用生成的实例化器和属性访问器类的约束 —
对于需要生成的标识符，仍然使用 final 字段并结合全参持久化构造函数（首选）或 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 data class，则使用主构造函数。
如果存在一个用 @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 Data class 的委托属性。在所有其他情况下，您可以通过使用 @Transient 注解属性来排除委托属性的合成字段。

Kotlin data class 的属性填充

在 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` 值类定义属性的 Data class。

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