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

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

查看依赖项

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

调整配置

DataStax Java 驱动程序 4 合并Cluster和Session对象合并到单个CqlSessionobject，因此，所有Cluster已删除。 通过删除大多数已移动到DriverConfigLoader这主要是基于文件的。 这意味着SocketOptions,AddressTranslator现在通过其他方式配置了更多选项。spring-doc.cadn.net.cn

如果您使用的是基于 XML 的配置，请确保从cqlnamespace （www.springframework.org/schema/cql www.springframework.org/schema/cql/spring-cql.xsd） 到cassandranamespace （www.springframework.org/schema/data/cassandra www.springframework.org/schema/data/cassandra/spring-cassandra.xsd).spring-doc.cadn.net.cn

为了反映配置生成器中的更改，ClusterBuilderConfigurer已重命名为SessionBuilderConfigurer现在接受CqlSessionBuilder而不是Cluster.Builder. 请确保在配置中还提供本地数据中心，因为这是正确配置负载均衡所必需的。spring-doc.cadn.net.cn

连接

的配置元素Cluster (cassandra:cluster） 和Session (cassandra:session） 合并为一个CqlSession (cassandra:session） 元素，该元素配置 keyspace 和 endpoints。spring-doc.cadn.net.cn

升级后，架构支持已移至新的 namespace 元素：cassandra:session-factory，它提供了一个SessionFactory豆。spring-doc.cadn.net.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.cadn.net.cn

我们通常建议创建CqlTemplate和CassandraTemplate对象SessionFactory因为工厂使用允许同步架构创建，并在使用多个数据库时引入了一定程度的灵活性。spring-doc.cadn.net.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.cadn.net.cn

更改AsyncCqlTemplate

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

结果集提取需要 DataStax 的新接口AsyncResultSet.AsyncCqlTemplate现在使用AsyncResultSetExtractor在它以前使用的地方ResultSetExtractor. 请注意，AsyncResultSetExtractor.extractData(…)返回Future而不是标量对象，因此代码迁移可以在提取器中使用完全非阻塞的代码。spring-doc.cadn.net.cn

数据模型迁移

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

@CassandraType

DataStax 驱动程序 4 不再附带Nameenumeration 来描述 Cassandra 类型。 我们决定重新引入枚举CassandraType.Name. 请确保更新导入以使用新引入的替换类型。spring-doc.cadn.net.cn

原力报价

此标志现已弃用，我们建议不要再使用它。 Spring Data for Apache Cassandra 在内部使用驱动程序的CqlIdentifier这确保了在需要的地方引用。spring-doc.cadn.net.cn

属性类型

DataStax 驱动程序 4 不再使用java.lang.Date. 请升级您的数据模型以使用java.time.LocalDateTime. 请同时将原始 UDT 和元组类型迁移到新的驱动程序类型UdtValue各自TupleValue.spring-doc.cadn.net.cn

其他更改

  • 驾驶员ConsistencyLevel常量类被删除并重新引入为DefaultConsistencyLevel.@Consistency被改编成DefaultConsistencyLevel.spring-doc.cadn.net.cn

  • RetryPolicy上QueryOptions和…CqlTemplatetypes 被删除而没有替换。spring-doc.cadn.net.cn

  • DriversPagingStatetype 已删除。 Paging 状态现在使用ByteBuffer.spring-doc.cadn.net.cn

  • SimpleUserTypeResolver接受CqlSession而不是Cluster.spring-doc.cadn.net.cn

  • SimpleTupleTypeFactory已迁移到enum.SimpleTupleTypeFactory.INSTANCE不再需要Cluster/CqlSession上下文。spring-doc.cadn.net.cn

  • 简介StatementBuilder在功能上构建语句，因为 QueryBuilder API 使用不可变的语句类型。spring-doc.cadn.net.cn

  • SessionBean 已从session自cassandraSession和SessionFactoryBean 已从sessionFactory自cassandraSessionFactory.spring-doc.cadn.net.cn

  • ReactiveSessionBean 已从reactiveSession自reactiveCassandraSession和ReactiveSessionFactoryBean 已从reactiveSessionFactory自reactiveCassandraSessionFactory.spring-doc.cadn.net.cn

  • ReactiveSessionFactory.getSession()现在返回一个Mono<ReactiveSession>. 以前，它只返回ReactiveSession.spring-doc.cadn.net.cn

  • 数据类型解析已移至ColumnTypeResolver所以所有人DataType-相关方法已从CassandraPersistentEntity/CassandraPersistentProperty到ColumnTypeResolver（受影响的方法是MappingContext.getDataType(…),CassandraPersistentProperty.getDataType(),CassandraPersistentEntity.getUserType()和CassandraPersistentEntity.getTupleType()).spring-doc.cadn.net.cn

  • 架构创建已从MappingContext自SchemaFactory（受影响的方法是CassandraMappingContext.getCreateTableSpecificationFor(…),CassandraMappingContext.getCreateIndexSpecificationsFor(…)和CassandraMappingContext.getCreateUserTypeSpecificationFor(…)).spring-doc.cadn.net.cn

弃用

  • CassandraCqlSessionFactoryBean用CqlSessionFactoryBean相反。spring-doc.cadn.net.cn

  • KeyspaceIdentifier和CqlIdentifier用com.datastax.oss.driver.api.core.CqlIdentifier相反。spring-doc.cadn.net.cn

  • CassandraSessionFactoryBean用CqlSessionFactoryBean相反。spring-doc.cadn.net.cn

  • AbstractCqlTemplateConfiguration用AbstractSessionConfiguration相反。spring-doc.cadn.net.cn

  • AbstractSessionConfiguration.getClusterName()用AbstractSessionConfiguration.getSessionName()相反。spring-doc.cadn.net.cn

  • CodecRegistryTupleTypeFactory用SimpleTupleTypeFactory相反。spring-doc.cadn.net.cn

  • Spring Data 的CqlIdentifier，使用驱动程序CqlIdentifier相反。spring-doc.cadn.net.cn

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

  • fetchSize上QueryOptions和…CqlTemplatetypes 已弃用，请使用pageSize相反spring-doc.cadn.net.cn

  • CassandraMappingContext.setUserTypeResolver(…),CassandraMappingContext.setCodecRegistry(…)和CassandraMappingContext.setCustomConversions(…)：配置这些属性CassandraConverter.spring-doc.cadn.net.cn

  • TupleTypeFactory和CassandraMappingContext.setTupleTypeFactory(…):TupleTypeFactory不再使用，因为 Cassandra 驱动程序附带了DataTypes.tupleOf(…)Factory 方法。spring-doc.cadn.net.cn

  • 通过 Schema 创建CqlSessionFactoryBean (cassandra:session） 已弃用。 Keyspace 创建 方式CqlSessionFactoryBean (cassandra:session） 不受影响。spring-doc.cadn.net.cn

清除

配置 API

Utilities

  • GuavaListenableFutureAdapterspring-doc.cadn.net.cn

  • QueryOptions和WriteOptions构造函数采用ConsistencyLevel和RetryPolicy参数。 将生成器与执行配置文件结合使用作为替换。spring-doc.cadn.net.cn

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

命名空间支持

增加

配置 API

命名空间支持