按例查詢

引言

本章介紹了按例查詢（Query by Example）及其使用方法。

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

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

用法

按例查詢 API 由四個部分組成

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

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

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

按例查詢也有幾個限制

不支援巢狀或分組的屬性約束，例如 firstname = ?0 or (firstname = ?1 and lastname = ?2)。
針對特定儲存的字串匹配支援。根據您使用的資料庫，字串匹配可能支援 starts/contains/ends/regex。
其他屬性型別的精確匹配。

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

示例 Person 物件

public class Person {

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

  // … getters and setters omitted
}

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

將屬性包含到按例查詢條件中是基於其 nullability 的。使用原始型別（int, double, …）的屬性總是會被包含，除非 ExampleMatcher 忽略了該屬性路徑。

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

示例 1. 簡單 Example

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

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

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

您可以使用 repository 執行示例查詢。為此，讓您的 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

Example 不限於預設設定。您可以使用 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` 和屬性路徑
值轉換	屬性路徑

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