映射

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 对象创建默认使用运行时生成的工厂类，该类将直接调用域类的构造函数。即，对于此示例类型

class Person {
  Person(String firstname, String lastname) { … }
}

我们将在运行时创建一个在语义上等同于此的工厂类

class PersonObjectInstantiator implements ObjectInstantiator {

  Object newInstance(Object... args) {
    return new Person((String) args[0], (String) args[1]);
  }
}

这使我们获得了大约 10% 的反射性能提升。为了使领域类符合此优化条件，它需要遵循一组约束

它不能是私有类
它不能是非静态内部类
它不能是 CGLib 代理类
Spring Data 将使用的构造函数不能是私有的

如果以上任何标准匹配，Spring Data 将回退到通过反射实例化实体。

属性填充

一旦创建了实体实例，Spring Data 会填充该类的所有剩余持久化属性。除非已由实体的构造函数填充（即通过其构造函数参数列表消耗），否则将首先填充标识符属性，以允许解析循环对象引用。之后，所有尚未由构造函数填充的非瞬态属性将在实体实例上设置。为此，我们使用以下算法

如果属性是不可变的但公开了一个 with… 方法（见下文），我们使用 with… 方法创建一个带有新属性值的新实体实例。
如果定义了属性访问（即通过 getter 和 setter 访问），我们将调用 setter 方法。
如果属性是可变的，我们直接设置字段。
如果属性是不可变的，我们使用持久化操作要使用的构造函数（参见对象创建）来创建实例的副本。
默认情况下，我们直接设置字段值。

属性填充内部

与我们的对象构造优化类似，我们也使用 Spring Data 运行时生成的访问器类与实体实例进行交互。

class Person {

  private final Long id;
  private String firstname;
  private @AccessType(Type.PROPERTY) String lastname;

  Person() {
    this.id = null;
  }

  Person(Long id, String firstname, String lastname) {
    // Field assignments
  }

  Person withId(Long id) {
    return new Person(id, this.firstname, this.lastname);
  }

  void setLastname(String lastname) {
    this.lastname = lastname;
  }
}

生成的属性访问器

class PersonPropertyAccessor implements PersistentPropertyAccessor {

  private static final MethodHandle firstname;              (2)

  private Person person;                                    (1)

  public void setProperty(PersistentProperty property, Object value) {

    String name = property.getName();

    if ("firstname".equals(name)) {
      firstname.invoke(person, (String) value);             (2)
    } else if ("id".equals(name)) {
      this.person = person.withId((Long) value);            (3)
    } else if ("lastname".equals(name)) {
      this.person.setLastname((String) value);              (4)
    }
  }
}

1	PropertyAccessor 包含底层对象的可变实例。这是为了允许修改原本不可变的属性。
2	默认情况下，Spring Data 使用字段访问来读取和写入属性值。根据 `private` 字段的可见性规则，使用 `MethodHandles` 与字段交互。
3	该类公开了一个 `withId(…)` 方法，用于设置标识符，例如当一个实例插入到数据存储中并生成了标识符时。调用 `withId(…)` 会创建一个新的 `Person` 对象。所有后续的修改都将在新实例中进行，而不会触及旧实例。
4	使用属性访问允许直接方法调用而无需使用 `MethodHandles`。

这使我们获得了大约 25% 的反射性能提升。为了使领域类符合此优化条件，它需要遵循一组约束

类型不能位于默认包或 java 包下。
类型及其构造函数必须是 public 的
作为内部类的类型必须是 static 的。
所使用的 Java 运行时必须允许在原始 ClassLoader 中声明类。Java 9 及更高版本施加了某些限制。

默认情况下，Spring Data 会尝试使用生成的属性访问器，如果检测到限制，则回退到基于反射的访问器。

让我们看看以下实体

一个示例实体

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 方法。如果您需要这些方法，最好将它们设为包保护，以便只能由有限数量的协同定位类型调用。仅限构造函数的实例化比属性填充快 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 隐藏了 SuperType.field。根据类设计，使用构造函数可能是设置 SuperType.field 的唯一默认方法。或者，在 setter 中调用 super.setField(…) 可以设置 SuperType 中的 field。所有这些机制在某种程度上都会产生冲突，因为属性共享相同的名称，但可能表示两个不同的值。如果类型不可赋值，Spring Data 会跳过超类型属性。也就是说，被覆盖属性的类型必须可赋值给其超类型属性类型才能注册为覆盖，否则超类型属性被视为瞬态。我们通常建议使用不同的属性名称。

Spring Data 模块通常支持包含不同值的被覆盖属性。从编程模型的角度来看，需要考虑以下几点

应该持久化哪个属性（默认为所有声明的属性）？您可以通过使用 @Transient 注解来排除这些属性。
如何在数据存储中表示属性？对不同的值使用相同的字段/列名通常会导致数据损坏，因此您应该使用显式的字段/列名来注解至少一个属性。
不能使用 @AccessType(PROPERTY)，因为在不进一步假设 setter 实现的情况下通常无法设置超属性。

Kotlin 支持

Spring Data 适应 Kotlin 的特性，以允许对象创建和修改。

Kotlin 对象创建

支持实例化 Kotlin 类，所有类默认都是不可变的，并且需要显式属性声明来定义可变属性。

Spring Data 会自动尝试检测持久化实体的构造函数，该构造函数将用于具体化该类型的对象。解析算法的工作方式如下

如果存在一个用 @PersistenceCreator 注解的构造函数，则使用它。
如果类型是 Kotlin data class，则使用主构造函数。
如果存在一个用 @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 Data 类中的委托属性。在所有其他情况下，您可以通过使用 @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 添加一个方法以通过 this.SuperType.field = … 设置 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	一个带有非空值类型的简单值类。
2	使用 `EmailAddress` 值类定义属性的数据类。

使用非原始值类型的非空属性在编译后的类中被展平为值类型。可空原始值类型或可空值中值类型用其包装器类型表示，这会影响值类型在数据库中的表示方式。

数据映射和类型转换

本节解释了类型如何映射到 Apache Cassandra 表示以及如何从中映射。

Spring Data for Apache Cassandra 支持 Apache Cassandra 提供的多种类型。除了这些类型之外，Spring Data for Apache Cassandra 还提供了一组内置转换器来映射其他类型。您可以提供自己的自定义转换器来调整类型转换。有关更多详细信息，请参阅“使用自定义转换器覆盖默认映射”。下表将 Spring Data 类型映射到 Cassandra 类型

表 1. 类型
类型	Cassandra 类型
`字符串`	`text`（默认）、`varchar`、`ascii`
`double`、`Double`	`double`
`float`、`Float`	`float`
`long`、`Long`	`bigint`（默认）、`counter`
`int`、`Integer`	`int`
`short`、`Short`	`smallint`
`byte`、`Byte`	`tinyint`
`boolean`、`Boolean`	`布尔值`
`BigInteger`	`varint`
`BigDecimal`	`decimal`
`java.util.Date`	`timestamp`
`com.datastax.driver.core.LocalDate`	`date`
`InetAddress`	`inet`
`ByteBuffer`	`blob`
`java.util.UUID`	`uuid`
`TupleValue`，映射的元组类型	`tuple<…>`
`UDTValue`，映射的用户定义类型	user type
`Vector`, `CqlVector`	`vector<…>`
`java.util.Map<K, V>`	`map`
`java.util.List<E>`	`list`
`java.util.Set<E>`	`set`
`枚举`	`text`（默认），`bigint`，`varint`，`int`，`smallint`，`tinyint`
`LocalDate` （Joda，Java 8，JSR310-BackPort）	`date`
`LocalTime`+（Joda，Java 8，JSR310-BackPort）	`time`
`LocalDateTime`, `LocalTime`, `Instant` （Joda，Java 8，JSR310-BackPort）	`timestamp`
`ZoneId`（Java 8，JSR310-BackPort）	`text`

每个支持的类型都映射到默认的 Cassandra 数据类型。Java 类型可以通过使用 @CassandraType 映射到其他 Cassandra 类型，如下例所示

示例 1. 枚举映射到数值类型

@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 实例来覆盖对象属性到表列的默认映射。
对象的属性用于在表中进行列的相互转换。

您可以通过在 CassandraMappingContext 上配置 NamingStrategy 来调整约定。命名策略对象通过从实体类和实际属性派生表、列或用户定义类型的约定来实现。

以下示例显示了如何配置 NamingStrategy

示例 2. 在 CassandraMappingContext 上配置 NamingStrategy

		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));

映射配置

除非明确配置，否则在创建 CassandraTemplate 时默认会创建一个 MappingCassandraConverter 实例。您可以创建自己的 MappingCassandraConverter 实例，告诉它在启动时扫描类路径以查找您的领域类，以提取元数据并构建索引。

此外，通过创建自己的实例，您可以注册 Spring Converter 实例，用于将特定类映射到数据库和从数据库映射。以下示例配置类设置了 Cassandra 映射支持

示例 3. 配置 Cassandra 映射支持的 @Configuration 类

@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 注解的类。

您可以通过覆盖 customConversions 方法向 MappingCassandraConverter 添加额外的转换器。

AbstractCassandraConfiguration 创建一个 CassandraTemplate 实例并将其注册到容器中，名称为 cassandraTemplate。

基于元数据的映射

为了充分利用 Spring Data for Apache Cassandra 支持中的对象映射功能，您应该使用 @Table 注解来注解您的映射领域对象。这样做可以让类路径扫描器找到并预处理您的领域对象以提取必要的元数据。只有带注解的实体才用于执行模式操作。在最坏的情况下，SchemaAction.RECREATE_DROP_UNUSED 操作会删除您的表，并且您将丢失数据。请注意，表是从会话键空间访问的。但是，您可以指定一个自定义键空间以使用特定键空间中的表/UDT。

以下示例显示了一个简单的领域对象

示例 4. 示例领域对象

@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

示例 5. 在 Cassandra 中定义的 CQL 表

CREATE TABLE user (
  user_id text,
  firstname text,
  lastname text,
  PRIMARY KEY (user_id))
;

以下示例显示了一个 Java 类，其注解对应于前面列表中定义的 Cassandra

示例 6. 带注解的实体

@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 语句，用于表示表及其复合键

示例 7. 带有复合主键的 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。以下示例显示了一个带有扁平复合主键的类

示例 8. 使用扁平复合主键

@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 类型）一起使用，并以单个复杂对象的形式表示实体的身份。以下示例显示了一个复合主键类

示例 9. 复合主键类

@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
}

以下示例显示了如何使用复合主键

示例 10. 使用复合主键

@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 将根据 @Embedded 的 onEmpty 设置为 null，当所有嵌套属性都为 null 时，它将对象设置为 null。
与此行为相反，USE_EMPTY 尝试使用默认构造函数或接受结果集中可空参数值的构造函数创建新实例。

示例 11. 嵌入对象的示例代码

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	如果 `firstname` 和 `lastname` 为 `null`，则属性为 `null`。使用 `onEmpty=USE_EMPTY` 实例化 `UserName`，其属性可能为 `null` 值。

您可以通过使用 @Embedded 注解的可选 prefix 元素在实体中多次嵌入值对象。此元素表示一个前缀，并添加到嵌入对象中的每个列名之前。请注意，如果多个属性呈现为相同的列名，则属性将相互覆盖。

利用快捷方式 @Embedded.Nullable 和 @Embedded.Empty 分别用于 @Embedded(onEmpty = USE_NULL) 和 @Embedded(onEmpty = USE_EMPTY) 以减少冗长并同时相应地设置 JSR-305 @javax.annotation.Nonnull。

public class MyEntity {

    @Id
    Integer id;

    @Embedded.Nullable (1)
    EmbeddedEntity embeddedEntity;
}

1	`@Embedded(onEmpty = USE_NULL)` 的快捷方式。

映射注解概述

MappingCassandraConverter 可以使用元数据来驱动对象到 Cassandra 表中的行的映射。下面是注解的概述

@Id：应用于字段或属性级别，标记用于标识目的的属性。
@Table：应用于类级别，表示此类是映射到数据库的候选。您可以指定存储对象的表的名称。指定键空间时，表名将在所有 DML 和 DDL 操作中以键空间为前缀。
@PrimaryKey：类似于 @Id，但允许您指定列名。
@PrimaryKeyColumn：Cassandra 特有的主键列注解，允许您指定主键列属性，例如用于集群或分区。可用于单个和多个属性，以指示单个或复合（组合）主键。如果在实体内的属性上使用，请确保同时应用 @Id 注解。
@PrimaryKeyClass：应用于类级别，表示此类是复合主键类。必须在实体类中使用 @PrimaryKey 引用。
@Transient：默认情况下，所有私有字段都映射到行。此注解将应用于其的字段排除在数据库存储之外。瞬态属性不能在持久化构造函数中使用，因为转换器无法为构造函数参数实例化值。
@PersistenceConstructor：标记给定的构造函数（甚至是包保护的构造函数），用于从数据库实例化对象时使用。构造函数参数按名称映射到检索行中的键值。
@Value：此注解是 Spring Framework 的一部分。在映射框架中，它可以应用于构造函数参数。这允许您使用 Spring 表达式语言语句在构建领域对象之前转换数据库中检索到的键值。为了引用给定 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 项目中定义，该项目与技术和数据存储无关。

以下示例显示了一个更复杂的映射

示例 12. 映射的 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

示例 13. 映射的用户定义类型 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 的信息，请参见配置章节。

以下示例显示了如何映射元组

示例 14. 映射的元组

@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 索引。索引创建从带注解的元素派生索引类型。以下示例显示了多种创建索引的方法

示例 15. 映射索引的变体

@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;

  // …
}

@Indexed 注解可以应用于嵌入实体的单个属性，或者与 @Embedded 注解一起使用，在这种情况下，嵌入实体的所有属性都将被索引。

在会话初始化时创建索引可能会对应用程序启动产生严重性能影响。