滚动

滚动是一种更细粒度的迭代方式，用于遍历较大的结果集块。滚动包括一个稳定的排序、一种滚动类型（基于偏移量或密钥集的滚动）和结果限制。您可以使用属性名称定义简单的排序表达式，并使用Top或First关键字通过查询派生来定义静态结果限制。您可以连接表达式以将多个条件组合成一个表达式。

滚动查询返回一个Window<T>，它允许获取元素的滚动位置以获取下一个Window<T>，直到您的应用程序已使用完整个查询结果。类似于通过获取下一批结果来使用 Java Iterator<List<…>>，查询结果滚动允许您通过Window.positionAt(…)访问ScrollPosition。

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的特殊体现，表示滚动操作的开始。

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

WindowIterator提供了一个实用程序来简化跨Window的滚动，从而无需检查下一个Window的存在并应用ScrollPosition。

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

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

使用偏移量滚动

偏移量滚动类似于分页，使用偏移量计数器跳过一定数量的结果，并让数据源仅返回从给定偏移量开始的结果。这种简单的机制避免了将大量结果发送到客户端应用程序。但是，大多数数据库都需要在服务器返回结果之前物化整个查询结果。

示例 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`处的元素。

ScollPosition.offset()和ScollPosition.offset(0L)之间存在差异。前者表示滚动操作的开始，指向没有特定偏移量，而后者标识结果的第一个元素（位于位置0）。鉴于滚动的排他性，使用ScollPosition.offset(0)会跳过第一个元素并转换为偏移量1。

使用密钥集过滤滚动

基于偏移量的滚动需要大多数数据库在服务器返回结果之前物化整个结果。因此，虽然客户端只看到请求结果的一部分，但服务器需要构建完整的结果，这会导致额外的负载。

密钥集过滤方法通过利用数据库的内置功能来检索结果子集，旨在减少单个查询的计算和 I/O 需求。此方法维护一组密钥以通过将密钥传递到查询中来恢复滚动，有效地修改了您的筛选条件。

密钥集过滤的核心思想是从稳定的排序顺序开始检索结果。一旦您想要滚动到下一个块，您将获得一个ScrollPosition，用于在排序结果中重建位置。ScrollPosition捕获当前Window中最后一个实体的密钥集。要运行查询，重建会重写条件子句以包含所有排序字段和主键，以便数据库可以利用潜在的索引来运行查询。数据库只需要从给定的密钥集位置构造一个更小的结果，而无需完全物化一个大的结果，然后跳过结果直到到达特定的偏移量。

密钥集过滤要求密钥集属性（用于排序的属性）不可为空。此限制是由于存储特定null值的比较运算符处理方式以及需要针对索引源运行查询而造成的。在可为空的属性上进行密钥集过滤会导致意外的结果。

使用存储库查询方法的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	从一开始就启动，并且不应用其他过滤。

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

您可以使用接口和 DTO 投影，但请确保包含您已排序的所有属性，以避免密钥集提取失败。

在指定Sort顺序时，包含与您的查询相关的排序属性就足够了；如果您不想确保唯一查询结果，则无需这样做。密钥集查询机制通过包含主键（或复合主键的任何其余部分）来修改您的排序顺序，以确保每个查询结果都是唯一的。