Spring Data Object Mapping Fundamentals
本节介绍 Spring Data 对象映射、对象创建、字段和属性访问、可变性和不可变性的基础知识。 Spring Data 对象映射的核心职责是创建域对象实例并将存储本地数据结构映射到这些实例上。这意味着我们需要两个基本步骤：
-
通过使用公开的其中一个构造函数创建实例。
-
实例填充以实现所有公开的属性。
Object creation
Spring Data 自动尝试检测一个持久实体的构造函数，以便用于实现该类型的对象。解决算法的工作方式如下：
-
如果有无参数构造器，则将使用它。将忽略其他构造器。
-
如果有单个构造器接受参数，它将被使用。
-
如果有多个构造器接受参数，则 Spring Data 要使用的构造器必须使用
@PersistenceCreator注释。
值解析假定构造函数参数名称与实体的属性名称匹配，即，执行解析就像填充属性一样，包括映射中的所有自定义项（不同的数据存储列或字段名称等）。这也要求类文件中提供参数名称信息或构造函数上存在 @ConstructorProperties 注释。
为了避免反射时间开销，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 将回退到通过反射进行实体实例化。
Property population
在创建了该实体的一个实例之后，Spring Data 填充该类的所有剩余的持久属性。除非已通过实体的构造函数填充（即通过其构造函数参数列表消耗），否则将首先填充标识符属性，以允许解析循环对象引用。在此之后，所有尚未被构造函数填充的非瞬态属性都会在实体实例上设置。为此，我们使用以下算法：
-
如果属性不可变但公开了一个 wither 方法（见下文），则我们使用 wither 创建一个带有新属性值的新实体实例。
-
如果定义了属性访问（即通过 getter 和 setter 访问），我们正在调用 setter 方法。
-
默认情况下，将直接设置字段值。
与我们的 [对象构建中的优化，映射。基础知识。对象创建。详细信息] 类似，我们还使用 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.lastame);
}
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
}
}
}| 1 | PropertyAccessor 持有底层对象的可变实例。这是为了启用不可变属性的变异。 |
| 2 | 默认情况下，Spring Data 使用字段访问来读取和写入属性值。根据 private 字段的可见性规则，使用 MethodHandles 与字段交互。 |
| 3 | 此类公开了一个 withId(…) 方法，用于设置标识符，例如，当一个实例插入到数据存储中并且已生成一个标识符时。调用 withId(…) 会创建一个新的 Vertex 对象。所有后续突变都将在新实例中发生，而之前的实例保持不变。 |
| 4 | 使用属性访问允许直接调用方法，而不使用 MethodHandles。 |
这给了我们超过反射 25% 的迂回式性能提升。为了使领域类适用于这种优化，它需要遵守一组约束：
-
类型不得驻留在默认值或
java包之下。 -
类型及其构造函数必须为
public -
类型为内部类的类型必须为
static。 -
所使用的 Java Runtime 必须允许在原始
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);
}
void setRemarks(String remarks) { 5
this.remarks = remarks;
}
}| 1 | 标识符属性是最终的，但已在构造器中设置为 null。该类公开了一个 withId(…) 方法，用于设置标识符，例如，当一个实例插入到数据存储中并且已生成一个标识符时。原始 Vertex 实例保持不变，因为创建了一个新的实例。对于其他存储管理的属性通常应用相同的模式，但为了持久性操作可能必须对其进行更改。 |
| 2 | firstname 和 lastname 属性是可通过 Getter 公开的简单不可变属性。 |
| 3 | age 属性是一个不可变的属性，但它是从 birthday 属性派生的。使用所示的设计，数据库值将胜过默认值，因为 Spring Data 使用唯一声明的构造器。即使意图是首选计算，让这个构造器也接受 age 作为参数（可能会忽略它）也很重要，否则属性填充步骤将尝试设置年龄字段并失败，因为它不可变并且没有存在。 |
| 4 | comment 属性是可变的，通过直接设置其字段来填充。 |
| 5 | remarks 属性是可变的，通过直接设置 comment 字段或调用 setter 方法来填充 |
| 6 | 该类公开了一个工厂方法和一个用于创建对象的构造器。这里的主要思想是使用工厂方法而不是附加的构造器，以避免通过 @PersistenceCreator 进行构造器消歧的需要。相反，在工厂方法中处理属性的默认值。 |
General recommendations
-
Try to stick to immutable objects——作为实现对象的直接结果，不可变对象易于创建，然后成为调用其构造函数的问题。此外，这可防止领域对象中充斥允许客户端代码操纵对象状态的 setter 方法。如果您需要这些方法，最好将它们制定为受包保护的方法，以便仅可由有限数量的同置类型调用它们。仅构造函数实现比使用属性填充快 30%。
-
Provide an all-args constructor — 即使您不能或不想将实体建模为不可变值，提供一个构造函数（它将所有实体属性作为参数，包括可变属性）仍然有价值，因为这允许对象映射跳过属性填充，以获得最佳性能。
-
Use factory methods instead of overloaded constructors to avoid `@PersistenceCreator` — 为了获得最佳性能，通常需要一个所有参数构造函数，我们通常希望公开更多应用用例特定的构造函数，这些构造函数省略自动生成标识符等信息。一个成熟的模式是使用静态工厂方法公开所有参数构造函数的这些变体。
-
Make sure you adhere to the constraints that allow the generated instantiator and property accessor classes to be used
-
For identifiers to be generated, still use a final field in combination with a wither method
-
Use Lombok to avoid boilerplate code — 由于持久化操作通常需要一个获取所有参数的构造函数，因此，它们的声明会变成枯燥地重复参数到字段赋值的样板，而使用 Lombok 的
@AllArgsConstructor可以很好地避免这种情况。
Kotlin support
Spring Data 适应 Kotlin 的特殊性，允许创建和更改对象。
Kotlin object creation
支持对 Kotlin 类进行实例化，默认情况下所有类都是不可变的，并且需要显式属性声明来定义可变属性。考虑以下 data 类 Vertex：
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。