滾動

滾動是一種更精細的方法，用於迭代處理較大的結果集區塊。滾動包含穩定的排序、滾動類型（基於偏移量或金鑰集的滾動）和結果限制。您可以使用屬性名稱來定義簡單的排序表達式，並透過查詢衍生，使用 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
}

使用偏移量滾動

偏移量滾動類似於分頁，使用偏移量計數器來跳過一些結果，並讓資料來源僅回傳從給定偏移量開始的結果。這種簡單的機制避免了將大量結果傳送到用戶端應用程式。然而，大多數資料庫在您的伺服器可以回傳結果之前，需要將完整查詢結果具體化。

範例 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	從最開始處開始，並且不應用額外的過濾。

當您的資料庫包含與排序欄位匹配的索引時，金鑰集過濾效果最佳，因此靜態排序效果良好。應用金鑰集過濾的滾動查詢需要查詢回傳排序順序中使用的屬性，並且這些屬性必須對應到回傳的實體中。

您可以使用介面和 DTO 投影，但是請確保包含您已排序的所有屬性，以避免金鑰集提取失敗。

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