对于最新的稳定版本,请使用 Spring Data Cassandra 4.5.2! |
Cassandra 存储库
要访问存储在 Apache Cassandra 中的域实体,您可以使用 Spring Data 的复杂存储库支持,这大大简化了 DAO 的实现。为此,请为您的存储库创建一个接口,如以下示例所示:
@Table
public class Person {
@Id
private String id;
private String firstname;
private String lastname;
// … getters and setters omitted
}
请注意,该实体有一个名为id
类型String
. 中使用的默认转换机制MappingCassandraConverter
(支持存储库支持)将名为id
作为行 ID。
以下示例显示了要保留的存储库定义Person
实体:
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
namespace 元素会导致扫描基本包以查找扩展CrudRepository
并为找到的每个 Spring Bean 创建 Spring Bean。默认情况下,存储库使用CassandraTemplate
春豆叫cassandraTemplate
,因此您只需配置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
实体:
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 ,因为使用限制/偏移的经典分页模式不适用于 Cassandra。 |
前面的示例使用 Spring 的单元测试支持创建一个应用程序上下文,该上下文将基于注释的依赖注入到测试类中。在测试用例(测试方法)中,我们使用存储库来查询数据存储。我们调用请求所有Person
实例。
响应式存储库
Spring Data 的存储库抽象是一个动态 API,主要由您和您的需求在声明查询方法时定义。 响应式 Cassandra 存储库可以通过使用 RxJava 或 Project Reactor 包装器类型来实现,方法是从特定于库的存储库接口之一进行扩展:
-
ReactiveCrudRepository
-
ReactiveSortingRepository
-
RxJava3CrudRepository
-
RxJava3SortingRepository
Spring Data 在幕后转换响应式包装器类型,以便您可以坚持使用您最喜欢的组合库。