滾動

滾動 (Scrolling) 是一種更細粒度的方法，用於迭代大型結果集塊。滾動包括一個穩定的排序、一種滾動型別（基於偏移量或鍵集）和結果限制。您可以使用屬性名定義簡單的排序表示式，並透過查詢派生使用 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 的需要，簡化了跨 Windows 的滾動。

WindowIterator<User> users = WindowIterator.of(position -> repository.findFirst10ByLastnameOrderByFirstname("Doe", position))
  .startingAt(ScrollPosition.offset());

while (users.hasNext()) {
  User u = users.next();
  // consume the user
}

使用偏移量進行滾動

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

示例 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` 的元素。

ScrollPosition.offset() 和 ScrollPosition.offset(0L) 之間存在差異。前者表示滾動操作的開始，不指向特定的偏移量，而後者標識結果中的第一個元素（位於位置 0）。考慮到滾動的 排他性 特點，使用 ScrollPosition.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 順序時，只需包含與查詢相關的排序屬性即可；如果您不想這樣做，則無需確保查詢結果的唯一性。鍵集查詢機制透過包含主鍵（或複合主鍵的任何剩餘部分）來修正您的排序順序，以確保每個查詢結果都是唯一的。