核心概念

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

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

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

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);
}