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 實體的儲存庫定義

用於持久化 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,主要由您和您的需求定義,因為您宣告了查詢方法。反應式 Cassandra 儲存庫可以使用 RxJava 或 Project Reactor 包裝函式類型來實作,方法是從其中一個特定於程式庫的儲存庫介面擴充

  • ReactiveCrudRepository

  • ReactiveSortingRepository

  • RxJava3CrudRepository

  • RxJava3SortingRepository

Spring Data 在幕後轉換反應式包裝函式類型,以便您可以堅持使用您最喜歡的組合程式庫。