定義查詢方法

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

  • 直接從方法名派生查詢。

  • 使用手動定義的查詢。

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

查詢查詢策略

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

  • CREATE 嘗試根據查詢方法名構建特定於儲存的查詢。通用方法是從方法名中移除一組已知的特定字首，並解析方法的其餘部分。您可以在“查詢建立”中瞭解更多關於查詢構建的資訊。

  • USE_DECLARED_QUERY 嘗試查詢已宣告的查詢，如果找不到則丟擲異常。查詢可以透過註解或其他方式定義。請查閱特定儲存的文件以查詢該儲存的可用選項。如果在引導時倉庫基礎設施沒有找到方法的已宣告查詢，則會失敗。

  • CREATE_IF_NOT_FOUND（預設）結合了 CREATE 和 USE_DECLARED_QUERY。它首先查詢已宣告的查詢，如果沒有找到已宣告的查詢，則建立一個基於方法名的自定義查詢。這是預設的查詢策略，因此如果您沒有顯式配置任何內容，就會使用此策略。它允許透過方法名快速定義查詢，同時也可以透過按需引入已宣告的查詢來對這些查詢進行自定義調整。

查詢建立

Spring Data 倉庫基礎設施內建的查詢構建器機制對於在倉庫實體上構建約束查詢非常有用。

以下示例展示瞭如何建立多個查詢

從方法名建立查詢
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 用於在要建立的查詢上設定去重標誌，或者 Top/First 用於限制查詢結果。

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

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

  • 表示式通常是屬性遍歷與可以連線的運算子結合。您可以將屬性表示式與 AND 和 OR 結合使用。屬性表示式還支援 Between, LessThan, GreaterThan 和 Like 等運算子。支援的運算子可能因資料儲存而異，因此請查閱參考文件中相應的部分。

  • 方法解析器支援為單個屬性設定 IgnoreCase 標誌（例如，findByLastnameIgnoreCase(…)），或者為支援忽略大小寫的型別的所有屬性設定 IgnoreCase 標誌（通常是 String 例項——例如，findByLastnameAndFirstnameAllIgnoreCase(…)）。是否支援忽略大小寫可能因儲存而異，因此請查閱參考文件中針對特定儲存查詢方法的相關部分。

  • 您可以透過在引用屬性的查詢方法後附加 OrderBy 子句並提供排序方向（Asc 或 Desc）來應用靜態排序。要建立支援動態排序的查詢方法，請參閱“分頁、迭代大型結果集、排序與限制”。

保留的方法名

雖然派生的倉庫方法透過名稱繫結到屬性，但對於從基礎倉庫繼承的針對*識別符號*屬性的某些方法名，這條規則有一些例外。這些*保留方法*，例如 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 的基礎倉庫方法，所以它針對的是 pk 屬性（即標記有 @Id 的那個，被視為識別符號）。因此，它不是一個使用 id 作為屬性名所暗示的派生查詢，因為它是一個*保留方法*。
4 因為它是一個派生查詢，所以它按名稱針對 pk 屬性。
5 透過使用 find 和 by 之間的描述性標記來針對 id 屬性，以避免與*保留方法*衝突。

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

屬性表示式

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

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。

返回集合或迭代器的倉庫方法

返回多個結果的查詢方法可以使用標準的 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 允許您將這些包裝器型別用作查詢方法的返回型別，前提是它們符合以下條件

  1. 該型別實現了 Streamable 介面。

  2. 該型別公開了一個建構函式或一個名為 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> 並在倉庫客戶端查詢後手動包裝它。

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

您可以使用第一列中的型別（或其子型別）作為查詢方法的返回型別，並根據實際查詢結果的 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 的非同步方法執行能力 來非同步執行倉庫查詢。這意味著方法呼叫後會立即返回，而實際的查詢發生在已提交到 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 關鍵字。此外，對於將結果集限制為單個例項的查詢，支援使用 Optional 關鍵字包裝結果。

如果對限制查詢應用了分頁或切片（以及可用頁數的計算），則它們應用於有限結果集內。

將結果集限制與使用 Sort 引數的動態排序結合使用，可以讓您表達查詢 'K' 個最小元素和 'K' 個最大元素的方法。