滚动

滚动 (Scrolling) 是一种更细粒度的方法，用于迭代大型结果集块。滚动包括一个稳定的排序、一种滚动类型（基于偏移量或键集）和结果限制。您可以使用属性名定义简单的排序表达式，并通过查询派生使用 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 并应用 ScrollPosition 的需要，简化了跨 Windows 的滚动。

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

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

使用偏移量进行滚动

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

示例 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。

使用键集过滤进行滚动

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

键集过滤通过利用数据库的内置能力来检索结果子集，旨在减少单个查询的计算和 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 顺序时，只需包含与查询相关的排序属性即可；如果您不想这样做，则无需确保查询结果的唯一性。键集查询机制通过包含主键（或复合主键的任何剩余部分）来修正您的排序顺序，以确保每个查询结果都是唯一的。