跳到主要内容
版本:4.1.1

对象映射基础

Doubao 中英对照 Object Mapping Fundamentals

本节介绍 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% 的性能提升。要让领域类符合这种优化的条件,它需要遵守一组约束:

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

如果满足其中任何一条,Spring Data 将回退到通过反射进行实体实例化。

属性填充​

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

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

属性填充内部机制

与我们在对象构造中的优化类似,我们也使用 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.lastname);
}

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
}
}
}
  • PropertyAccessor 持有底层对象的一个可变实例。这是为了能够对原本不可变的属性进行修改。

  • 默认情况下,Spring Data 使用字段访问来读写属性值。根据 private 字段的可见性规则,使用 MethodHandles 与字段交互。

  • 该类暴露一个 withId(…) 方法,用于设置标识符,例如当一个实例被插入数据存储并已生成标识符时。调用 withId(…) 会创建一个新的 Person 对象。所有后续修改都发生在新实例中,原实例保持不变。

  • 使用属性访问可以直接进行方法调用,而无需使用 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
private @Transient String summary; 6

static Person of(String firstname, String lastname, LocalDate birthday) { 7

return new Person(null, firstname, lastname, birthday,
Period.between(birthday, LocalDate.now()).getYears());
}

Person(Long id, String firstname, String lastname, LocalDate birthday, int age) { 7

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;
}
}
  • 标识符属性是 final 的,但在构造函数中被设为 null。该类暴露一个 withId(…) 方法,用于设置标识符,例如当一个实例被插入数据存储并已生成标识符时。创建新实例时,原 Person 实例保持不变。对于其他由存储管理但可能需要在持久化操作中更改的属性,通常也采用相同模式。wither 方法是可选的,因为持久化构造函数(见 6)实际上是一个复制构造函数,设置该属性会被转换为创建一个应用了新标识符值的全新实例。

  • firstname 和 lastname 属性是普通的不可变属性,可能通过 getter 暴露。

  • age 属性是不可变的,但派生自 birthday 属性。在所示设计中,数据库值会胜过默认值,因为 Spring Data 使用唯一声明的构造函数。即使意图是优先使用计算结果,重要的是该构造函数也要把 age 作为参数(以可能忽略它),否则属性填充步骤会尝试设置 age 字段,并由于它是不可变的且没有 with… 方法而失败。

  • comment 属性是可变的,通过直接设置其字段来填充。

  • remarks 属性是可变的,通过调用 setter 方法来填充。

  • summary 属性是瞬态的,不会被持久化,因为它标注了 @Transient。Spring Data 不使用 Java 的 transient 关键字来排除属性被持久化,因为 transient 是 Java 序列化框架的一部分。请注意,该属性可以用于持久化构造函数,但其值默认为 null(如果属性类型是原始类型,则为相应的原始类型初始值)。

  • 该类暴露一个工厂方法和一个构造函数用于对象创建。这里的核心思想是使用工厂方法而不是额外的构造函数,以避免通过 @PersistenceCreator 进行构造函数消歧。相反,属性的默认值在工厂方法内部处理。如果你想让 Spring Data 使用工厂方法进行对象实例化,请用 @PersistenceCreator 注解它。

一般建议​

  • 尽量坚持使用不可变对象 — 不可变对象很容易创建,因为具体化一个对象只需调用其构造函数。此外,这避免了用 setter 方法污染你的领域对象,setter 方法会允许客户端代码操纵对象的状态。如果你确实需要这些 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 模块通常支持持有不同值的重写属性。从编程模型的角度来看,有几点需要考虑:

  1. 应该持久化哪个属性(默认为所有声明的属性)?你可以通过用 @Transient 注解这些属性来排除它们。
  2. 如何在你的数据存储中表示属性?对不同的值使用相同的字段/列名通常会导致数据损坏,因此你应该用显式的字段/列名注解至少其中一个属性。
  3. 不能使用 @AccessType(PROPERTY),因为在不对 setter 实现做进一步假设的情况下,无法普遍地设置超属性。

Kotlin 支持​

Spring Data 会适配 Kotlin 的特性,以支持对象创建和修改。

Kotlin 对象创建​

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

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

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

考虑下面这个 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 添加一个方法通过 this.SuperType.field = … 来设置 SuperType.field 是可行的,但不在支持的约定之内。属性重写在某种程度上会产生冲突,因为这些属性共享相同的名称,却可能代表两个不同的值。我们通常建议使用不同的属性名。

Spring Data 模块通常支持持有不同值的重写属性。从编程模型的角度来看,有几点需要考虑:

  1. 应该持久化哪个属性(默认为所有声明的属性)?你可以通过用 @Transient 注解这些属性来排除它们。
  2. 如何在你的数据存储中表示属性?对不同的值使用相同的字段/列名通常会导致数据损坏,因此你应该用显式的字段/列名注解至少其中一个属性。
  3. 不能使用 @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 值类定义属性的数据类。

备注

使用非原始值类型的不可空属性会在编译后的类中被扁平化到该值类型。可空的原始值类型或可空的值中之值类型则用其包装类型表示,这会影响值类型在数据库中的表示方式。