Spring Data Commons 提供了一个通用的分页接口 Page,可用于统一各种数据访问技术的分页操作。该接口允许在域模型中的实体集合上进行高效分页,并提供有关分页结果的元数据,例如总页数和当前页码。使用 Page 可以简化分页代码,并使其与特定的数据存储无关。通过将 Page 与 Spring Data 存储库结合使用,开发人员可以轻松地为其应用程序实现分页功能。

Core concepts

Spring Data 存储库抽象中的中心接口是 Repository。它取管理的领域类以及作为类型参数的领域类的标识符类型。此接口主要充当标记接口,用于捕获要处理的类型,并帮助你发现扩展此接口的接口。https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/repository/CrudRepository.html[CrudRepository] 和 ListCrudRepository 接口提供被管理的实体类的复杂 CRUD 功能。

CrudRepository Interface
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 Saves the given entity.
2 返回由给定 ID 标识的实体。
3 Returns all entities.
4 返回实体的数量。
5 Deletes the given entity.
6 指示是否存在一个具有给定 ID 的实体。

在此接口中声明的方法通常称为 CRUD 方法。ListCrudRepository 提供等效方法,但它们在 CrudRepository 方法返回 Iterable 的位置返回 List

我们还提供了特定于持久化技术的抽象,例如 JpaRepositoryMongoRepository。这些接口扩展了 CrudRepository,除了相当通用的与持久化技术无关的接口(例如 CrudRepository)之外,还公开了底层持久化技术的功能。

除了 CrudRepository 之外,还有 PagingAndSortingRepositoryListPagingAndSortingRepository,它们添加了更多方法,可以轻松地对实体进行分页访问:

PagingAndSortingRepository interface
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

除了查询方法外,还可以使用计数查询和删除查询的查询派生。以下列表显示派生计数查询的接口定义:

Derived Count Query
interface UserRepository extends CrudRepository<User, Long> {

  long countByLastname(String lastname);
}

以下列表显示派生删除查询的接口定义:

Derived Delete Query
interface UserRepository extends CrudRepository<User, Long> {

  long deleteByLastname(String lastname);

  List<User> removeByLastname(String lastname);
}