此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Data Commons 3.5.3spring-doc.cadn.net.cn

核心概念

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

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

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

CrudRepositoryListCrudRepository接口为正在管理的实体类提供复杂的 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

存储库接口暗示了一些保留的方法,例如findById(ID identifier)面向域类型标识符属性,而不考虑其属性名称。 在“定义查询方法”中阅读有关此内容的更多信息。spring-doc.cadn.net.cn

您可以使用@Query如果属性名为Id不引用标识符。 遵循该路径很容易导致混乱,并且不鼓励这样做,因为如果IDtype 和 your 的类型Id属性偏差。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

除了分页之外,滚动还提供了更细粒度的访问,用于迭代较大的结果集块。spring-doc.cadn.net.cn

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

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

  long countByLastname(String lastname);
}

以下列表显示了派生删除查询的接口定义:spring-doc.cadn.net.cn

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

  long deleteByLastname(String lastname);

  List<User> removeByLastname(String lastname);
}