滾動

滾動是一種更細粒度的方法，用於迭代較大的結果集塊。滾動由穩定的排序、滾動型別（基於偏移量或基於 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 標識元素在整個查詢結果中的確切位置。查詢執行將位置引數視為 exclusive（排他性的），結果將從給定位置之後開始。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 scrolling）類似於分頁，使用一個偏移量計數器來跳過一定數量的結果，並讓資料來源僅返回從給定偏移量開始的結果。這種簡單的機制避免了將大量結果傳送到客戶端應用程式。然而，大多數資料庫要求在您的伺服器返回結果之前例項化完整的查詢結果。

示例 1. 在 Repository 查詢方法中使用 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）。考慮到滾動的 exclusive（排他性）性質，使用 ScollPosition.offset(0) 會跳過第一個元素，並轉換為偏移量 1。

使用 Keyset-Filtering 滾動

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

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

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

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

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

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

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