跳到主要内容

对象映射基础

DeepSeek V3 中英对照 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 框架的 @Value 注解,结合特定存储的 SpEL 表达式,来自定义值的解析。详情请参阅关于特定存储映射的部分。

对象创建的内部机制

为了避免反射的开销,Spring Data 默认使用在运行时生成的工厂类来创建对象,该工厂类将直接调用领域类的构造函数。例如,对于以下示例类型:

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

我们将在运行时创建一个语义上等同于以下内容的工厂类:

class PersonObjectInstantiator implements ObjectInstantiator {

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

这使我们相对于反射来说,性能提升了大约 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) {
// 字段赋值
}

Person withId(Long id) {
return new Person(id, this.firstname, this.lastame);
}

void setLastname(String lastname) {
this.lastname = lastname;
}
}
java

生成的属性访问器

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

  • firstnamelastname 属性是普通的不可变属性,可能通过 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);
}
}
java

两个类都使用了可分配类型定义了一个 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. 如果存在无参构造函数,则使用该构造函数。其他构造函数将被忽略。

考虑以下的 dataPerson

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

上面的类编译后会生成一个带有显式构造函数的典型类。我们可以通过添加另一个构造函数并标注 @PersistenceCreator 来自定义这个类,以指示构造函数的优先级:

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

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

Kotlin 通过允许使用默认值来支持参数的可选性。当 Spring Data 检测到带有参数默认值的构造函数时,如果数据存储未提供值(或直接返回 null),Spring Data 会省略这些参数,以便 Kotlin 可以应用参数默认值。考虑以下为 name 应用参数默认值的类:

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

每当 name 参数不在结果中或其值为 null 时,name 将默认为 unknown

备注

Spring Data 不支持委托属性。对于 Kotlin Data 类,映射元数据会过滤掉委托属性。在其他情况下,你可以通过在属性上添加 @delegate:org.springframework.data.annotation.Transient 注解来排除委托属性的合成字段。

Kotlin 数据类的属性填充

在 Kotlin 中,所有类默认都是不可变的,需要显式声明属性来定义可变属性。考虑以下 dataPerson

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

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

Kotlin 重写属性

Kotlin 允许声明属性覆盖来在子类中修改属性。

open class SuperType(open var field: Int)

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

这样的安排导致两个属性都命名为 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;
}
}
java

SubType 上定义的 getter 和 setter 只会操作 SubType.field,而不会影响 SuperType.field。在这种设计下,使用构造函数是设置 SuperType.field 的唯一默认方法。虽然可以通过在 SubType 中添加一个方法来设置 SuperType.field,例如 this.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
kotlin
  • 一个带有非空值类型的简单值类。

  • 使用 EmailAddress 值类定义属性的数据类。

备注

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