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

滚动

滚动是一种更细粒度的方法,用于迭代更大的结果集块。 滚动由稳定排序、滚动类型(基于偏移量或键集的滚动)和结果限制组成。 您可以使用属性名称定义简单的排序表达式,并使用TopFirst关键词通过查询派生。 您可以连接表达式以将多个条件收集到一个表达式中。spring-doc.cadn.net.cn

滚动查询返回Window<T>允许获取元素的滚动位置以获取下一个Window<T>直到您的应用程序使用了整个查询结果。 类似于使用 JavaIterator<List<…>>通过获取下一批结果,查询结果滚动允许您访问ScrollPosition通过Window.positionAt(…​).spring-doc.cadn.net.cn

Window<User> users = repository.findFirst10ByLastnameOrderByFirstname("Doe", ScrollPosition.offset());
do {

  for (User u : users) {
    // consume the user
  }

  // obtain the next Scroll
  users = repository.findFirst10ByLastnameOrderByFirstname("Doe", users.positionAt(users.size() - 1));
} while (!users.isEmpty() && users.hasNext());

ScrollPosition标识具有整个查询结果的元素的确切位置。 查询执行将位置参数视为排他性,结果将在给定位置之后开始。ScrollPosition#offset()ScrollPosition#keyset()作为ScrollPosition指示滚动作的开始。spring-doc.cadn.net.cn

上面的示例显示了静态排序和限制。 您也可以定义接受Sort对象定义更复杂的排序顺序或基于每个请求的排序。 以类似的方式,提供Limit对象允许您根据每个请求定义动态限制,而不是应用静态限制。 在查询方法详细信息中阅读有关动态排序和限制的更多信息。spring-doc.cadn.net.cn

WindowIterator提供了一个实用程序来简化滚动Windows 通过消除检查是否存在下一个Window并应用ScrollPosition.spring-doc.cadn.net.cn

WindowIterator<User> users = WindowIterator.of(position -> repository.findFirst10ByLastnameOrderByFirstname("Doe", position))
  .startingAt(ScrollPosition.offset());

while (users.hasNext()) {
  User u = users.next();
  // consume the user
}

使用偏移滚动

偏移滚动使用类似于分页的 Offset 计数器来跳过许多结果,并让数据源仅返回从给定 Offset 开始的结果。 这种简单的机制避免了将大量结果发送到客户端应用程序。 但是,大多数数据库需要在服务器返回结果之前具体化完整的查询结果。spring-doc.cadn.net.cn

示例 1.用OffsetScrollPosition使用存储库查询方法
interface UserRepository extends Repository<User, Long> {

  Window<User> findFirst10ByLastnameOrderByFirstname(String lastname, OffsetScrollPosition position);
}

WindowIterator<User> users = WindowIterator.of(position -> repository.findFirst10ByLastnameOrderByFirstname("Doe", position))
  .startingAt(OffsetScrollPosition.initial()); (1)
1 从无偏移开始,以在位置包括元素0.

之间有区别ScrollPosition.offset()ScrollPosition.offset(0L). 前者表示滚动作的开始,指向没有特定的偏移量,而后者标识第一个元素(在位置0) 的结果。 鉴于滚动的排他性,使用ScrollPosition.offset(0)跳过第一个元素并转换为1.spring-doc.cadn.net.cn

使用键集过滤滚动

基于偏移量要求大多数数据库需要具体化整个结果,然后服务器才能返回结果。 因此,虽然客户端只能看到请求结果的一部分,但您的服务器需要构建完整的结果,这会导致额外的负载。spring-doc.cadn.net.cn

键集过滤通过利用数据库的内置功能来检索结果子集,旨在减少单个查询的计算和 I/O 要求。 此方法维护一组键,通过将键传递到查询中来恢复滚动,从而有效地修改筛选条件。spring-doc.cadn.net.cn

Keyset-Filtering 的核心思想是使用稳定的排序顺序开始检索结果。 一旦你想滚动到下一个块,你就会得到一个ScrollPosition用于重建排序结果中的位置。 这ScrollPosition捕获当前Window. 为了运行查询,重建会重写 criteria 子句以包含所有排序字段和主键,以便数据库可以利用潜在的索引来运行查询。 数据库只需要从给定的键集位置构造一个小得多的结果,而不需要完全具体化一个大结果,然后跳过结果,直到达到特定的偏移量。spring-doc.cadn.net.cn

键集过滤要求键集属性(用于排序的属性)不可为空。 此限制适用于特定于商店null比较运算符的值处理以及对索引源运行查询的需要。 对可为 null 属性的键集过滤将导致意外结果。spring-doc.cadn.net.cn

KeysetScrollPosition使用存储库查询方法
interface UserRepository extends Repository<User, Long> {

  Window<User> findFirst10ByLastnameOrderByFirstname(String lastname, KeysetScrollPosition position);
}

WindowIterator<User> users = WindowIterator.of(position -> repository.findFirst10ByLastnameOrderByFirstname("Doe", position))
  .startingAt(ScrollPosition.keyset()); (1)
1 从头开始,不要应用额外的过滤。

当您的数据库包含与排序字段匹配的索引时,键集过滤效果最佳,因此静态排序效果很好。 应用键集过滤的滚动查询需要查询返回排序顺序中使用的属性,并且这些属性必须映射到返回的实体中。spring-doc.cadn.net.cn

可以使用接口和 DTO 投影,但请确保包含排序依据的所有属性,以避免键集提取失败。spring-doc.cadn.net.cn

指定您的Sortorder,则包含与查询相关的排序属性就足够了; 如果您不想,则无需确保唯一的查询结果。 键集查询机制通过包含主键(或复合主键的任何其余部分)来修改排序顺序,以确保每个查询结果都是唯一的。spring-doc.cadn.net.cn