|
此版本仍在开发中，目前尚不被视为稳定版本。如需最新稳定版本，请使用 Spring Data Neo4j 8.0.4！ |
Spring Data 对象映射基础
本节涵盖 Spring Data 对象映射、对象创建、字段和属性访问、可变性与不可变性的基本原理。
Spring Data 对象映射的核心职责是创建领域对象的实例，并将存储原生的数据结构映射到这些对象上。 这意味着我们需要两个基本步骤：
-
通过使用公开的构造函数之一来创建实例。
-
实例填充以实例化所有公开的属性。
对象创建
Spring Data 会自动尝试检测持久化实体的构造函数，以用于实例化该类型的对象。 解析算法的工作方式如下：
-
如果存在无参构造函数，将被使用。<br/>其他构造函数将被忽略。
-
如果存在一个接受参数的单个构造函数，它将被使用。
-
如果有多个带参数的构造函数，Spring Data 将使用带有注解
@Autowired的构造函数。
该值解析假设构造函数参数名称与实体的属性名称匹配，即解析将按照如果要填充属性来进行，包括所有映射中的自定义设置（例如不同的数据存储列名或字段名等）。
这也要求类文件中可用参数名称信息或者构造函数上存在@ConstructorProperties注解。
属性填充
一旦实体实例被创建，Spring Data 就会填充该类中所有其余的持久化属性。 除非标识符属性已经由实体的构造函数填充（即通过其构造函数参数列表传入），否则将首先填充标识符属性，以便解析循环对象引用。 之后，所有尚未通过构造函数填充的非瞬态（non-transient）属性都会被设置到实体实例上。 为此，我们使用以下算法：
-
如果该属性是不可变的，但提供了一个 wither 方法（见下文），我们便使用该 wither 方法来创建一个具有新属性值的新实体实例。
-
如果定义了属性访问（即通过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);
}
void setRemarks(String remarks) { (5)
this.remarks = remarks;
}
}| 1 | 标识符属性为 final 类型，但在构造函数中被设置为 null。该类公开了一个 原始的 对于其他由存储管理但可能需为持久化操作而更改的属性，通常也采用相同的模式。 |
| 2 | firstname 和 lastname 属性是普通的不可变属性，可能通过 getter 方法对外暴露。 |
| 3 | 属性 age 是一个不可变的派生属性，其值来源于属性 birthday。按照所示设计，数据库中的值将优先于默认值，因为 Spring Data 仅使用已声明的唯一构造函数。 即使意图是希望计算结果优先，也重要的是该构造函数还需以 age 作为参数（以便可能忽略它），否则在属性填充步骤中，系统将尝试设置 age 字段，但由于该字段是不可变的且不存在对应的 setter 方法，操作将会失败。 |
| 4 | comment 属性是可变的，可以通过直接设置其字段来填充。 |
| 5 | remarks 属性是可变的，并且可以通过直接设置 comment 字段或调用其setter方法来填充。 |
| 6 | 该类暴露了一个工厂方法和一个构造函数用于对象创建。
这里的核心思想是使用工厂方法而不是额外的构造函数，以避免通过@PersistenceCreator进行构造函数去歧义化的需求。
相反，默认属性的设置在工厂方法中处理。 |
通用建议
-
尽量使用不可变对象 — 不可变对象易于创建，因为实例化一个对象只需调用其构造函数即可。此外，这可防止您的领域对象被大量setter方法所污染，从而避免客户端代码随意修改对象状态。如果确实需要这些方法，建议将其设为包私有（package-protected），以便仅限于有限数量的邻近类型调用。仅通过构造函数进行实例化比通过属性赋值快约30%。
-
提供一个包含所有参数的构造函数 — 即使你无法或不希望将实体建模为不可变值，仍然建议提供一个接收实体所有属性（包括可变属性）作为参数的构造函数，因为这样可以让对象映射跳过属性填充步骤，从而实现最佳性能。
-
使用工厂方法替代重载构造函数，以避免
@PersistenceCreator— 由于需要全参数构造函数以实现最佳性能，我们通常希望暴露更多针对特定应用场景的构造函数，这些构造函数会省略自动生成的标识符等内容。 采用静态工厂方法来暴露这些全参数构造函数的变体，是一种既定的设计模式。 -
请确保遵守相关约束，以允许生成的实例化器和属性访问器类被使用
-
为了生成标识符，仍需将最终字段与一个 setter 方法结合使用
-
使用 Lombok 避免样板代码 — 由于持久化操作通常需要一个包含所有参数的构造函数，其声明往往会变成繁琐的样板代码，即重复地将参数赋值给字段。通过使用 Lombok 的
@AllArgsConstructor注解，可以很好地避免这种情况。
关于不可变映射的说明
虽然我们建议尽可能使用不可变映射和构造，但在映射方面仍存在一些限制。给定一个双向关系，其中 A 包含对 B 和 B 的构造函数引用，而 B 又引用了 A，或者更复杂的场景。这种“先有鸡还是先有蛋”的困境在 Spring Data Neo4j 中无法解决。在实例化 A 时，它迫切需要一个完全实例化的 B，而另一方面，B 的实例化又需要一个（确切地说是同一个）A 的实例。SDN（Spring Data Neo4j）总体上允许此类模型，但如果从数据库返回的数据包含上述所述的这种情形，它会在运行时抛出 MappingException。在这些情况或场景中，当您无法预知返回数据的具体结构时，为关系使用可变字段会更为合适。
Kotlin 支持
Spring Data 适配了 Kotlin 的特性，以支持对象的创建和变更。
Kotlin 对象创建
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。