14.1.3.一般建议

  • 尽量坚持不可变对象 ——不可变对象很容易创建,因为具体化一个对象只是调用它的构造函数的问题。此外,这避免了您的域对象中充斥着允许客户端代码操作对象状态的 setter 方法。如果您需要这些,最好将它们打包保护,以便它们只能由有限数量的并置类型调用。仅构造函数实现比属性填充快 30%。
  • 提供一个全参数构造函数 ——即使你不能或不想将你的实体建模为不可变值,提供一个将实体的所有属性作为参数的构造函数仍然有价值,包括可变的,因为这允许对象映射以跳过属性填充以获得最佳性能。
  • 使用工厂方法而不是重载构造函数来避免@PersistenceConstructor ——为了获得最佳性能需要一个全参数构造函数,我们通常希望公开更多应用程序用例特定的构造函数,这些构造函数省略自动生成的标识符等。这是一种既定的模式,而不是使用静态工厂方法来公开 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);
}
}

Spring中国教育管理中心-Apache Cassandra 的 Spring 数据教程十一_构造函数

这两个类都定义了一个fieldusing 可分配类型。SubType然而阴影SuperType.field。根据类设计,使用构造函数可能是设置 的唯一默认方法SuperType.field。或者,调用super.setField(…)setter 可以设置fieldin SuperType。所有这些机制都会在某种程度上产生冲突,因为属性共享相同的名称,但可能代表两个不同的值。如果类型不可分配,Spring Data 会跳过超类型属性。也就是说,被覆盖属性的类型必须可以分配给它的超类型属性类型才能注册为覆盖,否则超类型属性被认为是瞬态的。我们通常建议使用不同的属性名称。

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

  1. 应该保留哪个属性(默认为所有声明的属性)?您可以通过使用 注释这些属性来排除属性@Transient。
  2. 如何表示数据存储中的属性?对不同的值使用相同的字段/列名称通常会导致数据损坏,因此您应该使用明确的字段/列名称来注释至少一个属性。
  3. Using@AccessType(PROPERTY)不能被使用,因为如果不对 setter 实现做任何进一步的假设,通常不能设置超级属性。

14.1.4.Kotlin 支持

Spring Data 调整了 Kotlin 的细节以允许创建和更改对象。

Kotlin 对象创建

Kotlin 类支持实例化,默认情况下所有类都是不可变的,并且需要显式属性声明来定义可变属性。考虑以下data类Person:

data class Person(val id: String, val name: String)

上面的类编译为具有显式构造函数的典型类。我们可以通过添加另一个构造函数来自定义这个类,并使用注释@PersistenceConstructor来指示构造函数首选项:

data class Person(var id: String, val name: String) {
@PersistenceConstructor
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。

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

Spring中国教育管理中心-Apache Cassandra 的 Spring 数据教程十一_spring_02

getter 和 setterSubType只在set 上,SubType.field而不是SuperType.field. 在这种安排中,使用构造函数是设置的唯一默认方法SuperType.field。添加方法 to SubTypeset
SuperType.fieldviathis.SuperType.field = …是可能的,但不属于支持的约定。属性覆盖在某种程度上会产生冲突,因为属性共享相同的名称但可能代表两个不同的值。我们通常建议使用不同的属性名称。

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

  1. 应该保留哪个属性(默认为所有声明的属性)?您可以通过使用 注释这些属性来排除属性@Transient。
  2. 如何表示数据存储中的属性?对不同的值使用相同的字段/列名称通常会导致数据损坏,因此您应该使用明确的字段/列名称来注释至少一个属性。
  3. using@AccessType(PROPERTY)不能使用,因为不能设置超级属性。

14.2.数据映射和类型转换

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

Spring Data for Apache Cassandra 支持 Apache Cassandra 提供的多种类型。除了这些类型之外,Spring Data for Apache Cassandra 还提供了一组内置转换器来映射其他类型。您可以提供自己的自定义转换器来调整类型转换。有关更多详细信息,请参阅“ [
cassandra.mapping.explicit-converters] ”。下表将 Spring Data 类型映射到 Cassandra 类型:

Spring中国教育管理中心-Apache Cassandra 的 Spring 数据教程十一_字段_03

Spring中国教育管理中心-Apache Cassandra 的 Spring 数据教程十一_spring_04

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

示例 103.枚举到数字类型的映射

@Table
public class EnumToOrdinalMapping {
@PrimaryKey String id;
@CassandraType(type = Name.INT) Condition asOrdinal;
}
public enum Condition {
NEW, USED
}

14.3.基于约定的映射

MappingCassandraConverter当没有提供额外的映射元数据时,使用一些约定将域对象映射到 CQL 表。这些约定是:

  • 简单(短)Java 类名通过更改为小写映射到表名。例如,com.bigbank.SavingsAccount映射到名为 的表savingsaccount。
  • 转换器使用任何已注册的 SpringConverter实例来覆盖对象属性到表字段的默认映射。
  • 对象的属性用于在表中的属性之间进行转换。

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

以下示例显示了如何配置一个NamingStrategy:

例如104配置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));

14.3.1.映射配置

除非明确配置,否则MappingCassandraConverter在创建CassandraTemplate. 您可以创建自己的 实例,MappingCassandraConverter告诉它在启动时扫描域类的类路径以提取元数据和构建索引的位置。

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

Example 105.@Configuration 类来配置 Cassandra 映射支持

@Configuration
public class SchemaConfiguration extends AbstractCassandraConfiguration {
@Override
protected String getKeyspaceName() {
return "bigbank";
}
// the following are optional
@Override
public CassandraCustomConversions customConversions() {
List<Converter<?, ?>> converters = new ArrayList<>();
converters.add(new PersonReadConverter());
converters.add(new PersonWriteConverter());
return new CassandraCustomConversions(converters);
}
@Override
public SchemaAction getSchemaAction() {
return SchemaAction.RECREATE;
}
// other methods omitted...
}

Spring中国教育管理中心-Apache Cassandra 的 Spring 数据教程十一_spring_05

AbstractCassandraConfiguration要求您实现定义键空间的方法。 AbstractCassandraConfiguration还有一个名为getEntityBasePackages(…). 您可以覆盖它以告诉转换器在哪里扫描使用@Table注释注释的类。

您可以MappingCassandraConverter通过覆盖该customConversions方法向 中添加其他转换器。

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