此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Data Cassandra 4.4.0spring-doc.cn

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

Spring Data for Apache Cassandra 3.0 在从早期版本升级时引入了一组重大更改。spring-doc.cn

查看依赖项

升级到 Spring Data Cassandra 需要升级到 DataStax 驱动程序版本 4。升级到新驱动程序会带来传递依赖项更改,最值得注意的是,Google Guava 由驱动程序捆绑和着色。 有关驱动程序相关更改的详细信息,请参阅《DataStax Java Driver for Apache Cassandra 4 升级指南》。spring-doc.cn

调整配置

DataStax Java Driver 4 将对象合并为一个对象,因此,所有相关的 API 都已删除。 通过删除大多数主要基于文件的配置项,对配置进行了大部分修改。 这意味着 和更多选项现在通过其他方式进行配置。ClusterSessionCqlSessionClusterDriverConfigLoaderSocketOptionsAddressTranslatorspring-doc.cn

如果你使用的是基于 XML 的配置,请确保将所有配置文件从命名空间 () 迁移到命名空间 () 。cqlwww.springframework.org/schema/cql www.springframework.org/schema/cql/spring-cql.xsdcassandrawww.springframework.org/schema/data/cassandra www.springframework.org/schema/data/cassandra/spring-cassandra.xsdspring-doc.cn

为了反映配置生成器中的更改,已重命名为 accept now,而不是 . 请确保在配置中还提供本地数据中心,因为这是正确配置负载均衡所必需的。ClusterBuilderConfigurerSessionBuilderConfigurerCqlSessionBuilderCluster.Builderspring-doc.cn

连接

() 和 () 的配置元素合并为一个 () 元素,该元素配置键空间和端点。Clustercassandra:clusterSessioncassandra:sessionCqlSessioncassandra:sessionspring-doc.cn

通过升级,架构支持被移动到一个新的命名空间元素:它提供了一个 bean。cassandra:session-factorySessionFactoryspring-doc.cn

示例 1.版本 2 中的 Cluster、Session 和 Schema 配置:
<cassandra:cluster contact-points="localhost" port="9042">
  <cassandra:keyspace action="CREATE_DROP" name="mykeyspace" />
</cassandra:cluster>

<cassandra:session keyspace-name="mykeyspace" schema-action="CREATE">
  <cassandra:startup-cql>CREATE TABLE …</cassandra:startup-cql>
</cassandra:session>
示例 2.版本 3 中的 Session 和 Schema 配置:
<cassandra:session contact-points="localhost" port="9042" keyspace="mykeyspace" local-datacenter="datacenter1">
  <cassandra:keyspace action="CREATE_DROP" name="mykeyspace" />
</cassandra:session>

<cassandra:session-factory schema-action="CREATE">
  <cassandra:script location="classpath:/schema.cql"/>
</cassandra:session-factory>
Spring Data Cassandra 3.0 在使用 XML 名称空间配置时,不再注册默认的 Mapping Context、Context 和 Template API bean。 默认值应应用于应用程序或 Spring Boot 级别。

模板 API

如果您的应用程序主要与映射的实体或原始 Java 类型交互,Spring Data for Apache Cassandra 会将驱动程序升级带来的大部分更改封装为模板 API 和存储库支持。spring-doc.cn

我们通常建议使用 create 和 objects ,因为工厂用法允许同步架构创建,并在使用多个数据库时引入了一定程度的灵活性。CqlTemplateCassandraTemplateSessionFactoryspring-doc.cn

例 3.版本 2 中的模板 API 配置:
<cql:template session-ref="…" />

<cassandra:template session-ref="…" cassandra-converter-ref="…"/>
示例 4.版本 3 中的模板 API 配置:
<cassandra:session-factory />

<cassandra:cql-template session-factory-ref="…" />

<cassandra:template session-factory-ref="…" cassandra-converter-ref="…"/>

您必须在直接使用 DataStax 驱动程序 API 的所有地方调整您的代码。 典型案例包括:spring-doc.cn

更改AsyncCqlTemplate

DataStax 驱动程序 4 更改了异步运行的查询的结果类型。 为了反映这些更改,您需要调整提供以下内容的代码:spring-doc.cn

结果集提取需要 DataStax 的新接口。 现在用于以前使用 . 请注意,返回 a 而不是标量对象,因此代码迁移可以在提取器中使用完全非阻塞的代码。AsyncResultSetAsyncCqlTemplateAsyncResultSetExtractorResultSetExtractorAsyncResultSetExtractor.extractData(…)Futurespring-doc.cn

数据模型迁移

如果您使用以下功能,您的数据模型可能需要更新:spring-doc.cn

@CassandraType

DataStax 驱动程序 4 不再附带用于描述 Cassandra 类型的枚举。 我们决定使用 . 请确保更新导入以使用新引入的替换类型。NameCassandraType.Namespring-doc.cn

原力报价

此标志现已弃用,我们建议不要再使用它。 Spring Data for Apache Cassandra 在内部使用驱动程序,以确保在需要时引用。CqlIdentifierspring-doc.cn

属性类型

DataStax 驱动程序 4 不再使用 . 请升级您的数据模型以使用 . 另请将原始 UDT 和元组类型分别迁移到新的驱动程序类型。java.lang.Datejava.time.LocalDateTimeUdtValueTupleValuespring-doc.cn

其他更改

  • Driver 的常量类已删除,并作为 . 被改编成 。ConsistencyLevelDefaultConsistencyLevel@ConsistencyDefaultConsistencyLevelspring-doc.cn

  • RetryPolicyon 和 types 被删除而不进行替换。QueryOptions…CqlTemplatespring-doc.cn

  • 已删除驱动程序的类型。 分页状态现在使用 .PagingStateByteBufferspring-doc.cn

  • SimpleUserTypeResolver接受而不是 .CqlSessionClusterspring-doc.cn

  • SimpleTupleTypeFactory已迁移到 。 不再需要 / 上下文。enumSimpleTupleTypeFactory.INSTANCEClusterCqlSessionspring-doc.cn

  • 引入了功能构建语句,因为 QueryBuilder API 使用不可变的语句类型。StatementBuilderspring-doc.cn

  • SessionBean 已从 to 重命名,Bean 已从 to 重命名为 。sessioncassandraSessionSessionFactorysessionFactorycassandraSessionFactoryspring-doc.cn

  • ReactiveSessionBean 已从 to 重命名,Bean 已从 to 重命名为 。reactiveSessionreactiveCassandraSessionReactiveSessionFactoryreactiveSessionFactoryreactiveCassandraSessionFactoryspring-doc.cn

  • ReactiveSessionFactory.getSession()现在返回一个 . 以前,它只返回 。Mono<ReactiveSession>ReactiveSessionspring-doc.cn

  • 数据类型解析已移入,因此所有相关方法都从 / 移入(受影响的方法是 、 、 和 )。ColumnTypeResolverDataTypeCassandraPersistentEntityCassandraPersistentPropertyColumnTypeResolverMappingContext.getDataType(…)CassandraPersistentProperty.getDataType()CassandraPersistentEntity.getUserType()CassandraPersistentEntity.getTupleType()spring-doc.cn

  • 架构创建已从 移动到 (受影响的方法是 、 和 )。MappingContextSchemaFactoryCassandraMappingContext.getCreateTableSpecificationFor(…)CassandraMappingContext.getCreateIndexSpecificationsFor(…)CassandraMappingContext.getCreateUserTypeSpecificationFor(…)spring-doc.cn

弃用

  • CassandraCqlSessionFactoryBean,请改用 USE。CqlSessionFactoryBeanspring-doc.cn

  • KeyspaceIdentifier和 ,请改用。CqlIdentifiercom.datastax.oss.driver.api.core.CqlIdentifierspring-doc.cn

  • CassandraSessionFactoryBean,请改用 USE。CqlSessionFactoryBeanspring-doc.cn

  • AbstractCqlTemplateConfiguration,请改用 USE。AbstractSessionConfigurationspring-doc.cn

  • AbstractSessionConfiguration.getClusterName(),请改用 USE。AbstractSessionConfiguration.getSessionName()spring-doc.cn

  • CodecRegistryTupleTypeFactory,请改用 USE。SimpleTupleTypeFactoryspring-doc.cn

  • Spring Data 的 ,请改用驱动程序。CqlIdentifierCqlIdentifierspring-doc.cn

  • forceQuoteattributes 作为引号。 正确转义保留关键字并注意区分大小写。CqlIdentifierspring-doc.cn

  • fetchSizeon 和 types 已弃用,请改用QueryOptions…CqlTemplatepageSizespring-doc.cn

  • CassandraMappingContext.setUserTypeResolver(…)、 和 :在 上配置这些属性。CassandraMappingContext.setCodecRegistry(…)CassandraMappingContext.setCustomConversions(…)CassandraConverterspring-doc.cn

  • TupleTypeFactory和 : 不再使用,因为 Cassandra 驱动程序附带了工厂方法。CassandraMappingContext.setTupleTypeFactory(…)TupleTypeFactoryDataTypes.tupleOf(…)spring-doc.cn

  • 通过 () 创建架构已弃用。 通过 () 创建的密钥空间不受影响。CqlSessionFactoryBeancassandra:sessionCqlSessionFactoryBeancassandra:sessionspring-doc.cn

清除

配置 API

Utilities

  • GuavaListenableFutureAdapterspring-doc.cn

  • QueryOptions以及构造函数采用和参数。 将生成器与执行配置文件结合使用作为替换。WriteOptionsConsistencyLevelRetryPolicyspring-doc.cn

  • CassandraAccessor.setRetryPolicy(…)和方法。 使用执行配置文件作为替换。ReactiveCqlTemplate.setRetryPolicy(…)spring-doc.cn

命名空间支持

增加

配置 API

命名空间支持

  • cassandra:cluster(终端节点属性已合并到cassandra:session)spring-doc.cn

  • cassandra:initialize-keyspace命名空间支持spring-doc.cn

  • cassandra:session-factory有支持cassandra:scriptspring-doc.cn