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
实体的基本仓库接口-
命令式
-
响应式
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
注解。该注解具有与命名空间元素相同的属性。如果未配置基本包,则基础设施将扫描带注解的配置类的包。以下示例显示了不同的配置方法。
-
命令式 Java 配置
-
XML
-
响应式 Java 配置
@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
。
-
命令式
-
响应式
@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
实体的分页访问-
命令式
-
响应式
@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
实例的仓库查询方法。