滚动

滚动是一种更细粒度的迭代大型结果集块的方法。滚动包括稳定的排序、滚动类型（基于偏移量或键集的滚动）和结果限制。您可以使用属性名称定义简单的排序表达式，并使用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	从一开始就启动，并且不应用其他筛选。

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

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

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