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 的属性,类型为 StringMappingCassandraConverter(支持存储库)中使用的默认转换机制将名为 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。默认情况下,这些存储库通过名为 cassandraTemplateCassandraTemplate Spring Bean 进行连接,因此,只有在偏离此约定时才需要显式配置 cassandra-template-ref

由于我们的域存储库分别扩展了 CrudRepositoryReactiveCrudRepository,因此它为您提供了基本的 CRUD 操作。使用存储库实例只需将存储库注入到客户端的依赖项中,如下面的示例通过自动装配 PersonRepository 所示

对 Person 实体的基本访问
  • 命令式

  • 响应式

@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,因为使用限制/偏移量的经典分页模式不适用于 Cassandra。

前面的示例使用 Spring 的单元测试支持创建了一个应用程序上下文,该支持对测试类执行基于注释的依赖项注入。在测试用例(测试方法)中,我们使用存储库查询数据存储。我们调用存储库查询方法,该方法请求所有 Person 实例。

响应式存储库

Spring Data 的存储库抽象是一个动态 API,主要由您和您的要求定义,因为您声明了查询方法。可以通过使用 RxJava 或 Project Reactor 包装器类型来实现响应式 Cassandra 存储库,方法是从特定于库的存储库接口之一进行扩展

  • ReactiveCrudRepository

  • ReactiveSortingRepository

  • RxJava3CrudRepository

  • RxJava3SortingRepository

Spring Data 在幕后转换响应式包装器类型,以便您可以坚持使用您最喜欢的组合库。