按示例查詢

簡介

本章介紹了按示例查詢 (Query by Example) 並解釋瞭如何使用它。

按示例查詢 (QBE) 是一種使用者友好的查詢技術，介面簡單。它允許動態建立查詢，並且不需要您編寫包含欄位名稱的查詢。實際上，按示例查詢根本不需要您使用特定於儲存的查詢語言來編寫查詢。

本章解釋了按示例查詢的核心概念。這些資訊來源於 Spring Data Commons 模組。根據您使用的資料庫，字串匹配支援可能受到限制。

使用方法

按示例查詢 API 包含四個部分

探針 (Probe)：填充了欄位的域物件的實際示例。
ExampleMatcher：ExampleMatcher 包含如何匹配特定欄位的詳細資訊。它可以在多個 Example 中重用。
Example：一個 Example 由探針和 ExampleMatcher 組成。它用於建立查詢。
FetchableFluentQuery：一個 FetchableFluentQuery 提供了一個流暢的 API，允許進一步定製從 Example 派生的查詢。使用流暢的 API 可以指定查詢結果的排序、投影和結果處理方式。

按示例查詢非常適用於以下幾種用例

使用一組靜態或動態約束查詢您的資料儲存。
頻繁重構域物件，而無需擔心破壞現有查詢。
獨立於底層資料儲存 API 工作。

按示例查詢也存在一些限制

不支援巢狀或分組屬性約束，例如 firstname = ?0 or (firstname = ?1 and lastname = ?2)。
字串匹配的特定於儲存的支援。根據您的資料庫，字串匹配可能支援字串的開頭匹配、包含匹配、結尾匹配或正則表示式匹配。
其他屬性型別的精確匹配。

在使用按示例查詢之前，您需要有一個域物件。要開始使用，請為您的 repository 建立一個介面，如下例所示

Person 物件示例

public class Person {

  @Id
  private String id;
  private String firstname;
  private String lastname;
  private Address address;

  // … getters and setters omitted
}

前面的例子展示了一個簡單的域物件。您可以使用它來建立一個 Example。預設情況下，具有 null 值的欄位會被忽略，字串則使用特定於儲存的預設方式進行匹配。

將屬性包含到按示例查詢條件中是基於其是否為 null。原始型別 (int, double, …) 的屬性始終包含在內，除非 ExampleMatcher 忽略了該屬性路徑。

可以透過使用 of 工廠方法或 ExampleMatcher 來構建 Examples。Example 是不可變的。以下列表展示了一個簡單的 Example

示例 1. 簡單 Example

Person person = new Person();                         (1)
person.setFirstname("Dave");                          (2)

Example<Person> example = Example.of(person);         (3)

1	建立域物件的新例項。
2	設定要查詢的屬性。
3	建立 `Example`。

您可以使用 repositories 執行示例查詢。為此，讓您的 repository 介面擴充套件 QueryByExampleExecutor<T>。以下列表展示了 QueryByExampleExecutor 介面的摘錄

QueryByExampleExecutor

public interface QueryByExampleExecutor<T> {

  <S extends T> S findOne(Example<S> example);

  <S extends T> Iterable<S> findAll(Example<S> example);

  // … more functionality omitted.
}

Example Matcher

Examples 不限於預設設定。您可以使用 ExampleMatcher 指定自己的字串匹配、null 處理和特定於屬性的設定預設值，如下例所示

示例 2. 自定義匹配的 Example Matcher

Person person = new Person();                          (1)
person.setFirstname("Dave");                           (2)

ExampleMatcher matcher = ExampleMatcher.matching()     (3)
  .withIgnorePaths("lastname")                         (4)
  .withIncludeNullValues()                             (5)
  .withStringMatcher(StringMatcher.ENDING);            (6)

Example<Person> example = Example.of(person, matcher); (7)

1	建立域物件的新例項。
2	設定屬性。
3	建立一個 `ExampleMatcher`，期望所有值都匹配。即使沒有進一步配置，此階段也可使用它。
4	構建一個新的 `ExampleMatcher`，忽略 `lastname` 屬性路徑。
5	構建一個新的 `ExampleMatcher`，忽略 `lastname` 屬性路徑幷包含 null 值。
6	構建一個新的 `ExampleMatcher`，忽略 `lastname` 屬性路徑，包含 null 值，並執行字尾字串匹配。
7	基於域物件和配置的 `ExampleMatcher` 建立新的 `Example`。

預設情況下，ExampleMatcher 期望探針上設定的所有值都匹配。如果您想獲取匹配隱式定義的任何謂詞的結果，請使用 ExampleMatcher.matchingAny()。

您可以指定各個屬性（例如“firstname”和“lastname”，或巢狀屬性的“address.city”）的行為。您可以使用匹配選項和大小寫敏感性進行調整，如下例所示

配置匹配器選項

ExampleMatcher matcher = ExampleMatcher.matching()
  .withMatcher("firstname", endsWith())
  .withMatcher("lastname", startsWith().ignoreCase());
}

配置匹配器選項的另一種方法是使用 Lambda 表示式（Java 8 引入）。這種方法建立了一個回撥，要求實現者修改匹配器。您無需返回匹配器，因為配置選項儲存在匹配器例項中。以下示例展示了一個使用 Lambda 表示式的匹配器

使用 Lambda 表示式配置匹配器選項

ExampleMatcher matcher = ExampleMatcher.matching()
  .withMatcher("firstname", match -> match.endsWith())
  .withMatcher("firstname", match -> match.startsWith());
}

透過 Example 建立的查詢使用了配置的合併檢視。預設匹配設定可以在 ExampleMatcher 級別設定，而單獨的設定可以應用於特定的屬性路徑。在 ExampleMatcher 上設定的設定會被屬性路徑設定繼承，除非它們被明確定義。屬性路徑上的設定優先於預設設定。下表描述了各種 ExampleMatcher 設定的作用範圍

表 1. `ExampleMatcher` 設定的作用範圍
設定	範圍
Null 處理	`ExampleMatcher`
字串匹配	`ExampleMatcher` 和屬性路徑
忽略屬性	屬性路徑
大小寫敏感性	`ExampleMatcher` 和屬性路徑
值轉換	屬性路徑

流暢 API

QueryByExampleExecutor 提供了另一個我們之前沒有提到的方法：<S extends T, R> R findBy(Example<S> example, Function<FluentQuery.FetchableFluentQuery<S>, R> queryFunction)。與其他方法一樣，它執行從 Example 派生的查詢。然而，透過第二個引數，您可以控制該執行的某些方面，這些方面否則無法動態控制。您可以透過在第二個引數中呼叫 FetchableFluentQuery 的各種方法來實現這一點。sortBy 允許您指定結果的排序。as 允許您指定希望結果轉換成的型別。project 限制查詢的屬性。first、firstValue、one、oneValue、all、page、stream、count 和 exists 定義了您獲得的結果型別，以及當結果數量超出預期時查詢的行為方式。

使用流暢 API 獲取可能存在的多個結果中按姓氏排序的最後一個結果。

Optional<Person> match = repository.findBy(example,
    q -> q
        .sortBy(Sort.by("lastname").descending())
        .first()
);