|
此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Data Couchbase 5.4.0！ |
建模实体
本章描述了如何对实体进行建模，并解释了它们在 Couchbase Server 本身中的对应表示。
对象映射基础知识
本节介绍了 Spring Data 对象映射、对象创建、字段和属性访问、可变性和不可变性的基础知识。 请注意，本节仅适用于不使用底层数据存储（如 JPA）的对象映射的 Spring Data 模块。 此外，请务必查阅特定于 store 的部分，了解特定于 store 的对象映射，例如索引、自定义列或字段名称等。
Spring Data 对象映射的核心职责是创建域对象的实例并将存储原生数据结构映射到这些实例上。 这意味着我们需要两个基本步骤：
-
使用公开的构造函数之一创建实例。
-
实例填充 实现所有公开的属性。
对象创建
Spring Data 会自动尝试检测用于具体化该类型对象的持久实体的构造函数。 解析算法的工作原理如下：
-
如果有一个 static factory method，并带有
@PersistenceCreator然后它被使用。 -
如果只有一个构造函数，则使用它。
-
如果有多个构造函数，并且只有一个构造函数被注释为
@PersistenceCreator，则使用它。 -
如果类型是 Java
Record使用 canonical 构造函数。 -
如果存在无参数构造函数，则使用它。 其他构造函数将被忽略。
值解析假定构造函数/工厂方法参数名称与实体的属性名称匹配，即解析将像要填充属性一样执行，包括映射中的所有自定义（不同的数据存储列或字段名称等）。
这还需要类文件中可用的参数名称信息或@ConstructorProperties注解。
值 resolution 可以使用 Spring Framework 的@Valuevalue 注释。
有关更多详细信息，请参阅特定于 store 的映射部分。
物业人口
创建实体的实例后， Spring Data 将填充该类的所有剩余持久属性。 除非已由实体的构造函数填充（即通过其构造函数参数列表使用），否则将首先填充 identifier 属性以允许解析循环对象引用。 之后，将在实体实例上设置尚未由构造函数填充的所有非临时属性。 为此，我们使用以下算法：
-
如果该属性是不可变的，但公开了
with…方法（见下文），我们使用with…方法创建具有新属性值的新实体实例。 -
如果定义了属性访问（即通过 getter 和 setter 进行访问），我们将调用 setter 方法。
-
如果属性是可变的，我们直接设置字段。
-
如果属性是不可变的，我们将使用持久性作（请参阅对象创建）使用的构造函数来创建实例的副本。
-
默认情况下，我们直接设置 field 值。
让我们看看以下实体：
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;
}
}| 1 | identifier 属性是 final 的，但设置为null在构造函数中。
该类公开了一个withId(…)方法，例如，当实例插入数据存储并生成标识符时。
原版Person创建新实例时，实例保持不变。
相同的模式通常适用于存储管理的其他属性，但对于持久性作，可能需要更改这些属性。
wither 方法是可选的，因为持久化构造函数（参见 6）实际上是一个复制构造函数，并且设置该属性将被转换为创建一个应用了新标识符值的新实例。 |
| 2 | 这firstname和lastnameproperties 是可能通过 getter 公开的普通不可变属性。 |
| 3 | 这ageproperty 是一个不可变的，但派生自birthday财产。
显示设计后，数据库值将胜过默认值，因为 Spring Data 使用唯一声明的构造函数。
即使意图是应该首选计算，这个构造函数也接受ageas 参数（可能会忽略它），否则，属性 population 步骤将尝试设置 age 字段并失败，因为它是不可变的，并且没有with…方法。 |
| 4 | 这commentproperty 是可变的，并通过直接设置其 field 来填充。 |
| 5 | 这remarksproperty 是可变的，并通过调用 setter 方法进行填充。 |
| 6 | 该类公开了用于创建对象的工厂方法和构造函数。
这里的核心思想是使用工厂方法而不是额外的构造函数，以避免通过@PersistenceCreator.
相反，属性的默认值是在工厂方法中处理的。
如果您希望 Spring Data 使用工厂方法进行对象实例化，请使用@PersistenceCreator. |
一般建议
-
尽量坚持使用不可变对象 — 不可变对象很容易创建，因为具体化对象只需调用其构造函数即可。 此外，这还可以避免您的域对象充斥着允许客户端代码作对象状态的 setter 方法。 如果需要这些，最好将它们设为包保护，以便它们只能由有限数量的共存类型调用。 仅构造函数具体化比属性填充快 30%。
-
提供全参数构造函数 — 即使您不能或不想将实体建模为不可变值，提供将实体的所有属性（包括可变属性）作为参数的构造函数仍然具有价值，因为这允许对象映射跳过属性填充以获得最佳性能。
-
使用工厂方法而不是重载的构造函数来避免
@PersistenceCreator— 由于需要全参数构造函数才能获得最佳性能，我们通常希望公开更多特定于应用程序用例的构造函数，这些构造函数省略了自动生成的标识符等内容。 使用静态工厂方法来公开 all-args 构造函数的这些变体是一种既定模式。 -
请确保遵守允许使用生成的 instantiator 和 property 访问器类的约束 —
-
对于要生成的标识符，仍将 final 字段与全参数持久性构造函数 （preferred） 或
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使用 Assignable 类型。SubType然而，阴影SuperType.field.
根据类设计，使用构造函数可能是设置SuperType.field.
或者，调用super.setField(…)可以在 setter 中设置field在SuperType.
所有这些机制在某种程度上都会产生冲突，因为属性共享相同的名称，但可能表示两个不同的值。
如果类型不可分配，则 Spring Data 会跳过超类型属性。
也就是说，被覆盖属性的类型必须可分配给其超类型属性类型才能注册为 override，否则超类型属性被视为临时属性。
我们通常建议使用不同的属性名称。
Spring Data 模块通常支持持有不同值的覆盖属性。 从编程模型的角度来看，需要考虑以下几点：
-
应该保留哪个属性（默认为所有声明的属性）？ 您可以通过使用
@Transient. -
如何在数据存储中表示属性？ 对不同的值使用相同的字段/列名称通常会导致数据损坏，因此您应该使用显式字段/列名称至少注释一个属性。
-
用
@AccessType(PROPERTY)不能使用，因为如果不对 setter 实现进行任何进一步的假设，通常不能设置 super-property。
Kotlin 支持
Spring Data 调整了 Kotlin 的细节以允许对象创建和更改。
Kotlin 对象创建
支持实例化 Kotlin 类，默认情况下所有类都是不可变的，并且需要显式属性声明来定义可变属性。
Spring Data 会自动尝试检测用于具体化该类型对象的持久实体的构造函数。 解析算法的工作原理如下：
-
如果存在一个带有
@PersistenceCreator，则使用它。 -
如果类型是 Kotlin 数据类，则使用主构造函数。
-
如果有一个 static factory method，并带有
@PersistenceCreator然后它被使用。 -
如果只有一个构造函数，则使用它。
-
如果有多个构造函数，并且只有一个构造函数被注释为
@PersistenceCreator，则使用它。 -
如果类型是 Java
Record使用 canonical 构造函数。 -
如果存在无参数构造函数，则使用它。 其他构造函数将被忽略。
请考虑以下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 检测到具有参数default的构造函数时，如果数据存储不提供值（或只是返回）null），以便 Kotlin 可以应用参数默认值。请考虑以下类，该类为name
data class Person(var id: String, val name: String = "unknown")每次nameparameter 不是 result 的一部分，或者其值为null，则name默认为unknown.
Spring Data 不支持委托属性。映射元数据会筛选 Kotlin Data 类的委托属性。
在所有其他情况下，您可以通过使用@delegate:org.springframework.data.annotation.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;
}
}上的 getter 和 setterSubType仅设置SubType.field而不是SuperType.field.
在这样的安排中，使用构造函数是将SuperType.field.
添加一个SubType设置SuperType.field通过this.SuperType.field = …是可能的，但不符合支持的约定。
属性覆盖在某种程度上会产生冲突，因为属性共享相同的名称，但可能表示两个不同的值。
我们通常建议使用不同的属性名称。
Spring Data 模块通常支持持有不同值的覆盖属性。 从编程模型的角度来看，需要考虑以下几点：
-
应该保留哪个属性（默认为所有声明的属性）？ 您可以通过使用
@Transient. -
如何在数据存储中表示属性？ 对不同的值使用相同的字段/列名称通常会导致数据损坏，因此您应该使用显式字段/列名称至少注释一个属性。
-
用
@AccessType(PROPERTY)不能使用，因为无法设置 super-property。
Kotlin 值类
Kotlin 值类专为更具表现力的领域模型而设计，以明确基本概念。 Spring Data 可以使用 Value Classes 读取和写入定义属性的类型。
请考虑以下域模型：
@JvmInline
value class EmailAddress(val theAddress: String) (1)
data class Contact(val id: String, val name:String, val emailAddress: EmailAddress) (2)| 1 | 具有不可为 null 的值类型的简单值类。 |
| 2 | Data 类使用EmailAddressvalue 类。 |
| 使用非基元值类型的不可为 null 的属性在编译类中被平展为 value 类型。 可为 null 的基元值类型或可为 null 的值类型用其包装器类型表示，这会影响值类型在数据库中的表示方式。 |
文档和字段
所有实体都应使用@Document注解，但这不是必需的。
此外，实体中的每个字段都应该使用@Field注解。虽然这是 - 严格来说 -
可选，它有助于减少边缘情况，并清楚地显示实体的意图和设计。它还可用于
将字段存储在其他名称下。
还有一个特殊的@Id注释，这需要始终保持原位。最佳做法是同时为属性命名id.
下面是一个非常简单的User实体：
import org.springframework.data.annotation.Id;
import org.springframework.data.couchbase.core.mapping.Field;
import org.springframework.data.couchbase.core.mapping.Document;
@Document
public class User {
@Id
private String id;
@Field
private String firstname;
@Field
private String lastname;
public User(String id, String firstname, String lastname) {
this.id = id;
this.firstname = firstname;
this.lastname = lastname;
}
public String getId() {
return id;
}
public String getFirstname() {
return firstname;
}
public String getLastname() {
return lastname;
}
}Couchbase Server 支持文档的自动过期。
该库通过@Document注解。
您可以设置expiry值，该值转换为自动删除文档之前的秒数。
如果你想让它在 mutation 后 10 秒过期，可以像@Document(expiry = 10).
或者，你可以使用 Spring 的属性 support 和expiryExpression参数，以允许动态更改过期值。
例如：@Document(expiryExpression = "${valid.document.expiry}").
该属性必须可解析为 int 值，并且这两种方法不能混合使用。
如果您希望文档内的字段名称与实体中使用的字段名称不同，则可以在@Field注解。
例如，如果您想保持文档较小，则可以将 firstname 字段设置为@Field("fname").
在 JSON 文档中，您将看到{"fname": ".."}而不是{"firstname": ".."}.
这@Idannotation 需要存在，因为 Couchbase 中的每个文档都需要一个唯一的键。
此键必须是长度最大为 250 个字符的任何字符串。
随意使用任何适合您的用例，无论是 UUID、电子邮件地址还是其他任何内容。
可以选择为对 Couchbase-Server 存储桶的写入分配持久性要求;指示 Couchbase Server 在集群中内存和/或磁盘位置的多个节点上更新指定文档;在考虑提交写入之前。
默认持久性要求也可以通过@Document或@Durability附注。
例如：@Document(durabilityLevel = DurabilityLevel.MAJORITY)将强制将更改复制到大多数 Data Service 节点。这两个注释都支持基于表达式的持久性级别分配，方法是durabilityExpression属性（注意 SPEL 不支持）。
数据类型和转换器
选择的存储格式为 JSON。这很好，但与许多数据表示形式一样，它允许的数据类型比在 Java 中直接表示的数据类型少。 因此，对于所有非基元类型，都需要进行某种形式的与支持的类型之间的转换。
对于以下实体字段类型，您无需添加特殊处理：
| Java 类型 | JSON 表示形式 |
|---|---|
字符串 |
字符串 |
布尔 |
布尔 |
字节 |
数 |
短 |
数 |
int |
数 |
长 |
数 |
浮 |
数 |
双 |
数 |
零 |
写入时忽略 |
由于 JSON 支持对象（“映射”）和列表，因此Map和List类型可以自然地转换。
如果它们仅包含最后一段中的基元字段类型，则无需添加特殊处理。
下面是一个示例：
@Document
public class User {
@Id
private String id;
@Field
private List<String> firstnames;
@Field
private Map<String, Integer> childrenAges;
public User(String id, List<String> firstnames, Map<String, Integer> childrenAges) {
this.id = id;
this.firstnames = firstnames;
this.childrenAges = childrenAges;
}
}使用一些示例数据存储用户可能类似于 JSON 表示形式：
{
"_class": "foo.User",
"childrenAges": {
"Alice": 10,
"Bob": 5
},
"firstnames": [
"Foo",
"Bar",
"Baz"
]
}你不需要一直把所有东西都分解成 primitive types 和 Lists/Map。
当然，您也可以从这些原始值中组合其他对象。
让我们修改最后一个示例，以便我们想要存储一个List之Children:
@Document
public class User {
@Id
private String id;
@Field
private List<String> firstnames;
@Field
private List<Child> children;
public User(String id, List<String> firstnames, List<Child> children) {
this.id = id;
this.firstnames = firstnames;
this.children = children;
}
static class Child {
private String name;
private int age;
Child(String name, int age) {
this.name = name;
this.age = age;
}
}
}填充的对象可能如下所示：
{
"_class": "foo.User",
"children": [
{
"age": 4,
"name": "Alice"
},
{
"age": 3,
"name": "Bob"
}
],
"firstnames": [
"Foo",
"Bar",
"Baz"
]
}大多数时候，您还需要存储一个时间值，例如Date.
由于它不能直接存储在 JSON 中，因此需要进行转换。
该库实现了Date,Calendar和 JodaTime 类型（如果在 Classpath 上）。
默认情况下，所有这些都在文档中表示为 unix 时间戳（数字）。
您始终可以使用自定义转换器覆盖默认行为，如下所示。
下面是一个示例：
@Document
public class BlogPost {
@Id
private String id;
@Field
private Date created;
@Field
private Calendar updated;
@Field
private String title;
public BlogPost(String id, Date created, Calendar updated, String title) {
this.id = id;
this.created = created;
this.updated = updated;
this.title = title;
}
}填充的对象可能如下所示：
{
"title": "a blog post title",
"_class": "foo.BlogPost",
"updated": 1394610843,
"created": 1394610843897
}（可选）通过设置 system 属性，可以将 Date 与 ISO-8601 兼容字符串相互转换org.springframework.data.couchbase.useISOStringConverterForDate设置为 true。
如果您想覆盖转换器或实现自己的转换器，这也是可能的。
该库实现了通用的 Spring Converter 模式。
您可以在配置中创建 bean 时插入自定义转换器。
以下是配置它的方法（在覆盖的AbstractCouchbaseConfiguration):
@Override
public CustomConversions customConversions() {
return new CustomConversions(Arrays.asList(FooToBarConverter.INSTANCE, BarToFooConverter.INSTANCE));
}
@WritingConverter
public static enum FooToBarConverter implements Converter<Foo, Bar> {
INSTANCE;
@Override
public Bar convert(Foo source) {
return /* do your conversion here */;
}
}
@ReadingConverter
public static enum BarToFooConverter implements Converter<Bar, Foo> {
INSTANCE;
@Override
public Foo convert(Bar source) {
return /* do your conversion here */;
}
}使用自定义转化时，您需要注意以下几点：
-
为了明确起见，请始终使用
@WritingConverter和@ReadingConverter转换器上的注释。 特别是如果您正在处理原始类型转换，这将有助于减少可能的错误转换。 -
如果您实现写入转换器，请确保仅解码为原始类型、映射和列表。 如果您需要更复杂的对象类型，请使用
CouchbaseDocument和CouchbaseList类型，底层翻译引擎也可以理解这些类型。 最好的办法是坚持使用尽可能简单的转换。 -
始终在通用转换器之前放置更多特殊转换器，以避免执行错误转换器的情况。
-
对于日期，读取转换器应该能够从任何
Number（不仅仅是Long). 这是 N1QL 支持所必需的。
乐观锁定
在某些情况下，您可能希望确保在对文档执行更改作时不会覆盖其他用户的更改。为此，您有三种选择：事务（自 Couchbase 6.5 起）、悲观并发（锁定）或乐观并发。
乐观并发往往比悲观并发或事务提供更好的性能，因为没有对数据持有实际的锁，也没有存储有关作的额外信息（无事务日志）。
为了实现乐观锁定，Couchbase 使用了 CAS（比较和交换）方法。当文档发生更改时，CAS 值也会更改。 CAS 对客户端是不透明的，您唯一需要知道的是，当内容或元信息发生变化时，它也会发生变化。
在其他数据存储中，可以通过具有递增计数器的任意版本字段来实现类似的行为。
由于 Couchbase 以更好的方式支持这一点，因此很容易实现。
如果你想要自动乐观锁定支持，你需要做的就是添加一个@Version注解，如下所示：
@Document
public class User {
@Version
private long version;
// constructor, getters, setters...
}如果通过模板或存储库加载文档，则 version 字段将自动填充当前 CAS 值。
请务必注意，您不应访问该字段，甚至不应自行更改该字段。
将文档保存回去后，它将成功或失败，并显示OptimisticLockingFailureException.
如果遇到此类异常，则进一步的方法取决于您希望在应用程序方面实现什么。
您应该重试完整的 load-update-write 周期，或者将错误传播到上层以进行正确处理。
验证
该库支持 JSR 303 验证，该验证直接基于实体中的注释。 当然，您可以在服务层中添加各种验证，但这样它可以很好地耦合到您的实际实体。
要使其正常工作，您需要包含两个额外的依赖项。 JSR 303 和实现它的库，就像 Hibernate 支持的那个：
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>现在，您需要将两个 bean 添加到您的配置中：
@Bean
public LocalValidatorFactoryBean validator() {
return new LocalValidatorFactoryBean();
}
@Bean
public ValidatingCouchbaseEventListener validationEventListener() {
return new ValidatingCouchbaseEventListener(validator());
}现在，您可以使用 JSR303 注释对字段进行注释。
如果对save()失败时，一个ConstraintViolationException被抛出。
@Size(min = 10)
@Field
private String name;审计
可以通过 Spring Data 审计机制自动审计实体（跟踪哪个用户创建了对象，更新了对象以及何时）。
首先，请注意，只有具有@Version可以审核带注释的字段以进行创建（否则框架会将创建解释为更新）。
审计的工作原理是使用@CreatedBy,@CreatedDate,@LastModifiedBy和@LastModifiedDate.
在保留实体时，框架将自动在这些字段上注入正确的值。
xxxDate 注解必须放在Datefield （或兼容的，例如 jodatime 类），而 xxxBy 注解可以放在任何类的字段上T（尽管两个字段必须属于同一类型）。
要配置审计，首先需要在上下文中有一个可识别审计员的 Bean。
所述 bean 必须是 typeAuditorAware<T>（允许生成一个可以存储在 xxxBy 类型的字段中的值T我们之前看到过）。
其次，您必须在@Configuration类@EnableCouchbaseAuditing注解。
下面是一个示例：
@Document
public class AuditedItem {
@Id
private final String id;
private String value;
@CreatedBy
private String creator;
@LastModifiedBy
private String lastModifiedBy;
@LastModifiedDate
private Date lastModification;
@CreatedDate
private Date creationDate;
@Version
private long version;
//..omitted constructor/getters/setters/...
}注意两者@CreatedBy和@LastModifiedBy都被放在Stringfield 中，因此我们的AuditorAware必须与String.
public class NaiveAuditorAware implements AuditorAware<String> {
private String auditor = "auditor";
@Override
public String getCurrentAuditor() {
return auditor;
}
public void setAuditor(String auditor) {
this.auditor = auditor;
}
}为了将所有这些联系在一起，我们使用 java 配置来声明 AuditorAware bean 并激活审计：
@Configuration
@EnableCouchbaseAuditing //this activates auditing
public class AuditConfiguration extends AbstractCouchbaseConfiguration {
//... a few abstract methods omitted here
// this creates the auditor aware bean that will feed the annotations
@Bean
public NaiveAuditorAware testAuditorAware() {
return new NaiveAuditorAware();
}