|
此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 Spring Data Cassandra 4.5.2！ |
映射
丰富的对象映射支持由MappingCassandraConverter.MappingCassandraConverter具有丰富的元数据模型，该模型提供了完整的功能集来将域对象映射到 CQL 表。
映射元数据模型是通过使用域对象上的注释来填充的。
但是，基础设施不仅限于使用注释作为元数据的唯一来源。
这MappingCassandraConverter还允许您通过遵循一组约定将域对象映射到表，而无需提供任何其他元数据。
在本章中，我们将描述MappingCassandraConverter，如何使用约定将域对象映射到表，以及如何使用基于注释的映射元数据覆盖这些约定。
对象映射基础知识
本节介绍 Spring Data 对象映射、对象创建、字段和属性访问、可变性和不变性的基础知识。 请注意，本节仅适用于不使用底层数据存储（如JPA）的对象映射的Spring Data模块。 此外，请务必查阅特定于商店的部分，了解特定于商店的对象映射，例如索引、自定义列或字段名称等。
Spring Data 对象映射的核心职责是创建域对象的实例并将存储原生数据结构映射到这些实例上。 这意味着我们需要两个基本步骤：
-
使用公开的构造函数之一创建实例。
-
实例填充以具体化所有公开的属性。
对象创建
Spring Data会自动尝试检测持久实体的构造函数，以用于具体化该类型的对象。 分辨率算法的工作原理如下：
-
如果有一个静态工厂方法用
@PersistenceCreator然后它被使用。 -
如果存在单个构造函数，则使用它。
-
如果有多个构造函数，并且只有一个构造函数被
@PersistenceCreator，它被使用。 -
如果类型是 Java
Record使用规范构造函数。 -
如果有一个无参数构造函数，则使用它。 其他构造函数将被忽略。
值解析假定构造函数/工厂方法参数名称与实体的属性名称匹配，即解析将像要填充属性一样执行，包括映射中的所有自定义（不同的数据存储列或字段名称等）。
这还需要类文件中可用的参数名称信息或@ConstructorProperties注释存在于构造函数上。
可以使用 Spring Framework 的@Value使用特定于存储的 SpEL 表达式的值注释。
有关更多详细信息，请参阅商店特定映射部分。
财产人口
创建实体的实例后，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 | identifier 属性是 final ，但设置为null在构造函数中。
该类公开了withId(…)用于设置标识符的方法，例如，当实例插入到数据存储中并生成标识符时。
原件Person实例在创建新实例时保持不变。
相同的模式通常适用于存储管理的其他属性，但可能需要更改才能进行持久性作。
wither 方法是可选的，因为持久性构造函数（见 6）实际上是一个复制构造函数，并且设置该属性将转换为创建一个应用了新标识符值的新实例。 |
| 2 | 这firstname和lastname属性是可能通过 getter 公开的普通不可变属性。 |
| 3 | 这age属性是不可变的，但派生自birthday财产。
在所示设计中，数据库值将胜过默认值，因为 Spring Data 使用唯一声明的构造函数。
即使意图是应首选计算，此构造函数也必须采用ageas 参数（可能会忽略它），否则属性填充步骤将尝试设置 age 字段，但由于它是不可变的并且没有with…方法存在。 |
| 4 | 这comment属性是可变的，通过直接设置其字段来填充。 |
| 5 | 这remarks属性是可变的，并通过调用 setter 方法填充。 |
| 6 | 该类公开了用于创建对象的工厂方法和构造函数。
这里的核心思想是使用工厂方法而不是额外的构造函数，以避免需要通过@PersistenceCreator.
相反，属性的默认值是在工厂方法中处理的。
如果您希望 Spring Data 使用工厂方法进行对象实例化，请使用@PersistenceCreator. |
一般建议
-
尝试坚持使用不可变对象 — 不可变对象很容易创建，因为具体化对象只需调用其构造函数即可。 此外，这还可以避免域对象中充斥着允许客户端代码作对象状态的 setter 方法。 如果需要这些，请更喜欢将它们设置为包保护，以便它们只能由有限数量的共置类型调用。 仅构造函数的具体化比属性填充快 30%。
-
提供全参数构造函数 — 即使不能或不想将实体建模为不可变值，提供将实体的所有属性（包括可变属性）作为参数的构造函数仍然有价值，因为这允许对象映射跳过属性填充以获得最佳性能。
-
使用工厂方法而不是重载的构造函数来避免
@PersistenceCreator— 对于最佳性能所需的全参数构造函数，我们通常希望公开更多特定于应用程序用例的构造函数，这些构造函数省略了自动生成的标识符等内容。 使用静态工厂方法来公开全参数构造函数的这些变体是一种既定模式。 -
确保遵守允许使用生成的实例化器和属性访问器类的约束 —
-
对于要生成的标识符，仍将最终字段与全参数持久性构造函数（首选）或
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使用可分配类型。SubType然而阴影SuperType.field.
根据类设计，使用构造函数可能是唯一的默认方法SuperType.field.
或者，调用super.setField(…)在 setter 中可以设置field在SuperType.
所有这些机制都会在某种程度上产生冲突，因为属性共享相同的名称，但可能表示两个不同的值。
如果类型不可分配，Spring Data 会跳过超类型属性。
也就是说，被覆盖属性的类型必须可分配给其超类型属性类型才能注册为覆盖，否则超类型属性将被视为暂时性。
我们通常建议使用不同的属性名称。
Spring Data 模块通常支持持有不同值的覆盖属性。 从编程模型的角度来看，有几件事需要考虑：
-
应该保留哪个属性（默认为所有声明的属性）？ 您可以通过使用
@Transient. -
如何在数据存储中表示属性？ 对不同的值使用相同的字段/列名称通常会导致数据损坏，因此您应该使用显式字段/列名称对至少一个属性进行注释。
-
用
@AccessType(PROPERTY)不能使用，因为如果不对 setter 实现做出任何进一步的假设，就不能通常设置超属性。
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 检测到具有参数默认值的构造函数时，如果数据存储不提供值（或只是返回null），以便 Kotlin 可以应用参数默认设置。考虑以下类，该类将参数默认值应用于name
data class Person(var id: String, val name: String = "unknown")每次name参数不是结果的一部分，或者其值是null，则name默认为unknown.
Spring Data 不支持委托属性。映射元数据过滤 Kotlin 数据类的委托属性。
在所有其他情况下，您可以通过使用@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 和 setter onSubType仅设置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 | 使用EmailAddressvalue 类。 |
| 使用非基元值类型的不可为 null 属性在编译类中平展为值类型。 可为 null 的基元值类型或可为 null 的值中值类型使用其包装器类型表示，这会影响值类型在数据库中的表示方式。 |
数据映射和类型转换
本节介绍如何将类型映射到 Apache Cassandra 表示形式。
Spring Data for Apache Cassandra 支持 Apache Cassandra 提供的多种类型。 除了这些类型之外，Spring Data for Apache Cassandra 还提供了一组内置转换器来映射其他类型。 您可以提供自己的自定义转换器来调整类型转换。 有关更多详细信息，请参阅“使用自定义转换器覆盖默认映射”。 下表将 Spring Data 类型映射到 Cassandra 类型：
| 类型 | Cassandra 类型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
用户类型 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
每个受支持的类型都映射到默认的 Cassandra 数据类型。
Java 类型可以通过使用@CassandraType，如以下示例所示：
@Table
public class EnumToOrdinalMapping {
@PrimaryKey String id;
@CassandraType(type = Name.INT) Condition asOrdinal;
}
public enum Condition {
NEW, USED
}基于约定的映射
MappingCassandraConverter在未提供其他映射元数据时，使用一些约定将域对象映射到 CQL 表。
约定是：
-
简单（短）Java 类名通过更改为小写来映射到表名。 例如
com.bigbank.SavingsAccount映射到名为savingsaccount. -
转换器使用任何已注册的 Spring
Converter实例来覆盖对象属性到表列的默认映射。 -
对象的属性用于在表中的列之间进行转换。
您可以通过配置NamingStrategy上CassandraMappingContext.
命名策略对象实现表、列或用户定义类型从实体类和实际属性派生的约定。
以下示例演示如何配置NamingStrategy:
NamingStrategy上CassandraMappingContext CassandraMappingContext context = new CassandraMappingContext();
// default naming strategy
context.setNamingStrategy(NamingStrategy.INSTANCE);
// snake_case converted to upper case (SNAKE_CASE)
context.setNamingStrategy(NamingStrategy.SNAKE_CASE.transform(String::toUpperCase));映射配置
除非显式配置，否则MappingCassandraConverter在创建CassandraTemplate.
您可以创建自己的MappingCassandraConverter告诉它在启动时在何处扫描类路径以查找域类以提取元数据和构造索引。
此外，通过创建自己的实例，您可以注册 SpringConverter用于将特定类映射到数据库或映射数据库的实例。
以下示例配置类设置 Cassandra 映射支持：
@Configuration
public class SchemaConfiguration extends AbstractCassandraConfiguration {
@Override
protected String getKeyspaceName() {
return "bigbank";
}
// the following are optional
@Override
public CassandraCustomConversions customConversions() {
return CassandraCustomConversions.create(config -> {
config.registerConverter(new PersonReadConverter()));
config.registerConverter(new PersonWriteConverter()));
});
}
@Override
public SchemaAction getSchemaAction() {
return SchemaAction.RECREATE;
}
// other methods omitted...
}AbstractCassandraConfiguration需要实现定义键空间的方法。AbstractCassandraConfiguration还有一个名为getEntityBasePackages(…).
您可以覆盖它以告诉转换器在哪里扫描带有@Table注解。
您可以将其他转换器添加到MappingCassandraConverter通过重写customConversions方法。
AbstractCassandraConfiguration创建一个CassandraTemplate实例并将其注册到容器中，名称为cassandraTemplate. |
基于元数据的映射
要充分利用 Spring Data for Apache Cassandra 支持中的对象映射功能，您应该使用@Table注解。
这样做可以让类路径扫描程序查找并预处理您的域对象以提取必要的元数据。
仅使用带注释的实体来执行架构作。
在最坏的情况下，一个SchemaAction.RECREATE_DROP_UNUSED作会删除您的表，并且您会丢失您的数据。
请注意，表是从会话键空间访问的。
但是，您可以指定自定义键空间以使用特定键空间中的表/UDT。
以下示例显示了一个简单的域对象：
package com.mycompany.domain;
@Table
public class Person {
@Id
private String id;
@CassandraType(type = Name.VARINT)
private Integer ssn;
private String firstName;
private String lastName;
}这@Id注释告诉映射器您要用于 Cassandra 主键的属性。
复合主键可能需要略有不同的数据模型。 |
使用主键
Cassandra 需要 CQL 表至少一个分区键字段。
表还可以声明一个或多个聚类键字段。
当您的 CQL 表具有复合主键时，您必须创建一个@PrimaryKeyClass以定义复合主键的结构。
在这种情况下，“复合主键”是指一个或多个分区列（可选地与一个或多个聚类列组合）。
主键可以使用任何单一的简单 Cassandra 类型或映射的用户定义类型。 不支持集合类型的主键。
简单主键
一个简单的主键由一个实体类中的一个分区键字段组成。由于它只是一个字段，我们可以安全地假设它是一个分区键。以下列表显示了在 Cassandra 中定义的 CQL 表，其主键为user_id:
CREATE TABLE user (
user_id text,
firstname text,
lastname text,
PRIMARY KEY (user_id))
;以下示例显示了一个 Java 类，该类经过注释，使其对应于上一个列表中定义的 Cassandra：
@Table(value = "login_event")
public class LoginEvent {
@PrimaryKey("user_id")
private String userId;
private String firstname;
private String lastname;
// getters and setters omitted
}复合键
复合主键（或复合键）由多个主键字段组成。 也就是说，复合主键可以由多个分区键、一个分区键和一个聚类键或多个主键字段组成。
使用 Spring Data for Apache Cassandra 可以以两种方式表示复合键：
-
嵌入到实体中。
-
通过使用
@PrimaryKeyClass.
复合键的最简单形式是具有一个分区键和一个聚类键的键。
以下示例显示了表示表及其复合键的 CQL 语句：
CREATE TABLE login_event(
person_id text,
event_code int,
event_time timestamp,
ip_address text,
PRIMARY KEY (person_id, event_code, event_time))
WITH CLUSTERING ORDER BY (event_time DESC)
;扁平复合主键
平面复合主键作为平面字段嵌入实体内部。主键字段用@PrimaryKeyColumn. 选择需要查询包含各个字段的谓词，或者使用MapId. 以下示例显示了具有平面复合主键的类：
@Table(value = "login_event")
class LoginEvent {
@PrimaryKeyColumn(name = "person_id", ordinal = 0, type = PrimaryKeyType.PARTITIONED)
private String personId;
@PrimaryKeyColumn(name = "event_code", ordinal = 1, type = PrimaryKeyType.PARTITIONED)
private int eventCode;
@PrimaryKeyColumn(name = "event_time", ordinal = 2, type = PrimaryKeyType.CLUSTERED, ordering = Ordering.DESCENDING)
private LocalDateTime eventTime;
@Column("ip_address")
private String ipAddress;
// getters and setters omitted
}主键类
主键类是映射到实体的多个字段或属性的复合主键类。它用@PrimaryKeyClass并且应该定义equals和hashCode方法。 这些方法的值相等语义应与键映射到的数据库类型的数据库相等性一致。主键类可以与存储库一起使用（作为Id类型），并在单个复杂对象中表示实体的身份。以下示例显示了复合主键类：
@PrimaryKeyClass
class LoginEventKey implements Serializable {
@PrimaryKeyColumn(name = "person_id", ordinal = 0, type = PrimaryKeyType.PARTITIONED)
private String personId;
@PrimaryKeyColumn(name = "event_code", ordinal = 1, type = PrimaryKeyType.PARTITIONED)
private int eventCode;
@PrimaryKeyColumn(name = "event_time", ordinal = 2, type = PrimaryKeyType.CLUSTERED, ordering = Ordering.DESCENDING)
private LocalDateTime eventTime;
// other methods omitted
}以下示例演示如何使用复合主键：
@Table(value = "login_event")
public class LoginEvent {
@PrimaryKey
private LoginEventKey key;
@Column("ip_address")
private String ipAddress;
// getters and setters omitted
}嵌入式实体支持
嵌入实体用于在 Java 域模型中设计值对象，其属性被扁平化到表中。
在下面的示例中，您会看到User.name注释为@Embedded. 这样做的结果是UserName折叠成user表，由 3 列 （user_id,firstname,lastname).
|
嵌入实体只能包含简单的属性类型。无法将嵌入实体嵌套到另一个嵌入实体中。 |
但是，如果firstname和lastname列值实际上是null在结果集中，整个属性name将设置为null根据onEmpty之@Embedded哪nulls 对象，当所有嵌套属性都null.
与此行为相反USE_EMPTY尝试使用默认构造函数或接受结果集中可为空参数值的构造函数创建新实例。
public class User {
@PrimaryKey("user_id")
private String userId;
@Embedded(onEmpty = USE_NULL) (1)
UserName name;
}
public class UserName {
private String firstname;
private String lastname;
}| 1 | 属性是null如果firstname和lastname是null. 用onEmpty=USE_EMPTY实例化UserName具有潜力null其属性的价值。 |
您可以使用可选的prefix元素的@Embedded注解。
此元素表示前缀，并附加在嵌入对象中的每个列名称前面。
请注意，如果多个属性呈现到同一列名，则属性将相互覆盖。
|
使用快捷方式
|
映射注释概述
这MappingCassandraConverter可以使用元数据驱动对象映射到 Cassandra 表中的行。
注释概述如下：
-
@Id：在字段或属性级别应用，以标记用于标识目的的属性。 -
@Table：在类级别应用，以指示此类是映射到数据库的候选类。 您可以指定存储对象的表的名称。 指定键空间时，表名将以所有 DML 和 DDL作的键空间为前缀。 -
@PrimaryKey：似@Id但允许您指定列名称。 -
@PrimaryKeyColumn：特定于主键列的 Cassandra 注释，允许您指定主键列属性，例如集群或分区。 可用于单个和多个属性，以指示单个或复合（复合）主键。 如果用于实体内的属性，请确保将@Id注释。 -
@PrimaryKeyClass：在类级别应用，以指示此类是复合主键类。 必须引用@PrimaryKey在实体类中。 -
@Transient：默认情况下，所有专用字段都映射到该行。 此注释将应用它的字段排除在数据库中。 暂时性属性不能在持久性构造函数中使用，因为转换器无法实现构造函数参数的值。 -
@PersistenceConstructor：标记给定的构造函数（甚至是受包保护的构造函数）以在从数据库实例化对象时使用。 构造函数参数按名称映射到检索到行中的键值。 -
@Value：此注释是 Spring Framework 的一部分。在映射框架内，它可以应用于构造函数参数。 这允许您使用 Spring Expression Language 语句在用于构造域对象之前转换在数据库中检索到的键值。 为了引用给定的属性Row/UdtValue/TupleValue必须使用这样的表达式：@Value("#root.getString(0)")哪里root指给定文档的根目录。 -
@ReadOnlyProperty：在字段级别应用以将属性标记为只读。 实体绑定的插入和更新语句不包含此属性。 -
@Column：在字段级别应用。 描述 Cassandra 表中表示的列名，从而使名称与类的字段名称不同。 可用于构造函数参数，以在构造函数创建期间自定义列名。 -
@Embedded：在字段级别应用。 为映射到表或用户定义类型的类型启用嵌入式对象使用。 嵌入对象的属性被展平为其父对象的结构。 -
@Indexed：在字段级别应用。 描述会话初始化时要创建的索引。 -
@SASI：在字段级别应用。 允许在会话初始化期间创建 SASI 索引。 -
@SaiIndexed：在字段级别应用。 允许在会话初始化期间定义 SAI（存储附加索引）索引创建。 -
@CassandraType：在字段级别应用以指定 Cassandra 数据类型。 默认情况下，类型派生自属性声明。 -
@VectorType：在字段级别应用以指定 Cassandra 矢量类型。 使用架构生成时需要此注释。 -
@Frozen：在字段级别应用于类类型和参数化类型。 声明冻结的 UDT 列或冻结的集合，例如List<@Frozen UserDefinedPersonType>. -
@UserDefinedType：在类型级别应用以指定 Cassandra 用户定义的数据类型 （UDT）。指定键空间时，UDT 名称将以所有 DML 和 DDL作的键空间为前缀。默认情况下，类型派生自声明。 -
@Tuple：在类型级别应用以将类型用作映射元组。 -
@Element：在字段级别应用，以指定映射元组中的元素或字段序数。默认情况下，类型派生自属性声明。可用于构造函数参数，以在构造函数创建期间自定义元组元素序数。 -
@Version：在字段级别应用用于乐观锁定，并在保存作时检查修改。初始值为zero每次更新时都会自动增加。
映射元数据基础设施在单独的 spring-data-commons 项目中定义，该项目与技术和数据存储无关。
以下示例显示了更复杂的映射：
Person类@Table("my_person")
public class Person {
@PrimaryKeyClass
public static class Key implements Serializable {
@PrimaryKeyColumn(ordinal = 0, type = PrimaryKeyType.PARTITIONED)
private String type;
@PrimaryKeyColumn(ordinal = 1, type = PrimaryKeyType.PARTITIONED)
private String value;
@PrimaryKeyColumn(name = "correlated_type", ordinal = 2, type = PrimaryKeyType.CLUSTERED)
private String correlatedType;
// other getters/setters omitted
}
@PrimaryKey
private Person.Key key;
@CassandraType(type = CassandraType.Name.VARINT)
private Integer ssn;
@Column("f_name")
private String firstName;
@Column
@Indexed
private String lastName;
private Address address;
@CassandraType(type = CassandraType.Name.UDT, userTypeName = "myusertype")
private UdtValue usertype;
private Coordinates coordinates;
@Transient
private Integer accountTotal;
@CassandraType(type = CassandraType.Name.SET, typeArguments = CassandraType.Name.BIGINT)
private Set<Long> timestamps;
private Map<@Indexed String, InetAddress> sessions;
public Person(Integer ssn) {
this.ssn = ssn;
}
public Person.Key getKey() {
return key;
}
// no setter for Id. (getter is only exposed for some unit testing)
public Integer getSsn() {
return ssn;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
// other getters/setters omitted
}以下示例演示如何映射 UDTAddress:
Address@UserDefinedType("address")
public class Address {
@CassandraType(type = CassandraType.Name.VARCHAR)
private String street;
private String city;
private Set<String> zipcodes;
@CassandraType(type = CassandraType.Name.SET, typeArguments = CassandraType.Name.BIGINT)
private List<Long> timestamps;
// other getters/setters omitted
}使用用户定义类型需要一个UserTypeResolver使用映射上下文配置的。请参阅配置章节，了解如何配置UserTypeResolver. |
以下示例显示了如何映射元组：
@Tuple
class Coordinates {
@Element(0)
@CassandraType(type = CassandraType.Name.VARCHAR)
private String description;
@Element(1)
private long longitude;
@Element(2)
private long latitude;
// other getters/setters omitted
}索引创建
您可以使用@Indexed,@SaiIndexed或@SASI如果希望在应用程序启动时创建二级索引。索引创建为标量类型、用户定义类型和集合类型创建简单的二级索引。
您可以配置 SASI 索引以应用分析器，例如StandardAnalyzer或NonTokenizingAnalyzer（通过使用@StandardAnalyzed和@NonTokenizingAnalyzed，分别）。
地图类型区分ENTRY,KEYS和VALUES指标。
索引创建从带注释的元素派生索引类型。
以下示例显示了创建索引的多种方法：
@Table
class PersonWithIndexes {
@Id
private String key;
@SASI
@StandardAnalyzed
private String names;
@SaiIndexed
@VectorType(dimensions = 1536) // required for table generation
private Vector vector;
@Indexed("indexed_map")
private Map<String, String> entries;
private Map<@Indexed String, String> keys;
private Map<String, @Indexed String> values;
// …
}|
这 |
| 会话初始化时创建索引可能会对应用程序启动产生严重的性能影响。 |