从 1.x 到 2.x 的迁移指南

升级到早期版本时,Spring Data for Apache Cassandra 2.0 引入了一系列重大更改

  • spring-cqlspring-data-cassandra 模块合并到一个模块中。

  • CqlOperationsCassandraOperations 中的异步和同步操作分离到专用的接口和模板中。

  • 修改 CqlTemplate API 以与 JdbcTemplate 保持一致。

  • 删除 CassandraOperations.selectBySimpleIds 方法。

  • CassandraRepository 使用更好的名称。

  • 删除 SD Cassandra ConsistencyLevelRetryPolicy 类型,转而使用 DataStax ConsistencyLevelRetryPolicy 类型。

  • 将 CQL 规范重构为值对象和配置器。

  • QueryOptions 重构为不可变对象。

  • CassandraPersistentProperty 重构为单列。

弃用

  • 弃用 QueryOptionsBuilder.readTimeout(long, TimeUnit),转而使用 QueryOptionsBuilder.readTimeout(Duration)

  • 弃用 CustomConversions,转而使用 CassandraCustomConversions

  • 弃用 BasicCassandraMappingContext,转而使用 CassandraMappingContext

  • 弃用 o.s.d.c.core.cql.CachedPreparedStatementCreator,转而使用 o.s.d.c.core.cql.support.CachedPreparedStatementCreator

  • 弃用 CqlTemplate.getSession(),转而使用 getSessionFactory()

  • 弃用 CqlIdentifier.cqlId(…)KeyspaceIdentifier.ksId(…),转而使用 .of(…) 方法。

  • 弃用 QueryOptions 的构造函数,转而使用其生成器。

  • 弃用 TypedIdCassandraRepository,转而使用 CassandraRepository

合并 Spring CQL 和 Spring Data Cassandra 模块

Spring CQL 和 Spring Data Cassandra 现已合并到一个模块中。独立的 spring-cql 模块不再可用。你可以在 spring-data-cassandra 中找到所有已合并的类型。以下清单显示了如何在 maven 依赖项中包含 spring-data-cassandra

<dependencies>

  <dependency>
    <groupId>org.springframework.data</groupId>
    <artifactId>spring-data-cassandra</artifactId>
    <version>4.3.0</version>
  </dependency>

</dependencies>

通过合并,我们将所有 CQL 包合并到 Spring Data Cassandra 中

  • o.s.d.cql 移至 o.s.d.cassandra.core.cql

  • o.s.d.cqlo.s.d.cassandra.config 合并,并展平 XML 和 Java 子包。

  • CassandraExceptionTranslatorCqlExceptionTranslator 移至 o.s.d.c.core.cql

  • 将 Cassandra 异常 o.s.d.c.support.exception 移至 o.s.d.cassandra

  • o.s.d.c.convert 移至 o.s.d.c.core.convert(影响转换器)。

  • o.s.d.c.mapping 移至 o.s.d.c.core.mapping(影响映射注释)。

  • MapIdo.s.d.c.repository 移至 o.s.d.c.core.mapping

[[revised-cqltemplate/cassandratemplate]] == 修订后的 CqlTemplate/CassandraTemplate

我们将 CqlTemplateCassandraTemplate 分为三种方式

  • CassandraTemplate 不再是 CqlTemplate,而是使用允许重用和精细控制获取大小、一致性级别和重试策略的实例。你可以通过 CassandraTemplate.getCqlOperations() 获取 CqlOperations。由于更改,CqlTemplate 的依赖项注入需要额外的 bean 设置。

  • CqlTemplate 现在反映基本 CQL 操作,而不是混合高级和低级 API 调用(例如 count(…)execute(…)),并且减少的方法集与 Spring Frameworks 的 JdbcTemplate 及其便捷的回调接口保持一致。

  • 异步方法在 AsyncCqlTemplateAsyncCassandraTemplate 上使用 ListenableFuture 重新实现。我们删除了 Cancellable 和各种异步回调侦听器。ListenableFuture 是一种灵活的方法,允许转换为 CompletableFuture

删除 CassandraOperations.selectBySimpleIds()

该方法已删除,因为它不支持复杂 ID。新引入的查询 DSL 允许映射和复杂 ID 用于单列 ID,如下例所示

cassandraTemplate.select(Query.query(Criteria.where("id").in(…)), Person.class)

CassandraRepository 的更佳名称

我们重命名了 CassandraRepositoryTypedIdCassandraRepository,以使 Spring Data Cassandra 命名与其他 Spring Data 模块保持一致

  • CassandraRepository 重命名为 MapIdCassandraRepository

  • TypedIdCassandraRepository 重命名为 CassandraRepository

  • 引入了 TypedIdCassandraRepository,扩展了 CassandraRepository 作为弃用类型,以简化迁移

删除了 SD Cassandra ConsistencyLevelRetryPolicy 类型,转而使用 DataStax ConsistencyLevelRetryPolicy 类型

已删除 Spring Data Cassandra ConsistencyLevelRetryPolicy。请使用 DataStax 驱动程序提供的类型。

Spring Data Cassandra 类型限制了 Cassandra 本机驱动程序中提供的可用功能的使用。因此,每次驱动程序引入较新的功能时,Spring Data Cassandra 的类型都需要更新。

将 CQL 规范重构为值对象和配置器

尽可能地,CQL 规范类型现在是值类型(例如 FieldSpecificationAlterColumnSpecification),并且对象由静态工厂方法构建。这允许简单值对象的不可变性。对强制属性(例如表名或键空间名)进行操作的配置器对象(例如 AlterTableSpecification)最初通过静态工厂方法构建,并允许进一步配置,直到创建所需状态。

QueryOptions 重构为不可变对象

QueryOptionsWriteOptions 现在是不可变的,并且可以通过构建器创建。接受 QueryOptions 的方法强制使用非空对象,这些对象可从静态 empty() 工厂方法获得。以下示例显示了如何使用 QueryOptions.builder()

QueryOptions queryOptions = QueryOptions.builder()
		.consistencyLevel(ConsistencyLevel.ANY)
		.retryPolicy(FallthroughRetryPolicy.INSTANCE)
		.readTimeout(Duration.ofSeconds(10))
		.fetchSize(10)
		.tracing(true)
		.build();

CassandraPersistentProperty 重构为单列

仅当您直接在映射模型上操作时,此更改才会影响您。

CassandraPersistentProperty 以前允许绑定多个列名以用于复合主键。CassandraPersistentProperty 的列现在减少为单列。已解析的复合主键通过 MappingContext.getRequiredPersistentEntity(…) 映射到一个类。