Cassandra 仓库
要访问存储在 Apache Cassandra 中的领域实体,您可以使用 Spring Data 完善的仓库支持,它能大幅简化 DAO 的实现。为此,请为您的仓库创建一个接口,如下例所示:
示例 1. 示例 Person 实体
@Table
public class Person {
@Id
private String id;
private String firstname;
private String lastname;
// … getters and setters omitted
}
请注意,该实体有一个名为 id、类型为 String 的属性。MappingCassandraConverter(为仓库支持提供底层支撑)所使用的默认转换机制,会将名为 id 的属性视为行 ID。
以下示例展示了一个用于持久化 Person 实体的仓库定义:
- Imperative
- Reactive
interface PersonRepository extends CrudRepository<Person, String> {
// additional custom finder methods go here
}
interface PersonRepository extends ReactiveCrudRepository<Person, String> {
// additional custom finder methods go here
}
目前,前述示例中的接口仅用于指定类型,但我们稍后会向其中添加额外的方法。
接下来,在您的 Spring 配置中添加以下内容(如果您使用 Java 配置):
如果您想使用 Java 配置,请使用 @EnableCassandraRepositories 或对应的 @EnableReactiveCassandraRepositories 注解。该注解携带与命名空间元素相同的属性。如果未配置基础包,基础设施会扫描被注解的配置类所在的包。以下示例展示了不同的配置方式:
- Imperative Java Configuration
- XML
- Reactive Java Configuration
@Configuration
@EnableCassandraRepositories
class ApplicationConfig extends AbstractCassandraConfiguration {
@Override
protected String getKeyspaceName() {
return "keyspace";
}
public String[] getEntityBasePackages() {
return new String[] { "com.oreilly.springdata.cassandra" };
}
}
<?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">
<cassandra:session port="9042" keyspace-name="keyspaceName"/>
<cassandra:mapping
entity-base-packages="com.acme..entities">
</cassandra:mapping>
<cassandra:converter/>
<cassandra:template/>
<cassandra:repositories base-package="com.acme..entities"/>
</beans>
@Configuration
@EnableReactiveCassandraRepositories
class ApplicationConfig extends AbstractReactiveCassandraConfiguration {
@Override
protected String getKeyspaceName() {
return "keyspace";
}
public String[] getEntityBasePackages() {
return new String[] { "com.oreilly.springdata.cassandra" };
}
}
cassandra:repositories 命名空间元素会扫描基础包,查找扩展了 CrudRepository 的接口,并为找到的每个接口创建 Spring Bean。默认情况下,仓库会与名为 cassandraTemplate 的 CassandraTemplate Spring Bean 装配在一起,因此只有在您偏离此约定时,才需要显式配置 cassandra-template-ref。
由于我们的领域仓库扩展了 CrudRepository 或对应的 ReactiveCrudRepository,它为您提供了基本的 CRUD 操作。使用仓库实例只需将该仓库作为依赖注入到客户端中即可,如下例通过自动装配 PersonRepository 所示:
- Imperative
- Reactive
@ExtendWith(SpringExtension.class)
class PersonRepositoryTests {
@Autowired PersonRepository repository;
@Test
void readsPersonTableCorrectly() {
List<Person> persons = repository.findAll();
assertThat(persons.isEmpty()).isFalse();
}
}
public class PersonRepositoryTests {
@Autowired ReactivePersonRepository repository;
@Test
public void sortsElementsCorrectly() {
Flux<Person> people = repository.findAll(Sort.by(new Order(ASC, "lastname")));
}
}
Cassandra 仓库支持分页与排序,以对实体进行分页和排序访问。Cassandra 分页要求使用分页状态来只向前导航各页。Slice 会跟踪当前分页状态,并允许创建 Pageable 以请求下一页。以下示例展示了如何设置对 Person 实体的分页访问:
- Imperative
- Reactive
@ExtendWith(SpringExtension.class)
class PersonRepositoryTests {
@Autowired PersonRepository repository;
@Test
void readsPagesCorrectly() {
Slice<Person> firstBatch = repository.findAll(CassandraPageRequest.first(10));
assertThat(firstBatch).hasSize(10);
Slice<Person> nextBatch = repository.findAll(firstBatch.nextPageable());
// …
}
}
@ExtendWith(SpringExtension.class)
class PersonRepositoryTests {
@Autowired PersonRepository repository;
@Test
void readsPagesCorrectly() {
Mono<Slice<Person>> firstBatch = repository.findAll(CassandraPageRequest.first(10));
Mono<Slice<Person>> nextBatch = firstBatch.flatMap(it -> repository.findAll(it.nextPageable()));
// …
}
}}
Cassandra 仓库不扩展 PagingAndSortingRepository,因为使用 limit/offset 的经典分页模式不适用于 Cassandra。
前述示例借助 Spring 的单元测试支持创建了一个应用上下文,它会对测试类执行基于注解的依赖注入。在测试用例(测试方法)内部,我们使用仓库来查询数据存储,并调用请求所有 Person 实例的仓库查询方法。
响应式仓库
Spring Data 的仓库抽象是一种动态 API,它主要由您以及您在声明查询方法时的需求来定义。响应式 Cassandra 仓库可以通过扩展特定于库的仓库接口之一,使用 RxJava 或 Project Reactor 包装器类型来实现:
-
ReactiveCrudRepository -
ReactiveSortingRepository -
RxJava3CrudRepository -
RxJava3SortingRepository
Spring Data 会在幕后转换响应式包装器类型,因此您可以坚持使用自己偏好的组合库。