滚动

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

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

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

使用偏移量进行滚动

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

示例 1. 在 Repository 查询方法中使用 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。

使用 Keyset 过滤进行滚动

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

Keyset 过滤通过利用数据库的内置能力来实现结果子集检索，旨在减少单个查询的计算和 I/O 要求。这种方法维护一组键，通过将键传递到查询中来恢复滚动，从而有效地修改过滤条件。

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

Keyset 过滤要求键集属性（用于排序的属性）不可为空。此限制适用于存储特定的 null 值处理比较运算符，以及对索引源运行查询的需求。在可空属性上进行 Keyset 过滤将导致意外结果。

在 Repository 查询方法中使用 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	从最开始处开始，不应用额外的过滤。

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

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

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