Query by Example

引言

本章介绍了 Query by Example 并解释了如何使用它。

Query by Example (QBE) 是一种用户友好的查询技术，接口简单。它允许动态创建查询，并且不需要您编写包含字段名称的查询。实际上，Query by Example 完全不需要您使用特定于存储的查询语言来编写查询。

本章解释了 Query by Example 的核心概念。信息来自 Spring Data Commons 模块。取决于您的数据库，字符串匹配的支持可能有限。

用法

Query by Example API 由四部分组成

Probe（探测对象）：一个填充了字段的实际域对象示例。
ExampleMatcher（示例匹配器）：ExampleMatcher 包含如何匹配特定字段的详细信息。它可以在多个 Example 中重复使用。
Example（示例）：一个 Example 由探测对象和 ExampleMatcher 组成。它用于创建查询。
FetchableFluentQuery：FetchableFluentQuery 提供了一种流畅的 API，允许进一步自定义从 Example 派生的查询。使用流畅 API 可以为您的查询指定排序、投影和结果处理。

Query by Example 非常适用于以下几种用例

使用一组静态或动态约束查询您的数据存储。
频繁重构域对象，而无需担心破坏现有查询。
独立于底层数据存储 API 工作。

Query by Example 也有一些限制

不支持嵌套或分组的属性约束，例如 firstname = ?0 or (firstname = ?1 and lastname = ?2)。
对字符串匹配的特定于存储的支持。取决于您的数据库，字符串匹配可能支持字符串的 starts/contains/ends/regex。
对其他属性类型的精确匹配。

在开始使用 Query by Example 之前，您需要有一个域对象。要开始使用，请为您的 Repository 创建一个接口，如下例所示

Person 对象示例

public class Person {

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

  // … getters and setters omitted
}

前面的示例展示了一个简单的域对象。您可以使用它来创建一个 Example。默认情况下，忽略具有 null 值的字段，并使用特定于存储的默认设置匹配字符串。

将属性包含到 Query by Example 标准中是基于 nullability 的。原始类型（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`。

您可以使用 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` 和属性路径
值转换	属性路径

流畅 API

QueryByExampleExecutor 提供了另一个我们之前没有提到的方法：<S extends T, R> R findBy(Example<S> example, Function<FluentQuery.FetchableFluentQuery<S>, R> queryFunction)。与其它方法一样，它执行从 Example 派生的查询。然而，通过第二个参数，您可以控制该执行中 otherwise 无法动态控制的方面。您可以通过在第二个参数中调用 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()
);