Spring Data Relational _ 3.2.7 中文文档(官方文档中文翻译) —

对于最新的稳定版本，请使用 Spring Data Relational 3.3.1！Spring中文文档

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

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

使用公开的构造函数之一创建实例。Spring中文文档
实例填充，用于具体化所有公开的属性。Spring中文文档

对象创建

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

如果有一个静态工厂方法注释，则使用它。@PersistenceCreatorSpring中文文档
如果存在单个构造函数，则使用该构造函数。Spring中文文档
如果有多个构造函数，并且恰好有一个构造函数用注释，则使用它。@PersistenceCreatorSpring中文文档
如果类型是 Java，则使用规范构造函数。RecordSpring中文文档
如果存在无参数构造函数，则使用它。其他构造函数将被忽略。Spring中文文档

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

可以使用 Spring Framework 的值注释和特定于存储的 SpEL 表达式来自定义值解析。有关更多详细信息，请参阅有关商店特定映射的部分。@ValueSpring中文文档

对象创建内部

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

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

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

class PersonObjectInstantiator implements ObjectInstantiator {

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

这为我们提供了 10% 的性能提升。要使域类符合此类优化的条件，它需要遵守一组约束：Spring中文文档

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

如果这些条件中的任何一个匹配，Spring Data 将通过反射回退到实体实例化。Spring中文文档

物业人口

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

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

物业人口内部结构

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

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 使用字段访问来读取和写入属性值。根据字段的可见性规则，用于与字段交互。`privateMethodHandles`
3	该类公开用于设置标识符的方法，例如，当实例插入数据存储并生成标识符时。调用将创建一个新对象。所有后续突变都将在新实例中发生，而前一个实例保持不变。`withId(…)withId(…)Person`
4	使用属性访问允许直接调用方法，而无需使用。`MethodHandles`

这为我们提供了 25% 的性能提升。要使域类符合此类优化的条件，它需要遵守一组约束：Spring中文文档

类型不得驻留在默认值中或包下。javaSpring中文文档
类型及其构造函数必须是publicSpring中文文档
作为内部类的类型必须是。staticSpring中文文档
使用的 Java 运行时必须允许在原始 .Java 9 和更高版本施加了某些限制。ClassLoaderSpring中文文档

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

让我们看一下以下实体：Spring中文文档

示例实体

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	标识符属性是最终属性，但在构造函数中设置为。该类公开用于设置标识符的方法，例如，当实例插入数据存储并生成标识符时。创建新实例时，原始实例保持不变。相同的模式通常应用于存储管理的其他属性，但可能需要更改持久性操作。 wither 方法是可选的，因为持久性构造函数（参见 6）实际上是一个复制构造函数，并且设置属性将转换为使用应用新标识符值创建新实例。`nullwithId(…)Person`
2	和属性是可能通过 getter 公开的普通不可变属性。`firstnamelastname`
3	该属性是不可变的，但派生自该属性。在所示的设计中，数据库值将优先于默认值，因为 Spring Data 使用唯一声明的构造函数。即使意图是计算应该是首选，也很重要的是，此构造函数也必须将其作为参数（以可能忽略它），否则属性填充步骤将尝试设置年龄字段并失败，因为它是不可变的，并且不存在任何方法。`agebirthdayagewith…`
4	该属性是可变的，通过直接设置其字段来填充。`comment`
5	该属性是可变的，并通过调用 setter 方法进行填充。`remarks`
6	该类公开用于创建对象的工厂方法和构造函数。这里的核心思想是使用工厂方法而不是其他构造函数，以避免需要通过来消除构造函数的歧义。相反，属性的默认值是在工厂方法中处理的。如果希望 Spring Data 使用工厂方法进行对象实例化，请使用 .`@PersistenceCreator@PersistenceCreator`

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

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

一般建议

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

覆盖属性

Java 允许灵活地设计域类，其中子类可以定义已在其超类中声明的相同名称的属性。请看以下示例：Spring中文文档

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);
   }
}

这两个类都定义一个使用可分配的类型。然而阴影. 根据类设计，使用构造函数可能是设置的唯一默认方法。或者，调用 setter 可以设置 in . 所有这些机制在某种程度上都会产生冲突，因为这些属性共享相同的名称，但可能表示两个不同的值。如果类型不可赋值，Spring Data 会跳过超类型属性。也就是说，重写属性的类型必须可分配给其超类型属性类型才能注册为重写，否则超类型属性将被视为瞬态属性。我们通常建议使用不同的属性名称。fieldSubTypeSuperType.fieldSuperType.fieldsuper.setField(…)fieldSuperTypeSpring中文文档

Spring Data 模块通常支持包含不同值的覆盖属性。从编程模型的角度来看，有几件事需要考虑：Spring中文文档

应保留哪个属性（默认为所有声明的属性）？您可以通过使用对属性进行批注来排除这些属性。@TransientSpring中文文档
如何表示数据存储中的属性？对不同的值使用相同的字段/列名称通常会导致数据损坏，因此应使用显式字段/列名称至少批注一个属性。Spring中文文档
不能使用，因为通常不能在不对 setter 实现进行任何进一步假设的情况下设置超属性。@AccessType(PROPERTY)Spring中文文档

Kotlin 支持

Spring Data 调整了 Kotlin 的细节，以允许对象创建和更改。Spring中文文档

Kotlin 对象创建

支持实例化 Kotlin 类，默认情况下所有类都是不可变的，并且需要显式属性声明来定义可变属性。Spring中文文档

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

如果存在用注释的构造函数，则使用该构造函数。@PersistenceCreatorSpring中文文档
如果类型是 Kotlin 数据类，则使用主构造函数。Spring中文文档
如果有一个静态工厂方法注释，则使用它。@PersistenceCreatorSpring中文文档
如果存在单个构造函数，则使用该构造函数。Spring中文文档
如果有多个构造函数，并且恰好有一个构造函数用注释，则使用它。@PersistenceCreatorSpring中文文档
如果类型是 Java，则使用规范构造函数。RecordSpring中文文档
如果存在无参数构造函数，则使用它。其他构造函数将被忽略。Spring中文文档

考虑以下类：dataPersonSpring中文文档

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

上面的类编译为具有显式构造函数的典型类。我们可以通过添加另一个构造函数来自定义这个类，并用它进行注释以指示构造函数首选项：@PersistenceCreatorSpring中文文档

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

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

Kotlin 支持参数可选性，允许在未提供参数时使用默认值。当 Spring Data 检测到参数默认值的构造函数时，如果数据存储没有提供值（或只是返回），则这些参数不存在，因此 Kotlin 可以应用参数默认值。请考虑以下应用参数默认值的类nullnameSpring中文文档

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

每当参数不是结果的一部分或其值为时，默认值为。namenullnameunknownSpring中文文档

Kotlin 数据类的属性填充

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

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

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

Kotlin 覆盖属性

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

open class SuperType(open var field: Int)

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

这样的排列呈现两个名称为的属性。 Kotlin 为每个类中的每个属性生成属性访问器（getter 和 setter）。实际上，代码如下所示：fieldSpring中文文档

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;
   }
}

Getters 和 Setters 只在片场而不是 . 在这样的安排中，使用构造函数是设置的唯一默认方法。可以添加 to set via 的方法，但超出了支持的约定。属性重写在某种程度上会产生冲突，因为属性共享相同的名称，但可能表示两个不同的值。我们通常建议使用不同的属性名称。SubTypeSubType.fieldSuperType.fieldSuperType.fieldSubTypeSuperType.fieldthis.SuperType.field = …Spring中文文档

Spring Data 模块通常支持包含不同值的覆盖属性。从编程模型的角度来看，有几件事需要考虑：Spring中文文档

应保留哪个属性（默认为所有声明的属性）？您可以通过使用对属性进行批注来排除这些属性。@TransientSpring中文文档
如何表示数据存储中的属性？对不同的值使用相同的字段/列名称通常会导致数据损坏，因此应使用显式字段/列名称至少批注一个属性。Spring中文文档
不能使用，因为无法设置超级属性。@AccessType(PROPERTY)Spring中文文档

Kotlin 值类

Kotlin 值类专为更具表现力的领域模型而设计，以明确基本概念。 Spring Data 可以读取和写入使用值类定义属性的类型。Spring中文文档

请考虑以下域模型：Spring中文文档

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

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

1	具有不可为 null 值类型的简单值类。
2	数据类使用 value 类定义属性。`EmailAddress`

使用非基元值类型的不可为 null 属性在 compiled 类中展平为值类型。可为 null 的基元值类型或可为 null 的值中值类型用其包装器类型表示，这会影响值类型在数据库中的表示方式。

1	具有不可为 null 值类型的简单值类。
2	数据类使用 value 类定义属性。`EmailAddress`