按示例查詢

介紹

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

按示例查詢（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)。
不支援匹配集合或對映。
特定於儲存的字串匹配支援。根據您的資料庫，字串匹配可能支援字串的 starts/contains/ends/regex。
對其他屬性型別進行精確匹配。

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

人員物件示例

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 忽略了該屬性路徑。

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

示例 1. 簡單示例

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

示例 2. 帶自定義匹配的示例匹配器

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());
}

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

使用 lambdas 配置匹配器選項

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 獲取潛在的多個結果中的最後一個，按 lastname 排序。

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

在 Spring Data JPA 中，您可以將按示例查詢與 Repositories 一起使用，如下例所示

示例 3. 使用 Repository 的按示例查詢

public interface PersonRepository extends JpaRepository<Person, String> { … }

public class PersonService {

  @Autowired PersonRepository personRepository;

  public List<Person> findPeople(Person probe) {
    return personRepository.findAll(Example.of(probe));
  }
}

目前，只有 SingularAttribute 屬性可用於屬性匹配。

屬性指定器接受屬性名稱（例如 firstname 和 lastname）。您可以使用點號（address.city）將屬性連結起來進行導航。您還可以透過匹配選項和大小寫敏感性進行調整。

下表顯示了您可以使用的各種 StringMatcher 選項以及在名為 firstname 的欄位上使用它們的結果

表 2. `StringMatcher` 選項
匹配方式	邏輯結果
`DEFAULT`（區分大小寫）	`firstname = ?0`
`DEFAULT`（不區分大小寫）	`LOWER(firstname) = LOWER(?0)`
`EXACT`（區分大小寫）	`firstname = ?0`
`EXACT`（不區分大小寫）	`LOWER(firstname) = LOWER(?0)`
`STARTING`（區分大小寫）	`firstname like ?0 + '%'`
`STARTING`（不區分大小寫）	`LOWER(firstname) like LOWER(?0) + '%'`
`ENDING`（區分大小寫）	`firstname like '%' + ?0`
`ENDING`（不區分大小寫）	`LOWER(firstname) like '%' + LOWER(?0)`
`CONTAINING`（區分大小寫）	`firstname like '%' + ?0 + '%'`
`CONTAINING`（不區分大小寫）	`LOWER(firstname) like '%' + LOWER(?0) + '%'`

JPA 不支援正則表示式匹配。