滾動

滾動是一種更細粒度的方法，用於迭代更大的結果集塊。滾動包括穩定的排序、滾動型別（基於偏移量或基於 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 標識元素在整個查詢結果中的確切位置。查詢執行將 position 引數視為 排他性 的，結果將從給定位置之後開始。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。

使用 Keyset 過濾滾動

基於偏移量的滾動要求大多數資料庫在您的伺服器返回結果之前實體化整個結果。因此，儘管客戶端只看到請求結果的一部分，但您的伺服器需要構建完整結果，這會增加額外的負載。

Keyset 過濾透過利用資料庫的內建功能來實現結果子集檢索，旨在減少單個查詢的計算和 I/O 要求。這種方法維護一組鍵，透過將鍵傳遞到查詢中來恢復滾動，從而有效地修改您的過濾條件。

Keyset 過濾的核心思想是使用穩定的排序順序開始檢索結果。一旦您想要滾動到下一個塊，您將獲得一個 ScrollPosition，該位置用於在排序結果中重建位置。ScrollPosition 捕獲當前 Window 中最後一個實體的 keyset。為了執行查詢，重建會重寫條件子句，以包含所有排序欄位和主鍵，以便資料庫可以利用潛在索引來執行查詢。資料庫只需要從給定的 keyset 位置構建一個更小的結果，而無需完全實體化大量結果，然後跳過結果直到達到特定偏移量。

Keyset 過濾要求 keyset 屬性（用於排序的屬性）不可為空。此限制適用於儲存特定的 null 值處理比較運算子，以及需要針對索引源執行查詢。對可空屬性進行 Keyset 過濾將導致意外結果。

在儲存庫查詢方法中使用 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 查詢機制透過包含主鍵（或複合主鍵的任何剩餘部分）來修改您的排序順序，以確保每個查詢結果都是唯一的。