捲動

捲動是一種更精細的方法，用於迭代處理較大的結果集區塊。捲動包含穩定的排序、捲動類型（基於 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. 將 OffsetScrollPosition 與 Repository 查詢方法一起使用

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 中最後一個實體的金鑰集。為了執行查詢，重建會重寫條件子句，以包含所有排序欄位和主鍵，以便資料庫可以利用潛在的索引來執行查詢。資料庫只需要從給定的金鑰集位置建構一個小得多的結果，而無需完全實現大型結果，然後跳過結果直到達到特定 offset。

Keyset 過濾要求金鑰集屬性（用於排序的屬性）為非 Null。此限制的應用是因為商店特定的比較運算子 null 值處理，以及對索引來源執行查詢的需要。在可為 Null 的屬性上進行 Keyset 過濾將導致意外結果。

將 KeysetScrollPosition 與 Repository 查詢方法一起使用

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 投影，但請確保包含您已排序的所有屬性，以避免金鑰集提取失敗。

當指定您的 Sort 順序時，包含與您的查詢相關的排序屬性就足夠了；如果您不想，則無需確保查詢結果的唯一性。金鑰集查詢機制會透過包含主鍵（或複合主鍵的任何剩餘部分）來修改您的排序順序，以確保每個查詢結果都是唯一的。