使用 Spring 连接 Cassandra
使用基于 Java 的元数据注册 Session 实例
以下示例展示了如何使用基于 Java 的 bean 元数据来注册一个 com.datastax.oss.driver.api.core.CqlSession
实例
com.datastax.oss.driver.api.core.CqlSession
对象@Configuration
public class AppConfig {
/*
* Use the standard Cassandra driver API to create a com.datastax.oss.driver.api.core.CqlSession instance.
*/
public @Bean CqlSession session() {
return CqlSession.builder().withKeyspace("mykeyspace").build();
}
}
这种方法允许您使用您可能已经熟悉的标准 com.datastax.oss.driver.api.core.CqlSession
API。
另一种方法是使用 Spring 的 CqlSessionFactoryBean
向容器注册一个 com.datastax.oss.driver.api.core.CqlSession
实例。与直接实例化 com.datastax.oss.driver.api.core.CqlSession
实例相比,FactoryBean
方法的额外优势在于它还为容器提供了一个 ExceptionTranslator
实现,该实现将 Cassandra 异常转换为 Spring 可移植 DataAccessException
层次结构中的异常。该层次结构和 @Repository
的使用在Spring 的 DAO 支持特性中进行了描述。
以下示例展示了基于 Java 的工厂类用法
CqlSessionFactoryBean
注册 com.datastax.oss.driver.api.core.CqlSession 对象@Configuration
public class FactoryBeanAppConfig {
/*
* Factory bean that creates the com.datastax.oss.driver.api.core.CqlSession instance
*/
@Bean
public CqlSessionFactoryBean session() {
CqlSessionFactoryBean session = new CqlSessionFactoryBean();
session.setContactPoints("localhost");
session.setKeyspaceName("mykeyspace");
return session;
}
}
结合对象映射和 Repository 支持使用 CassandraTemplate
需要 CassandraTemplate
、CassandraMappingContext
、CassandraConverter
并启用 Repository 支持。
以下示例展示了如何注册组件以配置对象映射和 Repository 支持
@Configuration
@EnableCassandraRepositories(basePackages = { "org.springframework.data.cassandra.example" })
public class CassandraConfig {
@Bean
public CqlSessionFactoryBean session() {
CqlSessionFactoryBean session = new CqlSessionFactoryBean();
session.setContactPoints("localhost");
session.setKeyspaceName("mykeyspace");
return session;
}
@Bean
public SessionFactoryFactoryBean sessionFactory(CqlSession session, CassandraConverter converter) {
SessionFactoryFactoryBean sessionFactory = new SessionFactoryFactoryBean();
sessionFactory.setSession(session);
sessionFactory.setConverter(converter);
sessionFactory.setSchemaAction(SchemaAction.NONE);
return sessionFactory;
}
@Bean
public CassandraMappingContext mappingContext() {
return new CassandraMappingContext();
}
@Bean
public CassandraConverter converter(CqlSession cqlSession, CassandraMappingContext mappingContext) {
MappingCassandraConverter cassandraConverter = new MappingCassandraConverter(mappingContext);
cassandraConverter.setUserTypeResolver(new SimpleUserTypeResolver(cqlSession));
return cassandraConverter;
}
@Bean
public CassandraOperations cassandraTemplate(SessionFactory sessionFactory, CassandraConverter converter) {
return new CassandraTemplate(sessionFactory, converter);
}
}
创建注册 Spring Data for Apache Cassandra 组件的配置类可能是一项令人筋疲力尽的挑战,因此 Spring Data for Apache Cassandra 提供了一个预构建的配置支持类。继承自 AbstractCassandraConfiguration
的类会注册供 Spring Data for Apache Cassandra 使用的 bean。AbstractCassandraConfiguration
允许您提供各种配置选项,例如初始实体、默认查询选项、连接池选项、套接字选项等等。AbstractCassandraConfiguration
还支持根据提供的初始实体生成模式(如果提供了实体)。继承自 AbstractCassandraConfiguration
要求您至少通过实现 getKeyspaceName
方法来提供 keyspace 名称。以下示例展示了如何使用 AbstractCassandraConfiguration
注册 bean
AbstractCassandraConfiguration
注册 Spring Data for Apache Cassandra bean@Configuration
public class CassandraConfiguration extends AbstractCassandraConfiguration {
/*
* Provide a contact point to the configuration.
*/
@Override
public String getContactPoints() {
return "localhost";
}
/*
* Provide a keyspace name to the configuration.
*/
@Override
public String getKeyspaceName() {
return "mykeyspace";
}
}
Abstract…Configuration
类会连接使用 Cassandra 所需的所有必要 bean。配置假设使用单个 CqlSession
,并将其通过 SessionFactory
连接到 CqlTemplate
等相关组件中。如果您想自定义 CqlSession
的创建,可以提供一个 SessionBuilderConfigurer
函数来定制 CqlSessionBuilder
。这对于提供例如 Astra 的云连接包非常有用。
AbstractCassandraConfiguration
连接到 Astra@Configuration
public class CustomizedCassandraConfiguration extends AbstractCassandraConfiguration {
/*
* Customize the CqlSession through CqlSessionBuilder.
*/
@Override
protected SessionBuilderConfigurer getSessionBuilderConfigurer() {
Path connectBundlePath = …;
return builder -> builder
.withCloudSecureConnectBundle(Path.of(connectBundlePath));
}
/*
* Provide a keyspace name to the configuration.
*/
@Override
public String getKeyspaceName() {
return "mykeyspace";
}
}
XML 配置
本节描述如何使用 XML 配置 Spring Data Cassandra。
虽然我们仍然支持命名空间配置,但我们通常建议使用基于 Java 的配置。 |
外部化连接属性
要外部化连接属性,您应该首先创建一个包含连接到 Cassandra 所需信息的属性文件。contactpoints
和 keyspace
是必需字段。
以下示例展示了我们的属性文件,名为 cassandra.properties
cassandra.contactpoints=10.1.55.80:9042,10.1.55.81:9042
cassandra.keyspace=showcase
在接下来的两个示例中,我们使用 Spring 将这些属性加载到 Spring 上下文中。
使用基于 XML 的元数据注册 Session 实例
虽然您可以使用 Spring 传统的 <beans/>
XML 命名空间向容器注册 com.datastax.oss.driver.api.core.CqlSession
实例,但由于其通用性,XML 可能相当冗长。XML 命名空间是配置常用对象(如 CqlSession
实例)的更好替代方案。cassandra
命名空间允许您创建一个 CqlSession
实例。
以下示例展示了如何配置 cassandra
命名空间
cassandra
命名空间配置 Cassandra 的 XML 模式<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:cassandra="http://www.springframework.org/schema/data/cassandra"
xsi:schemaLocation="
http://www.springframework.org/schema/data/cassandra
https://www.springframework.org/schema/data/cassandra/spring-cassandra.xsd
http://www.springframework.org/schema/beans
https://www.springframework.org/schema/beans/spring-beans.xsd">
<!-- Default bean name is 'cassandraSession' -->
<cassandra:session contact-points="localhost" port="9042">
<cassandra:keyspace action="CREATE_DROP" name="mykeyspace" />
</cassandra:session>
<cassandra:session-factory>
<cassandra:script
location="classpath:/org/springframework/data/cassandra/config/schema.cql"/>
</cassandra:session-factory>
</beans>
更高级的 Cassandra 配置的 XML 配置元素如下所示。这些元素都使用默认的 bean 名称,以保持配置代码的简洁性和可读性。
虽然前面的示例展示了如何轻松配置 Spring 连接到 Cassandra,但还有许多其他选项。基本上,DataStax Java Driver 中可用的任何选项在 Spring Data for Apache Cassandra 配置中也可用。这包括但不限于认证、负载均衡策略、重试策略和连接池选项。所有 Spring Data for Apache Cassandra 的方法名称和 XML 元素都与驱动程序上的配置选项完全相同(或尽可能接近),以便映射任何现有的驱动程序配置都应该非常直接。以下示例展示了如何使用 XML 配置 Spring Data 组件
<!-- Loads the properties into the Spring Context and uses them to fill
in placeholders in the bean definitions -->
<context:property-placeholder location="classpath:cassandra.properties" />
<!-- REQUIRED: The Cassandra Session -->
<cassandra:session contact-points="${cassandra.contactpoints}" keyspace-name="${cassandra.keyspace}" />
<!-- REQUIRED: The default Cassandra mapping context used by `CassandraConverter` -->
<cassandra:mapping>
<cassandra:user-type-resolver keyspace-name="${cassandra.keyspace}" />
</cassandra:mapping>
<!-- REQUIRED: The default Cassandra converter used by `CassandraTemplate` -->
<cassandra:converter />
<!-- REQUIRED: The Cassandra template is the foundation of all Spring
Data Cassandra -->
<cassandra:template id="cassandraTemplate" />
<!-- OPTIONAL: If you use Spring Data for Apache Cassandra repositories, add
your base packages to scan here -->
<cassandra:repositories base-package="org.spring.cassandra.example.repo" />