|
此版本仍在开发中，尚未被视为稳定版本。如需最新稳定版本，请使用 Spring Data Cassandra 5.0.4！ |
映射
丰富的对象映射支持由 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 就会填充该类中所有其余的持久化属性。 除非标识符属性已经由实体的构造函数填充（即通过其构造函数参数列表传入），否则将首先填充标识符属性，以便解析循环对象引用。 之后，所有尚未通过构造函数填充的非瞬态（non-transient）属性都会被设置到实体实例上。 为此，我们使用以下算法：
-
如果该属性是不可变的，但提供了一个
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 | 标识符属性是 final 的，但在构造函数中被设为 null。
该类提供了一个 withId(…) 方法，用于设置标识符，例如当实例被插入到数据存储中并生成了标识符时。
原始的 Person 实例保持不变，因为会创建一个新的实例。
对于其他由存储管理、但在持久化操作中可能需要更改的属性，通常也采用相同的模式。
Wither 方法是可选的，因为持久化构造函数（参见第6节）实际上是一个拷贝构造函数，设置该属性会被转换为创建一个应用了新标识符值的新实例。 |
| 2 | firstname 和 lastname 属性是普通的不可变属性，可能通过 getter 方法对外暴露。 |
| 3 | age 属性是一个不可变的派生属性，它源自 birthday 属性。
按照所示的设计，数据库中的值将优先于默认值，因为 Spring Data 会使用唯一声明的构造函数。
即使本意是优先采用计算得出的值，该构造函数也必须将 age 作为参数（即使可能忽略它），否则属性填充步骤会尝试设置 age 字段，但由于该字段不可变且不存在 with… 方法，从而导致失败。 |
| 4 | comment 属性是可变的，通过直接设置其字段进行赋值。 |
| 5 | remarks 属性是可变的，通过调用其 setter 方法进行赋值。 |
| 6 | 该类提供了一个工厂方法和一个构造函数用于对象创建。
这里的核心思想是使用工厂方法而非额外的构造函数，以避免通过 @PersistenceCreator 进行构造函数消歧。
相反，属性的默认值处理在工厂方法内部完成。
如果你想让 Spring Data 使用该工厂方法进行对象实例化，请使用 @PersistenceCreator 注解该方法。 |
通用建议
-
尽量使用不可变对象 — 不可变对象的创建非常直接，因为实例化对象只需调用其构造函数即可。 此外，这样做可以避免在你的领域对象中充斥着大量 setter 方法，从而防止客户端代码随意修改对象的状态。 如果你确实需要这些 setter 方法，建议将其设为包级私有（package protected），以便只有有限数量的同包类才能调用它们。 仅通过构造函数进行对象实例化，比通过属性赋值的方式快多达 30%。
-
提供一个包含所有参数的构造函数 — 即使你无法或不希望将实体建模为不可变值，仍然建议提供一个接收实体所有属性（包括可变属性）作为参数的构造函数，因为这样可以让对象映射跳过属性填充步骤，从而实现最佳性能。
-
使用工厂方法替代重载构造函数，以避免
@PersistenceCreator— 由于需要全参数构造函数以实现最佳性能，我们通常希望暴露更多针对特定应用场景的构造函数，这些构造函数会省略自动生成的标识符等内容。 采用静态工厂方法来暴露这些全参数构造函数的变体，是一种既定的设计模式。 -
请确保遵守相关约束条件，以允许使用所生成的实例化器和属性访问器类 —
-
若要生成标识符，仍应使用 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);
}
}两个类都使用可赋值类型定义了一个 field。然而，SubType 会遮蔽（shadow）SuperType.field。
根据类的设计，使用构造函数可能是设置 SuperType.field 的唯一默认方法。
或者，也可以在 setter 方法中调用 super.setField(…) 来设置 field 中的 SuperType。
所有这些机制在某种程度上都会产生冲突，因为这些属性具有相同的名称，却可能代表两个不同的值。
如果类型不可赋值，Spring Data 会跳过父类的属性。
也就是说，只有当被重写的属性类型可赋值给其父类属性类型时，才会被注册为重写；否则，父类属性将被视为瞬态（transient）。
我们通常建议使用不同的属性名称。
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;
}
}SubType 上的 getter 和 setter 方法仅设置 SubType.field，而不会设置 SuperType.field。
在这种情况下，使用构造函数是设置 SuperType.field 的唯一默认方法。
虽然可以向 SubType 添加一个方法，通过 SuperType.field 来设置 this.SuperType.field = …，但这超出了所支持的约定范围。
属性重写在一定程度上会造成冲突，因为这些属性名称相同，却可能代表两个不同的值。
我们通常建议使用不同的属性名称。
Spring Data 模块通常支持被重写的属性持有不同的值。 从编程模型的角度来看，有几点需要注意：
-
应持久化哪些属性（默认为所有已声明的属性）？ 您可以通过使用
@Transient注解来排除某些属性。 -
如何在您的数据存储中表示属性？ 对不同的值使用相同的字段/列名通常会导致数据损坏，因此您应使用显式的字段/列名对至少其中一个属性进行注解。
-
使用
@AccessType(PROPERTY)是不可行的，因为无法设置超类属性。
Kotlin 值类
Kotlin 值类（Value Classes）旨在构建更具表达力的领域模型，以显式地体现底层概念。 Spring Data 能够读取和写入使用值类定义属性的类型。
考虑以下领域模型：
@JvmInline
value class EmailAddress(val theAddress: String) (1)
data class Contact(val id: String, val name:String, val emailAddress: EmailAddress) (2)| 1 | 一个具有不可为空值类型的简单值类。 |
| 2 | 使用 EmailAddress 值类定义属性的数据类。 |
| 使用非基本值类型的不可为空属性在编译后的类中会被展平为该值类型。 可为空的基本值类型或值类型中的可为空值类型则以其包装类型表示，这会影响值类型在数据库中的表示方式。 |
数据映射与类型转换
本节说明了类型如何与 Apache Cassandra 的表示形式进行相互映射。
Spring Data for Apache Cassandra 支持 Apache Cassandra 提供的多种类型。 除了这些类型之外，Spring Data for Apache Cassandra 还提供了一组内置转换器，用于映射额外的类型。 您可以提供自己的自定义转换器来调整类型转换。 有关更多详细信息，请参阅“使用自定义转换器覆盖默认映射”。 下表列出了 Spring Data 类型与 Cassandra 类型的对应关系：
| 类型 | Cassandra 类型 |
|---|---|
|
文本（默认）、varchar、ascii |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
用户类型 |
|
|
|
|
|
|
|
|
|
文本（默认）, bigint, varint, int, smallint, tinyint |
|
|
|
|
|
|
|
|
每种受支持的类型都会映射到一个默认的
Cassandra 数据类型。
Java 类型可以通过使用 @CassandraType 映射到其他 Cassandra 类型，如下例所示：
@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 实例，以指定在启动时扫描类路径的位置，从而查找您的领域类、提取元数据并构建索引。
此外，通过创建您自己的实例，您可以注册 Spring 的 Converter 实例，用于将特定类与数据库之间进行映射。
以下示例配置类设置了 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 要求您实现用于定义 keyspace 的方法。
AbstractCassandraConfiguration 还包含一个名为 getEntityBasePackages(…) 的方法。
您可以重写该方法，以告知转换器在何处扫描带有 @Table 注解的类。
你可以通过重写 MappingCassandraConverter 方法，向 customConversions 添加额外的转换器。
AbstractCassandraConfiguration 创建一个 CassandraTemplate 实例，并将其以 cassandraTemplate 的名称注册到容器中。 |
基于元数据的映射
为了充分利用 Spring Data for Apache Cassandra 支持中的对象映射功能，您应当使用 @Table 注解来标注您的映射领域对象。
这样做可以让类路径扫描器找到并预处理您的领域对象，以提取必要的元数据。
只有带注解的实体才会用于执行模式（schema）操作。
在最坏的情况下，SchemaAction.RECREATE_DROP_UNUSED 操作会删除您的表，导致数据丢失。
请注意，表是从会话的 keyspace 中访问的。
不过，您也可以指定一个自定义 keyspace，以使用来自特定 keyspace 的表或用户定义类型（UDT）。
以下示例展示了一个简单的领域对象：
@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
}主键类
主键类（Primary key class）是一种复合主键类，它映射到实体的多个字段或属性。
该类使用 @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 of @Embedded，即null当所有嵌套属性都是 s 对象时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：在类级别上使用，表示该类是映射到数据库的候选对象。 您可以指定存储该对象的表名。 当指定了 keyspace 时，所有 DML 和 DDL 操作中的表名都会加上 keyspace 作为前缀。 -
@PrimaryKey：类似于@Id，但允许你指定列名。 -
@PrimaryKeyColumn：Cassandra 特有的用于主键列的注解，允许你指定主键列的属性，例如用于聚簇（clustered）或分区（partitioned）。 可用于单个或多个属性上，以表示单一主键或复合（组合）主键。 如果在实体内的某个属性上使用此注解，请确保同时加上@Id注解。 -
@PrimaryKeyClass：应用于类级别，用于表明该类是一个复合主键类。 必须在实体类中通过@PrimaryKey进行引用。 -
@Transient：默认情况下，所有私有字段都会映射到数据行。 此注解用于将其所标注的字段排除在数据库存储之外。 瞬态（Transient）属性不能在持久化构造函数中使用，因为转换器无法为构造函数参数生成具体值。 -
@PersistenceConstructor：标记一个给定的构造函数——即使是包级私有的构造函数——在从数据库实例化对象时使用。 构造函数的参数将根据名称映射到所检索行中的键值。 -
@Value：此注解是 Spring Framework 的一部分。在映射框架中，它可以应用于构造函数参数。 这允许你使用 Spring 表达式语言（SpEL）语句，在从数据库检索到某个键的值之后、用于构造领域对象之前，对该值进行转换。 为了引用给定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）。 在指定 keyspace 时，该 UDT 名称将在所有 DML 和 DDL 操作中自动加上 keyspace 前缀。 默认情况下，类型会从声明中推导得出。 -
@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
}以下示例展示了如何映射一个 UDT Address：
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。
有关如何配置xref page的信息，请参阅配置章节。 |
以下示例展示了如何映射一个元组：
@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）。
Map 类型区分 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;
// …
}|
|
| 在会话初始化时创建索引可能会对应用程序启动造成严重的性能影响。 |