定義查詢方法

repository 代理有兩種方法可以從方法名派生出特定於儲存的查詢

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

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

查詢查詢策略

以下策略可用於 repository 基礎設施來解析查詢。對於 XML 配置，你可以透過 query-lookup-strategy 屬性在名稱空間中配置策略。對於 Java 配置，你可以使用 EnableJpaRepositories 註解的 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);
}

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

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

解析方法的實際結果取決於你為其建立查詢的持久化儲存。但是，有一些一般事項需要注意

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

保留方法名

雖然派生的 repository 方法按名稱繫結到屬性，但在涉及到從基本 repository 繼承的某些針對識別符號屬性的方法名時，此規則有一些例外。那些保留方法，例如 CrudRepository#findById（或僅 findById），無論宣告的方法中使用的實際屬性名是什麼，都針對識別符號屬性。因此，它不是使用 id 作為屬性名所暗示的派生查詢，因為它是一個保留方法。

考慮以下域型別，它包含透過 @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	目標是 `pk` 屬性（被標記為 `@Id` 並被視為識別符號的那個），因為它引用了一個 `CrudRepository` 基本 repository 方法。因此，它不是使用 `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。

返回集合或可迭代物件的 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 查詢的資料儲存的 Distinct 關鍵詞。此外，對於將結果集限制為一個例項的查詢，支援使用 Optional 關鍵詞包裝結果。

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

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