跳到主要内容

Spring Data 对象映射基础

DeepSeek V3 中英对照 Spring Data Object Mapping Fundamentals

本节将介绍 Spring Data 对象映射的基础知识,包括对象创建、字段和属性访问、可变性与不可变性。

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

  1. 使用公开的构造函数之一进行实例创建。

  2. 实例填充以实现所有公开属性的具体化。

对象创建

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

  1. 如果存在无参构造函数,将使用该构造函数。其他构造函数将被忽略。

  2. 如果存在一个带参数的构造函数,将使用该构造函数。

  3. 如果存在多个带参数的构造函数,Spring Data 将使用标注了 @PersistenceCreator 的构造函数。

值解析假定构造函数的参数名称与实体的属性名称相匹配,即解析将按照填充属性的方式执行,包括映射中的所有自定义(不同的数据存储列或字段名称等)。这还要求在类文件中提供参数名称信息或在构造函数上存在 @ConstructorProperties 注解。

对象创建内部机制

为了避免反射的开销,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. 如果属性是不可变的,但暴露了一个 wither 方法(见下文),我们使用 wither 方法来创建一个具有新属性值的新实体实例。

  2. 如果定义了属性访问(即通过 getter 和 setter 方法访问),我们调用 setter 方法。

  3. 默认情况下,我们直接设置字段值。

属性填充内部机制

类似于我们在对象构造中的优化,我们也使用 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

示例 1. 一个生成的属性访问器

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

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

  • 该类公开了一个 withId(…) 方法,用于设置标识符,例如当实例插入到数据存储中并生成标识符时。调用 withId(…) 会创建一个新的 Vertex 对象。所有后续的修改都将发生在新实例中,而之前的实例保持不变。

  • 使用属性访问允许直接调用方法,而不需要使用 MethodHandles

这比反射带来了大约 25% 的性能提升。为了使领域类有资格进行此类优化,它需要遵守一组约束:

  • 类型不能位于默认包或 java 包下。

  • 类型及其构造函数必须是 public 的。

  • 内部类必须是 static 的。

  • 使用的 Java 运行时必须允许在原始 ClassLoader 中声明类。Java 9 及更新版本施加了一些限制。

默认情况下,Spring Data 尝试使用生成的属性访问器,并在检测到限制时回退到基于反射的访问器。

让我们来看一下以下实体:

示例 2. 一个示例实体

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

void setRemarks(String remarks) { 5
this.remarks = remarks;
}
}
java
  • identifier 属性是 final 的,但在构造函数中被设置为 null。该类暴露了一个 withId(…) 方法,用于设置标识符,例如当实例插入到数据存储中并生成标识符时。原始的 Vertex 实例保持不变,而是创建一个新的实例。通常对于其他由存储管理但可能因持久化操作而需要更改的属性也应用相同的模式。

  • firstnamelastname 属性是普通的不可变属性,可能通过 getter 方法暴露。

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

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

  • remarks 属性是可变的,通过直接设置 comment 字段或调用 setter 方法来填充。

  • 该类暴露了一个工厂方法和一个构造函数用于对象创建。这里的核心思想是使用工厂方法而不是额外的构造函数,以避免通过 @PersistenceCreator 进行构造函数歧义消除的需要。相反,属性的默认值在工厂方法中处理。

一般建议

  • 尽量使用不可变对象 — 不可变对象创建起来非常直接,因为实例化一个对象只需要调用其构造函数。此外,这可以防止你的领域对象被大量的 setter 方法所污染,这些方法允许客户端代码操纵对象的状态。如果你确实需要这些方法,最好将它们设置为包保护级别,以便只有有限的同位置类型可以调用它们。仅使用构造函数实例化的速度比属性填充快 30%。

  • 提供一个全参数构造函数 — 即使你不能或不希望将你的实体建模为不可变值,提供一个接受实体所有属性(包括可变属性)作为参数的构造函数仍然是有价值的,因为这允许对象映射跳过属性填充以获得最佳性能。

  • 使用工厂方法而不是重载构造函数来避免 @PersistenceCreator — 为了获得最佳性能,我们需要一个全参数构造函数,但我们通常希望暴露更多特定于应用场景的构造函数,这些构造函数会省略自动生成的标识符等内容。使用静态工厂方法来暴露这些全参数构造函数的变体是一个成熟的模式。

  • 确保你遵守允许使用生成的实例化器和属性访问器类的约束

  • 对于需要生成的标识符,仍然使用 final 字段与 wither 方法结合

  • 使用 Lombok 避免样板代码 — 由于持久化操作通常需要一个接受所有参数的构造函数,它们的声明会变成繁琐的样板参数到字段赋值的重复,使用 Lombok 的 @AllArgsConstructor 可以最好地避免这种情况。

关于不可变映射的注意事项

尽管我们建议尽可能使用不可变映射和构造,但在处理映射时存在一些限制。例如,在双向关系的情况下,A 持有对 B 的构造函数引用,而 B 又持有对 A 的引用,或者更复杂的场景。这种“先有鸡还是先有蛋”的情况对于 Spring Data Neo4j 来说是无法解决的。在实例化 A 时,它急切需要一个已经完全实例化的 B,而 B 又需要一个 A 的实例(准确地说,是同一个实例)。SDN 通常允许这样的模型,但如果从数据库返回的数据包含上述描述的这种情况,SDN 会在运行时抛出 MappingException。在这种情况下,或者在你无法预见返回数据结构的场景中,使用可变字段来处理关系是更好的选择。

Kotlin 支持

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

Kotlin 对象创建

Kotlin 类支持实例化,默认情况下所有类都是不可变的,并且需要显式声明属性来定义可变属性。考虑以下 dataVertex

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

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

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

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

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

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

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

Kotlin 数据类的属性填充

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

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

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