滚动

滚动是一种更细粒度的方法，用于迭代更大的结果集块。滚动由稳定的排序、滚动类型（基于 Offset 或 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
}

使用 Offset 滚动

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

示例 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	从无 Offset 开始，以包含位置 `0` 的元素。

ScollPosition.offset() 和 ScollPosition.offset(0L) 之间存在差异。前者表示滚动操作的开始，不指向特定的 Offset，而后者标识结果中的第一个元素（位置 0）。考虑到滚动的 不包含 性质，使用 ScollPosition.offset(0) 会跳过第一个元素并转换为 Offset 1。

使用 Keyset 过滤滚动

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

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

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

Keyset 过滤要求 keyset 属性（用于排序的属性）不可为 null。此限制是由于特定存储对比较运算符的 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 投影，但请确保包含所有您已排序的属性，以避免 keyset 提取失败。

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