|
对于最新的稳定版本，请使用 Spring Data Relational 4.0.4！ |
对象映射基础
本节介绍 Spring Data 对象映射、对象创建、字段和属性访问、可变性与不可变性的基础知识。 请注意，本节仅适用于不使用底层数据存储对象映射（如 JPA）的 Spring Data 模块。 此外，请务必查阅特定于存储的章节，以了解特定于存储的对象映射内容，例如索引、自定义列名或字段名等。
Spring Data 对象映射的核心职责是创建领域对象的实例，并将存储原生的数据结构映射到这些对象上。 这意味着我们需要两个基本步骤：
-
通过使用公开的构造函数之一来创建实例。
-
实例填充以实例化所有公开的属性。
对象创建
Spring Data 会自动尝试检测持久化实体的构造函数，以用于实例化该类型的对象。 解析算法的工作方式如下：
-
如果存在一个使用
@PersistenceCreator注解的静态工厂方法，则会使用该方法。 -
如果只有一个构造函数，则使用该构造函数。
-
如果存在多个构造函数，并且恰好有一个被标注为
@PersistenceCreator，那么将使用该构造函数。 -
如果该类型是一个 Java
Record，则使用其规范构造函数。 -
如果存在无参构造函数，则会使用它。 其他构造函数将被忽略。
值解析假定构造函数/工厂方法的参数名称与实体的属性名称相匹配，即解析过程将如同要填充该属性一样进行，包括映射中的所有自定义设置（例如不同的数据存储列名或字段名等）。
这也要求类文件中包含参数名称信息，或者在构造函数上存在 @ConstructorProperties 注解。
可以通过使用 Spring Framework 的 @Value 注解并结合特定于存储的 SpEL 表达式来自定义值解析。
有关更多详细信息，请参阅关于特定于存储的映射的相关章节。
属性填充
一旦实体实例被创建，Spring Data 就会填充该类中所有其余的持久化属性。 除非标识符属性已经由实体的构造函数填充（即通过其构造函数参数列表传入），否则将首先填充标识符属性，以便解析循环对象引用。 之后，所有尚未通过构造函数填充的非瞬态（non-transient）属性都会被设置到实体实例上。 为此，我们使用以下算法：
-
如果该属性是不可变的，但提供了一个
with…方法（见下文），我们将使用该with…方法创建一个包含新属性值的新实体实例。 -
如果定义了属性访问（即通过 getter 和 setter 进行访问），我们将调用 setter 方法。
-
如果该属性是可变的，我们会直接设置字段。
-
如果该属性是不可变的，我们将使用构造函数（由持久化操作调用，参见对象创建）来创建该实例的一个副本。
-
默认情况下，我们直接设置字段值。
让我们来看一下以下实体：
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 方法，从而防止客户端代码随意修改对象的状态。 如果你确实需要这些 setter 方法，建议将其设为包级私有（package protected），以便只有有限数量的同包类才能调用它们。 仅通过构造函数进行对象实例化，比通过属性赋值的方式快多达 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 会遮蔽（shadow）SuperType.field。
根据类的设计，使用构造函数可能是设置 SuperType.field 的唯一默认方法。
或者，也可以在 setter 方法中调用 super.setField(…) 来设置 field 中的 SuperType。
所有这些机制在某种程度上都会产生冲突，因为这些属性具有相同的名称，却可能代表两个不同的值。
如果类型不可赋值，Spring Data 会跳过父类的属性。
也就是说，只有当被重写的属性类型可赋值给其父类属性类型时，才会被注册为重写；否则，父类属性将被视为瞬态（transient）。
我们通常建议使用不同的属性名称。
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 数据类中的委托属性。
在其他所有情况下，您可以通过使用 @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 添加一个方法，通过 SuperType.field 来设置 this.SuperType.field = …，但这超出了所支持的约定范围。
属性重写在一定程度上会造成冲突，因为这些属性名称相同，却可能代表两个不同的值。
我们通常建议使用不同的属性名称。
Spring Data 模块通常支持被重写的属性持有不同的值。 从编程模型的角度来看，有几点需要注意：
-
应持久化哪些属性（默认为所有已声明的属性）？ 您可以通过使用
@Transient注解来排除某些属性。 -
如何在您的数据存储中表示属性？ 对不同的值使用相同的字段/列名通常会导致数据损坏，因此您应使用显式的字段/列名对至少其中一个属性进行注解。
-
使用
@AccessType(PROPERTY)是不可行的，因为无法设置超类属性。
Kotlin 值类
Kotlin 值类（Value Classes）旨在构建更具表达力的领域模型，以显式地体现底层概念。 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 值类定义属性的数据类。 |
| 使用非基本值类型的不可为空属性在编译后的类中会被展平为该值类型。 可为空的基本值类型或值类型中的可为空值类型则以其包装类型表示，这会影响值类型在数据库中的表示方式。 |