滚动

滚动是一种更细粒度的方法，用于迭代较大的结果集块。滚动由稳定的排序、滚动类型（基于偏移量或基于 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 对象允许您基于每个请求定义动态限制，而不是应用静态限制。请在查询方法详情中阅读更多关于动态排序和限制的内容。

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
}

使用偏移量滚动

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

示例 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 属性（用于排序的属性）不可为空 (non-nullable)。此限制适用于存储特定（store specific）的比较运算符的 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 查询机制通过包含主键（或复合主键的任何剩余部分）来修正您的排序顺序，以确保每个查询结果都是唯一的。