滾動

滾動是一種更細粒度的方法，用於遍歷較大的結果集塊。滾動包括穩定排序、滾動型別（基於 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 標識元素在整個查詢結果中的確切位置。查詢執行將 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
}

使用 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` 的元素。

ScrollPosition.offset() 和 ScrollPosition.offset(0L) 之間是有區別的。前者表示滾動操作的開始，不指向任何特定的 offset，而後者標識結果的第一個元素（位於位置 0）。考慮到滾動的*獨佔*性，使用 ScrollPosition.offset(0) 會跳過第一個元素，並轉換為 offset 1。

使用 Keyset-Filtering 進行滾動

基於 Offset 的滾動要求大多數資料庫在您的伺服器返回結果之前，先實現整個結果。因此，雖然客戶端只看到請求結果的一部分，但您的伺服器需要構建完整的結果，這會造成額外的負載。

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

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

Keyset-Filtering 要求 keyset 屬性（用於排序的那些屬性）必須是非 null 的。此限制適用於特定儲存的比較運算子 null 值處理，以及針對索引源執行查詢的需要。在可為 null 的屬性上進行 Keyset-Filtering 將導致意外結果。

將 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-Filtering 的效果最好，因此靜態排序效果很好。應用 Keyset-Filtering 的滾動查詢要求查詢返回排序順序中使用的屬性，並且這些屬性必須對映到返回的實體中。

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

指定 Sort 順序時，只需包含與您的查詢相關的排序屬性即可；如果您不想確保查詢結果是唯一的，則無需這樣做。keyset 查詢機制會透過包含主鍵（或複合主鍵的任何剩餘部分）來修改您的排序順序，以確保每個查詢結果都是唯一的。