核心概念

Spring Data repository 抽象中的核心接口是 Repository。它接受要管理的领域类以及领域类的标识符类型作为类型参数。此接口主要作为标记接口,用于捕获要使用的类型,并帮助您发现扩展此接口的其他接口。

Spring Data 将领域类型视为实体,更具体地说,是聚合。因此,您将在整个文档中看到 "实体" 这个术语,它可以与 "领域类型" 或 "聚合" 互换使用。

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

The CrudRepositoryListCrudRepository 接口为正在管理的实体类提供了复杂的 CRUD 功能。

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

repository 接口暗示了一些保留方法,如 findById(ID identifier),这些方法无论属性名称如何,都针对领域类型的标识符属性。在 “定义查询方法” 中阅读更多内容。

如果名为 Id 的属性不指向标识符,您可以用 @Query 注解您的查询方法以提供自定义查询。不建议采用这种做法,因为它很容易导致混淆,而且如果 ID 类型与 Id 属性的类型不一致,您很快就会遇到类型限制。

我们还提供了持久化技术特定的抽象,例如 JpaRepositoryMongoRepository。这些接口扩展了 CrudRepository,除了像 CrudRepository 这样通用的、与持久化技术无关的接口之外,还暴露了底层持久化技术的能力。

除了 CrudRepository 之外,还有 PagingAndSortingRepositoryListPagingAndSortingRepository,它们增加了额外的方法以方便对实体进行分页访问。

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

  Iterable<T> findAll(Sort sort);

  Page<T> findAll(Pageable pageable);
}
扩展接口需要实际存储模块的支持。虽然本文档解释了总体方案,请确保您的存储模块支持您想使用的接口。

要以每页 20 个的大小访问 User 的第二页,您可以执行类似如下操作

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

ListPagingAndSortingRepository 提供等效方法,但返回 List,而 PagingAndSortingRepository 方法返回 Iterable

除了查询方法之外,还提供了 count 和 delete 查询的查询派生。以下列表显示了派生 count 查询的接口定义

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

  long countByLastname(String lastname);
}

以下列表显示了派生 delete 查询的接口定义

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

  long deleteByLastname(String lastname);

  List<User> removeByLastname(String lastname);
}