定義查詢方法

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

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

可用的選項取決於實際的儲存。但是，必須有一種策略來決定建立什麼樣的實際查詢。下一節將介紹可用的選項。

查詢查詢策略

Repository 基礎設施可以使用以下策略來解析查詢。透過 XML 配置，您可以在名稱空間上透過 query-lookup-strategy 屬性配置策略。對於 Java 配置，您可以使用 EnableElasticsearchRepositories 註解的 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 之間的任何文字都被認為是描述性的，除非使用 Top/First 來限制查詢結果等結果限制關鍵字（例如使用 Distinct 為要建立的查詢設定去重標誌）。

附錄包含查詢方法主體關鍵字的完整列表以及查詢方法謂詞關鍵字，包括排序和字母大小寫修飾符。但是，第一個 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` 屬性。

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

屬性表示式

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

List<Person> findByAddressZipCode(ZipCode zipCode);

假設一個 Person 有一個 Address，該 Address 有一個 ZipCode。在這種情況下，該方法會建立 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。

返回 Collection 或 Iterable 的 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 集合的支援

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` 消費。	通常使用遊標進行單次查詢。	使用後必須關閉流以避免資源洩露。
`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 關鍵字。此外，對於將結果集限制為一個例項的查詢，支援使用 Optional 關鍵字包裝結果。

如果對限制查詢應用了分頁或切片分頁（以及可用頁數的計算），則會在限制結果範圍內應用。

透過使用 Sort 引數將結果限制與動態排序相結合，可以表達用於查詢“K”個最小元素和“K”個最大元素的方法。