滾動

滾動是一種更細粒度的方法，用於迭代更大的結果集塊。滾動由穩定的排序、滾動型別（基於 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 查詢機制透過包含主鍵（或複合主鍵的任何剩餘部分）來修改您的排序順序，以確保每個查詢結果都是唯一的。