定義查詢方法

Repository 代理有兩種方式從方法名派生特定儲存的查詢

直接從方法名派生查詢。
使用手動定義的查詢。

可用選項取決於實際的儲存。然而，必須有一個策略來決定實際建立哪種查詢。下一節將描述可用的選項。

查詢查詢策略

Repository 基礎設施可使用以下策略來解析查詢。對於 XML 配置，你可以在名稱空間中使用 query-lookup-strategy 屬性配置策略。對於 Java 配置，你可以使用 EnableCouchbaseRepositories 註解的 queryLookupStrategy 屬性。某些策略可能不支援特定的資料儲存。

CREATE 嘗試從查詢方法名構建特定儲存的查詢。通常的方法是從方法名中移除一組眾所周知的指定字首，然後解析方法的其餘部分。你可以在“查詢建立”中閱讀更多關於查詢構建的資訊。
USE_DECLARED_QUERY 嘗試查詢已宣告的查詢，如果找不到則丟擲異常。查詢可以透過註解或其他方式宣告。請參閱特定儲存的文件以查詢該儲存的可用選項。如果在引導時 Repository 基礎設施未找到方法的宣告查詢，則會失敗。
CREATE_IF_NOT_FOUND（預設）結合了 CREATE 和 USE_DECLARED_QUERY。它首先查詢已宣告的查詢，如果找不到已宣告的查詢，則會建立一個基於方法名的自定義查詢。這是預設的查詢策略，因此如果你沒有明確配置任何內容，就會使用它。它允許透過方法名快速定義查詢，同時也可以透過引入已宣告的查詢來根據需要進行自定義調整。

查詢建立

內置於 Spring Data Repository 基礎設施的查詢構建器機制對於基於 Repository 實體構建約束性查詢非常有用。

以下示例展示瞭如何建立一些查詢

從方法名建立查詢

interface PersonRepository extends Repository<Person, Long> {

  List<Person> findByEmailAddressAndLastname(EmailAddress emailAddress, String lastname);

  // Enables the distinct flag for the query
  List<Person> findDistinctPeopleByLastnameOrFirstname(String lastname, String firstname);
  List<Person> findPeopleDistinctByLastnameOrFirstname(String lastname, String firstname);

  // Enabling ignoring case for an individual property
  List<Person> findByLastnameIgnoreCase(String lastname);
  // Enabling ignoring case for all suitable properties
  List<Person> findByLastnameAndFirstnameAllIgnoreCase(String lastname, String firstname);

  // Enabling static ORDER BY for a query
  List<Person> findByLastnameOrderByFirstnameAsc(String lastname);
  List<Person> findByLastnameOrderByFirstnameDesc(String lastname);
}

解析查詢方法名分為主體和謂詞。第一部分（如 find…By、exists…By）定義查詢的主體，第二部分構成謂詞。引入子句（主體）可以包含進一步的表示式。find（或其他引入關鍵字）和 By 之間的任何文字都被視為描述性的，除非使用結果限制關鍵字之一，例如使用 Distinct 在要建立的查詢上設定 Distinct 標誌，或者使用 Top/First 限制查詢結果。

附錄包含查詢方法主體關鍵字的完整列表以及查詢方法謂詞關鍵字，包括排序和字母大小寫修飾符。然而，第一個 By 用作分隔符，指示實際條件謂詞的開始。在非常基礎的層面，你可以在實體屬性上定義條件，並使用 And 和 Or 將它們連線起來。

解析方法的實際結果取決於你建立查詢的持久化儲存。然而，有一些需要注意的通用事項

表示式通常是屬性遍歷與可串聯的運算子結合。你可以將屬性表示式與 AND 和 OR 組合。對於屬性表示式，你還支援諸如 Between、LessThan、GreaterThan 和 Like 等運算子。支援的運算子可能因資料儲存而異，因此請查閱你的參考文件中的相應部分。
方法解析器支援為單個屬性設定 IgnoreCase 標誌（例如 findByLastnameIgnoreCase(…)），或者為支援忽略大小寫的型別的所有屬性設定（通常是 String 例項——例如 findByLastnameAndFirstnameAllIgnoreCase(…)）。是否支援忽略大小寫可能因儲存而異，因此請查閱參考文件中針對特定儲存的查詢方法的相應部分。
你可以透過在查詢方法後附加引用屬性的 OrderBy 子句並提供排序方向（Asc 或 Desc）來應用靜態排序。要建立一個支援動態排序的查詢方法，請參閱“分頁、遍歷大型結果、排序與限制”。

保留方法名

派生的 Repository 方法透過名稱繫結到屬性，但對於從基礎 Repository 繼承的針對識別符號屬性的某些方法名，此規則存在一些例外。那些保留方法，如 CrudRepository#findById（或僅 findById），無論宣告方法中使用的實際屬性名稱如何，都針對識別符號屬性。

考慮以下領域型別，其中包含一個透過 @Id 標記為識別符號的屬性 pk 和一個名為 id 的屬性。在這種情況下，你需要密切注意查詢方法的命名，因為它們可能與預定義簽名衝突

class User {
  @Id Long pk;                          (1)

  Long id;                              (2)

  // …
}

interface UserRepository extends Repository<User, Long> {

  Optional<User> findById(Long id);     (3)

  Optional<User> findByPk(Long pk);     (4)

  Optional<User> findUserById(Long id); (5)
}

1	識別符號屬性（主鍵）。
2	一個名為 `id` 的屬性，但不是識別符號。
3	由於它引用了 `CrudRepository` 的基礎 Repository 方法，因此它針對 `pk` 屬性（即標記有 `@Id` 並被視為識別符號的屬性）。因此，它不是一個使用 `id` 作為屬性名的派生查詢，因為它屬於保留方法之一。
4	它透過名稱針對 `pk` 屬性，因為它是一個派生查詢。
5	它透過使用 `find` 和 `by` 之間的描述性標記來避免與保留方法衝突，從而針對 `id` 屬性。

這種特殊行為不僅適用於查詢方法，也適用於 exits 和 delete 方法。有關方法列表，請參閱“Repository 查詢關鍵詞”。

屬性表示式

屬性表示式只能引用受管實體的直接屬性，如前面的示例所示。在建立查詢時，你已經確保解析的屬性是受管領域類的屬性。但是，你也可以透過遍歷巢狀屬性來定義約束。考慮以下方法簽名

List<Person> findByAddressZipCode(ZipCode zipCode);

假設 Person 有一個帶有 ZipCode 的 Address。在這種情況下，該方法建立 x.address.zipCode 屬性遍歷。解析演算法首先將整個部分（AddressZipCode）解釋為屬性，並在領域類中檢查是否存在該名稱（未首字母大寫）的屬性。如果演算法成功，則使用該屬性。如果失敗，演算法將從右側的駝峰大小寫部分將源分割成頭部和尾部，並嘗試查詢相應的屬性——在我們的示例中，是 AddressZip 和 Code。如果演算法找到具有該頭部的屬性，則獲取尾部並從那裡繼續構建樹，以剛剛描述的方式拆分尾部。如果第一次拆分不匹配，演算法會將拆分點向左移動（Address，ZipCode）並繼續。

儘管這在大多數情況下應該有效，但演算法有可能選擇錯誤的屬性。假設 Person 類也有一個 addressZip 屬性。演算法會在第一次拆分中就匹配上，選擇錯誤的屬性，然後失敗（因為 addressZip 的型別可能沒有 code 屬性）。

為了解決這種歧義，你可以在方法名中使用 _ 來手動定義遍歷點。因此，我們的方法名如下所示

List<Person> findByAddress_ZipCode(ZipCode zipCode);

由於我們將下劃線（_）視為保留字元，因此強烈建議遵循標準的 Java 命名約定（即不在屬性名中使用下劃線，而是使用駝峰大小寫）。

以下劃線開頭的欄位名

欄位名可以以下劃線開頭，例如 String _name。請確保保留 _name 中的 _，並使用雙下劃線 __ 分割巢狀路徑，例如 user__name。

大寫欄位名

全部大寫的欄位名可以直接使用。如果適用，巢狀路徑需要透過 _ 分割，例如 USER_name。

第二個字母大寫的欄位名

由小寫字母開頭後跟大寫字母的欄位名，例如 String qCode，可以透過以兩個大寫字母開頭來解析，例如 QCode。請注意潛在的路徑歧義。

路徑歧義

在以下示例中，屬性 qCode 和 q 的排列方式（其中 q 包含一個名為 code 的屬性）為路徑 QCode 帶來了歧義。

record Container(String qCode, Code q) {}
record Code(String code) {}

由於優先考慮直接匹配屬性，任何潛在的巢狀路徑都不會被考慮，演算法會選擇 qCode 欄位。為了選擇 q 中的 code 欄位，需要使用下劃線表示法 Q_Code。

返回集合或 Iterables 的 Repository 方法

返回多個結果的查詢方法可以使用標準的 Java Iterable、List 和 Set。此外，我們還支援返回 Spring Data 的 Streamable（一個 Iterable 的自定義擴充套件）以及 Vavr 提供的集合型別。請參閱附錄，其中解釋了所有可能的查詢方法返回型別。

使用 Streamable 作為查詢方法的返回型別

你可以使用 Streamable 作為 Iterable 或任何集合型別的替代。它提供了方便的方法來訪問非並行 Stream（Iterable 中沒有）以及直接對元素進行 ….filter(…) 和 ….map(…) 操作並將 Streamable 與其他 Streamable 連線起來的能力。

使用 Streamable 組合查詢方法結果

interface PersonRepository extends Repository<Person, Long> {
  Streamable<Person> findByFirstnameContaining(String firstname);
  Streamable<Person> findByLastnameContaining(String lastname);
}

Streamable<Person> result = repository.findByFirstnameContaining("av")
  .and(repository.findByLastnameContaining("ea"));

返回自定義 Streamable 包裝型別

為集合提供專用的包裝型別是提供返回多個元素的查詢結果 API 的常用模式。通常，這些型別透過呼叫返回集合型別的方法並手動建立包裝型別的例項來使用。你可以避免這個額外的步驟，因為 Spring Data 允許你在這些包裝型別滿足以下條件時將它們用作查詢方法的返回型別

該型別實現了 Streamable 介面。
該型別暴露了一個建構函式或一個名為 of(…) 或 valueOf(…) 的靜態工廠方法，該方法接受 Streamable 作為引數。

以下列表顯示了一個示例

class Product {                                         (1)
  MonetaryAmount getPrice() { … }
}

@RequiredArgsConstructor(staticName = "of")
class Products implements Streamable<Product> {         (2)

  private final Streamable<Product> streamable;

  public MonetaryAmount getTotal() {                    (3)
    return streamable.stream()
      .map(Product::getPrice)
      .reduce(Money.of(0), MonetaryAmount::add);
  }


  @Override
  public Iterator<Product> iterator() {                 (4)
    return streamable.iterator();
  }
}

interface ProductRepository implements Repository<Product, Long> {
  Products findAllByDescriptionContaining(String text); (5)
}

1	一個 `Product` 實體，暴露了訪問產品價格的 API。
2	一個用於 `Streamable<Product>` 的包裝型別，可以使用 `Products.of(…)`（透過 Lombok 註解建立的工廠方法）來構造。一個接受 `Streamable<Product>` 的標準建構函式也可以。
3	該包裝型別暴露了一個額外的 API，用於計算 `Streamable<Product>` 中的新值。
4	實現 `Streamable` 介面並委託給實際結果。
5	該包裝型別 `Products` 可以直接用作查詢方法的返回型別。你不需要返回 `Streamable<Product>` 並在 Repository 客戶端中在查詢後手動包裝它。

對 Vavr Collections 的支援

Vavr 是一個擁抱 Java 函數語言程式設計概念的庫。它附帶了一組自定義的集合型別，你可以將它們用作查詢方法的返回型別，如下表所示

Vavr 集合型別使用的 Vavr 實現型別有效的 Java 源型別

Vavr 集合型別	使用的 Vavr 實現型別	有效的 Java 源型別
`io.vavr.collection.Seq`	`io.vavr.collection.List`	`java.util.Iterable`
`io.vavr.collection.Set`	`io.vavr.collection.LinkedHashSet`	`java.util.Iterable`
`io.vavr.collection.Map`	`io.vavr.collection.LinkedHashMap`	`java.util.Map`

io.vavr.collection.Seq

io.vavr.collection.List

java.util.Iterable

io.vavr.collection.Set

io.vavr.collection.LinkedHashSet

java.util.Iterable

io.vavr.collection.Map

io.vavr.collection.LinkedHashMap

java.util.Map

你可以使用第一列中的型別（或其子型別）作為查詢方法的返回型別，並根據實際查詢結果的 Java 型別（第三列）獲取用作實現型別的第二列中的型別。另外，你可以宣告 Traversable（Vavr 的 Iterable 等效型別），然後我們將從實際返回值派生實現類。也就是說，一個 java.util.List 會被轉換為 Vavr 的 List 或 Seq，一個 java.util.Set 會變成 Vavr 的 LinkedHashSet Set，依此類推。

流式查詢結果

你可以透過使用 Java 8 Stream<T> 作為返回型別來逐步處理查詢方法的結果。資料儲存特定的方法用於執行流式處理，而不是將查詢結果包裝在 Stream 中，如下例所示

使用 Java 8 Stream<T> 流式處理查詢結果

@Query("select u from User u")
Stream<User> findAllByCustomQueryAndStream();

Stream<User> readAllByFirstnameNotNull();

@Query("select u from User u")
Stream<User> streamAllPaged(Pageable pageable);

Stream 可能會包裝底層資料儲存特定的資源，因此在使用後必須關閉。你可以透過使用 close() 方法手動關閉 Stream，或者使用 Java 7 的 try-with-resources 塊，如下例所示

在 try-with-resources 塊中使用 Stream<T> 結果

try (Stream<User> stream = repository.findAllByCustomQueryAndStream()) {
  stream.forEach(…);
}

並非所有 Spring Data 模組目前都支援 Stream<T> 作為返回型別。

非同步查詢結果

你可以使用Spring 的非同步方法執行能力來非同步執行 Repository 查詢。這意味著方法呼叫後會立即返回，而實際的查詢則發生在提交給 Spring TaskExecutor 的任務中。非同步查詢與響應式查詢不同，不應混用。有關響應式支援的更多詳細資訊，請參閱特定儲存的文件。以下示例顯示了一些非同步查詢

@Async
Future<User> findByFirstname(String firstname);               (1)

@Async
CompletableFuture<User> findOneByFirstname(String firstname); (2)

1	使用 `java.util.concurrent.Future` 作為返回型別。
2	使用 Java 8 `java.util.concurrent.CompletableFuture` 作為返回型別。

分頁、遍歷大型結果、排序與限制

要在查詢中處理引數，請定義方法引數，如前面的示例所示。除此之外，基礎設施能夠識別一些特定型別，如 Pageable、Sort 和 Limit，以便動態地為你的查詢應用分頁、排序和限制。以下示例演示了這些特性

在查詢方法中使用 Pageable、Slice、Sort 和 Limit

Page<User> findByLastname(String lastname, Pageable pageable);

Slice<User> findByLastname(String lastname, Pageable pageable);

List<User> findByLastname(String lastname, Sort sort);

List<User> findByLastname(String lastname, Sort sort, Limit limit);

List<User> findByLastname(String lastname, Pageable pageable);

接受 Sort、Pageable 和 Limit 的 API 要求傳入非 null 值。如果你不想應用任何排序或分頁，請使用 Sort.unsorted()、Pageable.unpaged() 和 Limit.unlimited()。

第一個方法允許你將 org.springframework.data.domain.Pageable 例項傳遞給查詢方法，以便動態地為你的靜態定義查詢新增分頁。Page 知道可用的元素總數和總頁數。這是透過基礎設施觸發計數查詢來計算總數實現的。由於這可能開銷較大（取決於使用的儲存），你可以改為返回 Slice。Slice 只知道是否有下一個 Slice 可用，這在遍歷大型結果集時可能已經足夠。

排序選項也透過 Pageable 例項處理。如果你只需要排序，請在你的方法中新增一個 org.springframework.data.domain.Sort 引數。如你所見，返回 List 也是可能的。在這種情況下，構建實際 Page 例項所需的額外元資料不會被建立（這反過來意味著不需要執行額外的計數查詢）。相反，它將查詢限制為只查詢給定範圍的實體。

要找出整個查詢有多少頁，你需要觸發一個額外的計數查詢。預設情況下，此查詢是根據你實際觸發的查詢派生的。

特殊引數在查詢方法中只能使用一次。
上述一些特殊引數是互斥的。請考慮以下無效引數組合列表。

引數示例原因

Pageable 與 Sort

findBy…(Pageable page, Sort sort)

Pageable 已經定義了 Sort

Pageable 與 Limit

findBy…(Pageable page, Limit limit)

Pageable 已經定義了一個限制。

用於限制結果的 Top 關鍵字可以與 Pageable 一起使用，其中 Top 定義了結果的總最大值，而 Pageable 引數可能會減少此數量。

哪種方法是合適的？

Spring Data 抽象提供的價值或許最好地體現在下表中列出的可能查詢方法返回型別。下表顯示了可以從查詢方法返回哪些型別

表 1. 消費大型查詢結果
方法	獲取資料量	查詢結構	限制
`List<T>`	所有結果。	單個查詢。	查詢結果可能耗盡所有記憶體。獲取所有資料可能非常耗時。
`Streamable<T>`	所有結果。	單個查詢。	查詢結果可能耗盡所有記憶體。獲取所有資料可能非常耗時。
`Stream<T>`	分塊（逐個或批次）取決於 `Stream` 的消費方式。	通常使用遊標的單個查詢。	使用後必須關閉 Stream，以避免資源洩露。
`Flux<T>`	分塊（逐個或批次）取決於 `Flux` 的消費方式。	通常使用遊標的單個查詢。	儲存模組必須提供響應式基礎設施。
`Slice<T>`	`Pageable.getOffset()` 處 `Pageable.getPageSize() + 1`	一個或多個查詢，從 `Pageable.getOffset()` 開始獲取資料並應用限制。	`Slice` 只能導航到下一個 `Slice`。 `Slice` 提供是否有更多資料可獲取的詳細資訊。當偏移量過大時，基於偏移量的查詢會變得效率低下，因為資料庫仍然必須物化全部結果。 `Window` 提供是否有更多資料可獲取的詳細資訊。當偏移量過大時，基於偏移量的查詢會變得效率低下，因為資料庫仍然必須物化全部結果。
`Page<T>`	`Pageable.getOffset()` 處 `Pageable.getPageSize()`	一個或多個查詢，從 `Pageable.getOffset()` 開始並應用限制。此外，可能需要 `COUNT(…)` 查詢來確定元素總數。	通常需要執行開銷較大的 `COUNT(…)` 查詢。當偏移量過大時，基於偏移量的查詢會變得效率低下，因為資料庫仍然必須物化全部結果。

分頁與排序

你可以使用屬性名定義簡單的排序表示式。你可以連線表示式將多個條件收集到一個表示式中。

定義排序表示式

Sort sort = Sort.by("firstname").ascending()
  .and(Sort.by("lastname").descending());

對於更型別安全的方式來定義排序表示式，請從要定義排序表示式的型別開始，並使用方法引用來定義用於排序的屬性。

使用型別安全的 API 定義排序表示式

TypedSort<Person> person = Sort.sort(Person.class);

Sort sort = person.by(Person::getFirstname).ascending()
  .and(person.by(Person::getLastname).descending());

TypedSort.by(…) 透過（通常）使用 CGlib 來利用執行時代理，這在使用 Graal VM Native 等工具進行原生映象編譯時可能會產生干擾。

如果你的儲存實現支援 Querydsl，你也可以使用生成的元模型型別來定義排序表示式

使用 Querydsl API 定義排序表示式

QSort sort = QSort.by(QPerson.firstname.asc())
  .and(QSort.by(QPerson.lastname.desc()));

限制查詢結果

除了分頁之外，還可以使用專用的 Limit 引數來限制結果大小。你還可以使用 First 或 Top 關鍵字來限制查詢方法的結果，它們可以互換使用，但不能與 Limit 引數混合使用。你可以在 Top 或 First 後附加一個可選的數值，以指定要返回的最大結果數量。如果省略該數值，則假定結果數量為 1。以下示例展示瞭如何限制查詢大小

使用 Top 和 First 限制查詢結果大小

List<User> findByLastname(String lastname, Limit limit);

User findFirstByOrderByLastnameAsc();

User findTopByLastnameOrderByAgeDesc(String lastname);

Page<User> queryFirst10ByLastname(String lastname, Pageable pageable);

Slice<User> findTop3By(Pageable pageable);

List<User> findFirst10ByLastname(String lastname, Sort sort);

List<User> findTop10ByLastname(String lastname, Pageable pageable);

對於支援 Distinct 查詢的資料儲存，限制表示式也支援 Distinct 關鍵字。此外，對於將結果集限制為一個例項的查詢，支援使用 Optional 關鍵字包裝結果。

如果分頁或分片應用於限制性查詢分頁（以及可用頁數的計算），則它將在限制的結果範圍內應用。

將結果限制與使用 Sort 引數進行的動態排序結合使用，可以讓你表達查詢方法以獲取“K”個最小元素和“K”個最大元素。