对象映射基础
本节涵盖了 Spring Data 对象映射的基础知识,包括对象创建、字段和属性访问、可变性和不可变性。请注意,本节仅适用于不使用底层数据存储(如 JPA)的对象映射的 Spring Data 模块。此外,请务必查阅特定存储的部分以了解特定存储的对象映射,例如索引、自定义列或字段名称等。
Spring Data 对象映射的核心职责是创建领域对象的实例,并将存储原生的数据结构映射到这些实例上。这意味着我们需要两个基本步骤:
-
通过使用暴露的构造函数之一创建实例。
-
实例填充以具体化所有暴露的属性。
对象创建
Spring Data 会自动尝试检测持久化实体的构造函数,以便用于实例化该类型的对象。解析算法的运作方式如下:
-
如果存在一个用
@PersistenceCreator
注解的静态工厂方法,那么它将用于实例化。 -
如果存在一个构造函数,它将用于实例化。
-
如果有多个构造函数,并且只有一个构造函数用
@PersistenceCreator
注解,那么它将用于实例化。 -
如果类型是 Java
Record
,则使用规范构造函数。 -
如果存在一个无参构造函数,它将用于实例化。其他构造函数将被忽略。
值解析假定构造函数/工厂方法参数名称与实体的属性名称匹配,即解析将像填充属性一样执行,包括映射中的所有自定义(不同的数据存储列或字段名称等)。这还要求类文件中提供参数名称信息,或者在构造函数上存在 @ConstructorProperties
注解。
可以通过使用 Spring Framework 的 @Value
注解,结合特定于存储的 SpEL 表达式来自定义值的解析。有关更多详细信息,请参阅特定于存储的映射部分。
属性填充
一旦实体实例被创建,Spring Data 会填充该类的所有剩余的持久化属性。除非这些属性已经通过实体的构造函数(即通过构造函数的参数列表)进行了填充,否则标识符属性将首先被填充,以允许解析循环对象引用。之后,所有尚未通过构造函数填充的非瞬态属性将在实体实例上进行设置。为此,我们使用以下算法:
-
如果属性是不可变的,但暴露了一个
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;
}
}
identifier
属性是final
的,但在构造函数中被设置为null
。该类提供了一个withId(…)
方法,用于设置标识符,例如当实例插入到数据存储中并生成标识符时。原始的Person
实例保持不变,因为会创建一个新的实例。相同的模式通常适用于其他由存储管理的属性,但在持久化操作中可能需要更改。wither 方法是可选的,因为持久化构造函数(见第 6 点)实际上是一个复制构造函数,设置该属性将转换为创建一个应用了新标识符值的新实例。firstname
和lastname
属性是普通的不可变属性,可能通过 getter 方法暴露。age
属性是不可变的,但它是从birthday
属性派生出来的。通过所示的设计,数据库值将覆盖默认值,因为 Spring Data 使用唯一声明的构造函数。即使意图是应优先使用计算值,但重要的是该构造函数也将age
作为参数(可能忽略它),否则属性填充步骤将尝试设置age
字段,并由于它是不可变的且没有with…
方法而失败。comment
属性是可变的,并通过直接设置其字段来填充。remarks
属性是可变的,并通过调用 setter 方法来填充。该类公开了一个工厂方法和一个用于对象创建的构造函数。这里的核心思想是使用工厂方法而不是额外的构造函数,以避免需要通过
@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 数据类,则使用主构造函数。
-
如果存在一个用
@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 User(
val id: Long,
val name: String = "Unknown"
)
在这个例子中,如果数据存储没有提供 name
的值,Kotlin 会自动使用默认值 "Unknown"
。
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 值类(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
一个带有不可空值类型的简单值类。
使用
EmailAddress
值类定义属性的数据类。
使用非原始值类型的非可空属性在编译后的类中会被展平为值类型。可空的原始值类型或可空的值中值类型则用它们的包装类型表示,这会影响值类型在数据库中的表示方式。