对于最新的稳定版本,请使用 Spring Data Couchbase 5.3.1! |
对于最新的稳定版本,请使用 Spring Data Couchbase 5.3.1! |
本章介绍如何对实体进行建模,并解释它们在 Couchbase Server 本身中的对应表示。
对象映射基础知识
本节介绍了 Spring Data 对象映射、对象创建、字段和属性访问、可变性和不可变性的基础知识。 请注意,本节仅适用于不使用底层数据存储(如 JPA)的对象映射的 Spring Data 模块。 此外,请务必查阅特定于存储的部分,了解特定于存储的对象映射,例如索引、自定义列或字段名称等。
Spring Data 对象映射的核心职责是创建域对象的实例,并将存储原生数据结构映射到这些实例上。 这意味着我们需要两个基本步骤:
-
使用公开的构造函数之一创建实例。
-
实例填充,用于具体化所有公开的属性。
对象创建
Spring Data 会自动尝试检测用于具体化该类型对象的持久实体的构造函数。 解析算法的工作原理如下:
-
如果有一个静态工厂方法注释,则使用它。
@PersistenceCreator
-
如果存在单个构造函数,则使用该构造函数。
-
如果有多个构造函数,并且恰好有一个构造函数用 注释,则使用它。
@PersistenceCreator
-
如果类型是 Java,则使用规范构造函数。
Record
-
如果存在无参数构造函数,则使用它。 其他构造函数将被忽略。
值解析假定构造函数/工厂方法参数名称与实体的属性名称匹配,即解析将像填充属性一样执行,包括映射中的所有自定义项(不同的数据存储列或字段名称等)。
这还需要类文件中提供的参数名称信息或构造函数上存在的注释。@ConstructorProperties
可以使用 Spring Framework 的值注释和特定于存储的 SpEL 表达式来自定义值解析。
有关更多详细信息,请参阅有关商店特定映射的部分。@Value
物业人口
创建实体的实例后,Spring Data 将填充该类的所有剩余持久属性。 除非已由实体的构造函数填充(即通过其构造函数参数列表使用),否则将首先填充标识符属性以允许解析循环对象引用。 之后,将在实体实例上设置尚未由构造函数填充的所有非暂时性属性。 为此,我们使用以下算法:
-
如果属性是不可变的,但公开了一个方法(见下文),我们将使用该方法创建一个具有新属性值的新实体实例。
with…
with…
-
如果定义了属性访问(即通过 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, this.age);
}
void setRemarks(String remarks) { (5)
this.remarks = remarks;
}
}
1 | 标识符属性是最终属性,但在构造函数中设置为。
该类公开用于设置标识符的方法,例如,当实例插入数据存储并生成标识符时。
创建新实例时,原始实例保持不变。
相同的模式通常应用于存储管理的其他属性,但可能需要更改持久性操作。
wither 方法是可选的,因为持久性构造函数(参见 6)实际上是一个复制构造函数,并且设置属性将转换为使用应用新标识符值创建新实例。null withId(…) Person |
2 | 和 属性是可能通过 getter 公开的普通不可变属性。firstname lastname |
3 | 该属性是不可变的,但派生自该属性。
在所示的设计中,数据库值将优先于默认值,因为 Spring Data 使用唯一声明的构造函数。
即使意图是计算应该是首选,也很重要的是,此构造函数也必须将其作为参数(以可能忽略它),否则属性填充步骤将尝试设置年龄字段并失败,因为它是不可变的,并且不存在任何方法。age birthday age with… |
4 | 该属性是可变的,通过直接设置其字段来填充。comment |
5 | 该属性是可变的,并通过调用 setter 方法进行填充。remarks |
6 | 该类公开用于创建对象的工厂方法和构造函数。
这里的核心思想是使用工厂方法而不是其他构造函数,以避免需要通过 来消除构造函数的歧义。
相反,属性的默认值是在工厂方法中处理的。
如果希望 Spring Data 使用工厂方法进行对象实例化,请使用 .@PersistenceCreator @PersistenceCreator |
一般建议
-
尝试坚持使用不可变对象 — 不可变对象很容易创建,因为具体化对象只需调用其构造函数即可。 此外,这样还可以避免域对象充斥着允许客户端代码操作对象状态的 setter 方法。 如果需要这些,最好将它们设置为包保护,以便它们只能由有限数量的共置类型调用。 仅构造函数的实现速度比属性填充快 30%。
-
提供 all-args 构造函数 — 即使不能或不想将实体建模为不可变值,提供将实体的所有属性作为参数(包括可变属性)的构造函数仍然有价值,因为这允许对象映射跳过属性填充以获得最佳性能。
-
使用工厂方法而不是重载构造函数来避免
@PersistenceCreator
— 由于需要全参数构造函数来获得最佳性能,我们通常希望公开更多特定于应用程序用例的构造函数,这些构造函数省略了自动生成的标识符等内容。 使用静态工厂方法来公开 all-args 构造函数的这些变体是一种既定模式。 -
确保遵守允许使用生成的实例化器和属性访问器类的约束 —
-
对于要生成的标识符,仍将 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);
}
}
这两个类都定义一个使用可分配的类型。 然而阴影.
根据类设计,使用构造函数可能是设置 的唯一默认方法。
或者,调用 setter 可以设置 in .
所有这些机制在某种程度上都会产生冲突,因为这些属性共享相同的名称,但可能表示两个不同的值。
如果类型不可赋值,Spring Data 会跳过超类型属性。
也就是说,重写属性的类型必须可分配给其超类型属性类型才能注册为重写,否则超类型属性将被视为瞬态属性。
我们通常建议使用不同的属性名称。field
SubType
SuperType.field
SuperType.field
super.setField(…)
field
SuperType
Spring Data 模块通常支持包含不同值的覆盖属性。 从编程模型的角度来看,有几件事需要考虑:
-
应保留哪个属性(默认为所有声明的属性)? 您可以通过使用 对属性进行批注来排除这些属性。
@Transient
-
如何表示数据存储中的属性? 对不同的值使用相同的字段/列名称通常会导致数据损坏,因此应使用显式字段/列名称至少批注一个属性。
-
不能使用,因为通常不能在不对 setter 实现进行任何进一步假设的情况下设置超属性。
@AccessType(PROPERTY)
Kotlin 支持
Spring Data 调整了 Kotlin 的细节,以允许对象创建和更改。
Kotlin 对象创建
支持实例化 Kotlin 类,默认情况下所有类都是不可变的,并且需要显式属性声明来定义可变属性。
Spring Data 会自动尝试检测用于具体化该类型对象的持久实体的构造函数。 解析算法的工作原理如下:
-
如果存在用 注释的构造函数,则使用该构造函数。
@PersistenceCreator
-
如果类型是 Kotlin 数据类,则使用主构造函数。
-
如果有一个静态工厂方法注释,则使用它。
@PersistenceCreator
-
如果存在单个构造函数,则使用该构造函数。
-
如果有多个构造函数,并且恰好有一个构造函数用 注释,则使用它。
@PersistenceCreator
-
如果类型是 Java,则使用规范构造函数。
Record
-
如果存在无参数构造函数,则使用它。 其他构造函数将被忽略。
考虑以下类: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 检测到参数默认值的构造函数时,如果数据存储没有提供值(或只是返回),则这些参数不存在,因此 Kotlin 可以应用参数默认值。请考虑以下应用参数默认值的类null
name
data class Person(var id: String, val name: String = "unknown")
每当参数不是结果的一部分或其值为 时,默认值为 。name
null
name
unknown
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) {
}
这样的排列呈现两个名称为 的属性。
Kotlin 为每个类中的每个属性生成属性访问器(getter 和 setter)。
实际上,代码如下所示:field
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;
}
}
Getters 和 Setters 只在片场而不是 .
在这样的安排中,使用构造函数是设置 的唯一默认方法。
可以添加 to set via 的方法,但超出了支持的约定。
属性重写在某种程度上会产生冲突,因为属性共享相同的名称,但可能表示两个不同的值。
我们通常建议使用不同的属性名称。SubType
SubType.field
SuperType.field
SuperType.field
SubType
SuperType.field
this.SuperType.field = …
Spring Data 模块通常支持包含不同值的覆盖属性。 从编程模型的角度来看,有几件事需要考虑:
-
应保留哪个属性(默认为所有声明的属性)? 您可以通过使用 对属性进行批注来排除这些属性。
@Transient
-
如何表示数据存储中的属性? 对不同的值使用相同的字段/列名称通常会导致数据损坏,因此应使用显式字段/列名称至少批注一个属性。
-
不能使用,因为无法设置超级属性。
@AccessType(PROPERTY)
Kotlin 值类
Kotlin 值类专为更具表现力的领域模型而设计,以明确基本概念。 Spring Data 可以读取和写入使用值类定义属性的类型。
请考虑以下域模型:
@JvmInline
value class EmailAddress(val theAddress: String) (1)
data class Contact(val id: String, val name:String, val emailAddress: EmailAddress) (2)
1 | 具有不可为 null 值类型的简单值类。 |
2 | 数据类使用 value 类定义属性。EmailAddress |
使用非基元值类型的不可为 null 属性在 compiled 类中展平为值类型。 可为 null 的基元值类型或可为 null 的值中值类型用其包装器类型表示,这会影响值类型在数据库中的表示方式。 |
1 | PropertyAccessor 保存基础对象的可变实例。这是为了启用其他不可变属性的突变。 |
2 | 默认情况下,Spring Data 使用字段访问来读取和写入属性值。根据字段的可见性规则,用于与字段交互。private MethodHandles |
3 | 该类公开用于设置标识符的方法,例如,当实例插入数据存储并生成标识符时。调用将创建一个新对象。所有后续突变都将在新实例中发生,而前一个实例保持不变。withId(…) withId(…) Person |
4 | 使用属性访问允许直接调用方法,而无需使用 。MethodHandles |
1 | 标识符属性是最终属性,但在构造函数中设置为。
该类公开用于设置标识符的方法,例如,当实例插入数据存储并生成标识符时。
创建新实例时,原始实例保持不变。
相同的模式通常应用于存储管理的其他属性,但可能需要更改持久性操作。
wither 方法是可选的,因为持久性构造函数(参见 6)实际上是一个复制构造函数,并且设置属性将转换为使用应用新标识符值创建新实例。null withId(…) Person |
2 | 和 属性是可能通过 getter 公开的普通不可变属性。firstname lastname |
3 | 该属性是不可变的,但派生自该属性。
在所示的设计中,数据库值将优先于默认值,因为 Spring Data 使用唯一声明的构造函数。
即使意图是计算应该是首选,也很重要的是,此构造函数也必须将其作为参数(以可能忽略它),否则属性填充步骤将尝试设置年龄字段并失败,因为它是不可变的,并且不存在任何方法。age birthday age with… |
4 | 该属性是可变的,通过直接设置其字段来填充。comment |
5 | 该属性是可变的,并通过调用 setter 方法进行填充。remarks |
6 | 该类公开用于创建对象的工厂方法和构造函数。
这里的核心思想是使用工厂方法而不是其他构造函数,以避免需要通过 来消除构造函数的歧义。
相反,属性的默认值是在工厂方法中处理的。
如果希望 Spring Data 使用工厂方法进行对象实例化,请使用 .@PersistenceCreator @PersistenceCreator |
1 | 具有不可为 null 值类型的简单值类。 |
2 | 数据类使用 value 类定义属性。EmailAddress |
使用非基元值类型的不可为 null 属性在 compiled 类中展平为值类型。 可为 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 支持文档自动过期。
该库通过注释实现对它的支持。
您可以设置一个值,该值转换为自动删除文档之前的秒数。
如果要使其在突变后 10 秒内过期,请将其设置为 .
或者,您可以使用 Spring 的属性支持和参数配置到期时间,以允许动态更改到期时间值。
例如:。
该属性必须可解析为 int 值,并且不能混合使用这两种方法。@Document
expiry
@Document(expiry = 10)
expiryExpression
@Document(expiryExpression = "${valid.document.expiry}")
如果希望文档中的字段名称与实体中使用的字段名称不同,则可以在注释上设置不同的名称。
例如,如果要保持文档较小,则可以将 firstname 字段设置为 。
在 JSON 文档中,你将看到 而不是 .@Field
@Field("fname")
{"fname": ".."}
{"firstname": ".."}
注解需要存在,因为 Couchbase 中的每个文档都需要一个唯一的密钥。
此键必须是长度最大为 250 个字符的任何字符串。
随意使用适合您用例的任何内容,无论是 UUID、电子邮件地址还是其他任何东西。@Id
可以选择为写入 Couchbase-Server 存储桶分配持久性要求;指示 Couchbase Server 更新集群内存和/或磁盘位置中的多个节点上的指定文档;在考虑要提交的写入之前。
也可以通过 或 注释来配置默认耐久性要求。
例如:将强制将突变复制到大多数数据服务节点。这两种注释都支持通过属性进行基于表达式的持久性级别分配(注意不支持 SPEL)。@Document
@Durability
@Document(durabilityLevel = DurabilityLevel.MAJORITY)
durabilityExpression
数据类型和转换器
选择的存储格式是 JSON。它很棒,但像许多数据表示一样,它允许的数据类型比您在 Java 中直接表达的数据类型要少。 因此,对于所有非基元类型,都需要进行某种形式的与受支持类型的转换。
对于以下实体字段类型,无需添加特殊处理:
Java 类型 | JSON 表示 |
---|---|
字符串 |
字符串 |
布尔 |
布尔 |
字节 |
数 |
短 |
数 |
整数 |
数 |
长 |
数 |
浮 |
数 |
双 |
数 |
零 |
写入时忽略 |
由于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"
]
}
您不需要一直将所有内容分解为原始类型和列表/地图。
当然,您也可以从这些基元值中组成其他对象。
让我们修改最后一个示例,以便我们要存储 :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"
]
}
大多数情况下,您还需要存储一个时态值,例如 .
由于它不能直接存储在 JSON 中,因此需要进行转换。
该库实现了 和 JodaTime 类型(如果在类路径上)的默认转换器。
默认情况下,所有这些在文档中都表示为 unix 时间戳(数字)。
您始终可以使用自定义转换器覆盖默认行为,如下所示。
下面是一个示例:Date
Date
Calendar
@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 property 设置为 true,可以将 Date 与符合 ISO-8601 的字符串相互转换。
如果您想覆盖转换器或实现自己的转换器,这也是可能的。
该库实现了通用的 Spring Converter 模式。
您可以在配置中的 Bean 创建时插入自定义转换器。
以下是如何配置它(在您的覆盖中):org.springframework.data.couchbase.useISOStringConverterForDate
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
-
始终将更多特殊转换器放在通用转换器之前,以避免执行错误转换器的情况。
-
对于日期,读取转换器应该能够从任何(而不仅仅是 )读取。 这是 N1QL 支持所必需的。
Number
Long
Java 类型 | JSON 表示 |
---|---|
字符串 |
字符串 |
布尔 |
布尔 |
字节 |
数 |
短 |
数 |
整数 |
数 |
长 |
数 |
浮 |
数 |
双 |
数 |
零 |
写入时忽略 |
乐观锁定
在某些情况下,您可能希望确保在对文档执行更改操作时不会覆盖其他用户更改。为此,您有三种选择:事务(从 Couchbase 6.5 开始)、悲观并发(锁定)或乐观并发。
乐观并发往往比悲观并发或事务提供更好的性能,因为数据上没有实际的锁,也没有存储有关操作的额外信息(没有事务日志)。
为了实现乐观锁定,Couchbase 使用了 CAS(比较和交换)方法。当文档发生突变时,CAS 值也会发生变化。 CAS 对客户端是不透明的,您唯一需要知道的是,当内容或元信息也发生变化时,它也会发生变化。
在其他数据存储中,可以通过具有递增计数器的任意版本字段来实现类似的行为。
由于 Couchbase 以更好的方式支持这一点,因此很容易实现。
如果你想要自动乐观锁定支持,你需要做的就是在一个长字段上添加一个注释,如下所示:@Version
@Document
public class User {
@Version
private long version;
// constructor, getters, setters...
}
如果通过模板或存储库加载文档,则版本字段将自动填充当前 CAS 值。
请务必注意,您不应该访问该字段,甚至不应该自行更改它。
将文档保存回去后,它将成功或失败,并显示 .
如果出现这样的异常,进一步的方法取决于您希望在应用程序方面实现什么。
您应该重试完整的加载-更新-写入循环,或者将错误传播到上层以便正确处理。OptimisticLockingFailureException
验证
该库支持 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 注释对字段进行注释。
如果验证失败,则抛出 a。save()
ConstraintViolationException
@Size(min = 10)
@Field
private String name;
审计
可以通过Spring Data审计机制自动审计实体(跟踪哪个用户创建了对象,更新了对象以及在什么时间更新了对象)。
首先,请注意,只有具有注释字段的实体才能审核创建(否则框架会将创建解释为更新)。@Version
审计的工作原理是用 、 和 对字段进行批注。
在保留实体时,框架将自动在这些字段上注入正确的值。
xxxDate 注解必须放在一个字段(或兼容的,例如 jodatime 类)上,而 xxxBy 注解可以放在任何类的字段上(尽管两个字段必须属于同一类型)。@CreatedBy
@CreatedDate
@LastModifiedBy
@LastModifiedDate
Date
T
要配置审计,首先需要在上下文中具有审计员感知 bean。
所述 bean 必须是 type(允许生成一个可以存储在我们之前看到的 xxxBy 类型的字段中的值)。
其次,您必须使用注释在类中激活审核。AuditorAware<T>
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
String
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();
}