捲動

捲動是一種更細緻的方法，用於迭代處理較大的結果集區塊。捲動包含穩定的排序、捲動類型（基於偏移量或鍵集的捲動）和結果限制。您可以使用屬性名稱定義簡單的排序表示式，並使用 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。此限制的應用是由於商店特定的比較運算子 null 值處理以及針對索引來源執行查詢的需求。在可為 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 順序時，包含與您的查詢相關的排序屬性就足夠了；如果您不想確保查詢結果的唯一性，則無需這樣做。鍵集查詢機制會透過包含主鍵（或複合主鍵的任何剩餘部分）來修改您的排序順序，以確保每個查詢結果都是唯一的。