示例查询

引言

本章介绍了示例查询（Query by Example）并解释了如何使用它。

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

本章解释了示例查询（Query by Example）的核心概念。这些信息来源于 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。
对其他属性类型进行精确匹配。

在开始使用示例查询（Query by Example）之前，您需要有一个领域对象。要开始，请为您的仓库（repository）创建一个接口，如下面的示例所示

人员对象示例

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）条件中取决于其是否为 null。使用原始类型（int、double 等）的属性总是被包含，除非 ExampleMatcher 忽略了该属性路径。

Examples 可以通过 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。

您可以使用仓库来运行示例查询。为此，让您的仓库接口继承 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.
}

示例匹配器

Examples 不限于默认设置。您可以使用 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 期望 probe 上设置的所有值都匹配。如果您希望获取与隐式定义的任何谓词匹配的结果，请使用 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()
);