此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Data Cassandra 4.4.0spring-doc.cadn.net.cn

核心概念

Spring Data 存储库抽象中的中心接口是Repository. 它需要 domain 类来管理,并将 domain 类的标识符类型作为类型参数。 此接口主要用作标记接口,用于捕获要使用的类型,并帮助您发现扩展此接口的接口。spring-doc.cadn.net.cn

Spring Data 将域类型视为实体,更具体地说是聚合。 因此,您将看到整个文档中使用的术语 “entity” 可以与术语 “domain type” 或 “aggregate” 互换。spring-doc.cadn.net.cn

你可能已经注意到,在引言中,它已经暗示了域驱动的概念。 我们从 DDD 的意义上考虑域对象。 域对象具有标识符(否则这些将是无标识的值对象),当使用某些模式访问数据时,我们需要以某种方式引用标识符。 当我们讨论存储库和查询方法时,引用标识符将变得更加有意义。spring-doc.cadn.net.cn

CrudRepositoryListCrudRepositoryinterfaces 为正在管理的实体类提供复杂的 CRUD 功能。spring-doc.cadn.net.cn

CrudRepository接口
public interface CrudRepository<T, ID> extends Repository<T, ID> {

  <S extends T> S save(S entity);      (1)

  Optional<T> findById(ID primaryKey); (2)

  Iterable<T> findAll();               (3)

  long count();                        (4)

  void delete(T entity);               (5)

  boolean existsById(ID primaryKey);   (6)

  // … more functionality omitted.
}
1 保存给定的实体。
2 返回由给定 ID 标识的实体。
3 返回所有实体。
4 返回实体数。
5 删除给定的实体。
6 指示是否存在具有给定 ID 的实体。

此接口中声明的方法通常称为 CRUD 方法。ListCrudRepository提供等效的方法,但它们返回List其中,CrudRepository方法返回一个Iterable.spring-doc.cadn.net.cn

repository 接口隐含了一些保留的方法,例如findById(ID identifier),无论其属性名称如何,都以域类型标识符属性为目标。 在 “定义查询方法” 中阅读更多相关信息。spring-doc.cadn.net.cn

您可以使用@Query要提供自定义查询,如果 API 中的名为Id不引用标识符。 遵循该路径很容易导致混淆,因此不建议这样做,因为如果IDtype 和 type 的Idproperty devident.spring-doc.cadn.net.cn

我们还提供了特定于持久化技术的抽象,例如JpaRepositoryMongoRepository. 这些接口扩展了CrudRepository并公开底层持久化技术的功能,以及相当通用的持久化技术无关的接口,例如CrudRepository.

除了CrudRepositoryPagingAndSortingRepositoryListPagingAndSortingRepository其中添加了其他方法来简化对实体的分页访问:spring-doc.cadn.net.cn

PagingAndSortingRepository接口
public interface PagingAndSortingRepository<T, ID>  {

  Iterable<T> findAll(Sort sort);

  Page<T> findAll(Pageable pageable);
}
扩展接口以实际 store 模块支持为准。 虽然本文档解释了一般方案,但请确保您的 store 模块支持您要使用的接口。

要访问User将页面大小设置为 20 时,您可以执行如下作:spring-doc.cadn.net.cn

PagingAndSortingRepository<User, Long> repository = // … get access to a bean
Page<User> users = repository.findAll(PageRequest.of(1, 20));

ListPagingAndSortingRepository提供等效方法,但返回List其中,PagingAndSortingRepository方法返回一个Iterable.spring-doc.cadn.net.cn

除了查询方法之外,还可以使用 count 和 delete 查询的查询派生。 以下列表显示了派生计数查询的接口定义:spring-doc.cadn.net.cn

派生计数查询
interface UserRepository extends CrudRepository<User, Long> {

  long countByLastname(String lastname);
}

下面的清单显示了派生的 delete 查询的接口定义:spring-doc.cadn.net.cn

派生的删除查询
interface UserRepository extends CrudRepository<User, Long> {

  long deleteByLastname(String lastname);

  List<User> removeByLastname(String lastname);
}

实体状态检测策略

下表描述了 Spring Data 提供的用于检测实体是否为新实体的策略:spring-doc.cadn.net.cn

表 1.用于检测实体是否为 Spring Data 中的新实体的选项

@Id-Property inspection(默认)spring-doc.cadn.net.cn

默认情况下, Spring Data 检查给定实体的 identifier 属性。 如果 identifier 属性为null0如果是基元类型,则假定实体是 new。 否则,将假定它不是 new。spring-doc.cadn.net.cn

@Version-物业检查spring-doc.cadn.net.cn

如果带有@Version存在且null,或者 version 属性为基元类型0该实体被视为新实体。 如果 version 属性存在但具有不同的值,则认为该实体不是新实体。 如果不存在version属性,则 Spring Data 将回退到对标识符属性的检查。spring-doc.cadn.net.cn

实施Persistablespring-doc.cadn.net.cn

如果实体实现Persistable中,Spring Data 将新的检测委托给isNew(…)实体的方法。 有关详细信息,请参阅 Javadocspring-doc.cadn.net.cn

注意:的属性Persistable将被检测到并持久化AccessType.PROPERTY. 为避免这种情况,请使用@Transient.spring-doc.cadn.net.cn

提供自定义EntityInformation实现spring-doc.cadn.net.cn

您可以自定义EntityInformation通过创建特定于模块的 repository factory 的子类并覆盖getEntityInformation(…)方法。 然后,您必须将特定于模块的存储库工厂的自定义实现注册为 Spring Bean。 请注意,这很少是必需的。spring-doc.cadn.net.cn

Cassandra 不提供在插入数据时生成标识符的方法。 因此,实体必须与 identifier 值相关联。 Spring Data 默认使用标识符检查来确定实体是否为新实体。 如果要使用审计,请确保使用 Optimistic Locking 或 implementPersistable进行正确的实体状态检测。