按例查询

引言

本章介绍了按例查询（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()
);