滚动

滚动是一种更细粒度的方法，用于迭代较大的结果集块。滚动包括一个稳定的排序、一个滚动类型（基于偏移量的滚动或基于 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 标识元素在整个查询结果中的确切位置。查询执行将位置参数视为 *exclusive*（不包含），结果将从给定位置 *之后* 开始。ScrollPosition#offset() 和 ScrollPosition#keyset() 是 ScrollPosition 的特殊实现，指示滚动操作的开始。

上面的示例展示了静态排序和限制。您可以选择性地定义接受 Sort 对象来定义更复杂的排序顺序或基于每个请求进行排序的查询方法。类似地，提供 Limit 对象允许您基于每个请求定义动态限制，而不是应用静态限制。请参阅 Query Methods Details，了解有关动态排序和限制的更多信息。

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）。考虑到滚动的 *exclusive*（不包含）特性，使用 ScollPosition.offset(0) 会跳过第一个元素，并转换为偏移量 1。

使用 Keyset-Filtering 滚动

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

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

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

Keyset-Filtering 要求 Keyset 属性（用于排序的属性）非空。此限制的适用是由于存储特定数据库处理比较运算符中的 null 值的方式，以及需要对索引源运行查询。对可空属性进行 Keyset-Filtering 会导致意外结果。

在 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-Filtering 在数据库包含与排序字段匹配的索引时效果最佳，因此静态排序效果很好。应用 Keyset-Filtering 的滚动查询要求查询返回排序顺序中使用的属性，并且这些属性必须映射到返回的实体中。

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

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