按示例查询

引言

本章介绍了按示例查询（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 创建一个接口，如下例所示

示例 Person 对象

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 忽略了该属性路径。

可以使用 of 工厂方法或 ExampleMatcher 来构建 Example。Example 是不可变的。以下列表展示了一个简单的 Example

示例 1. 简单 Example

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

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

1	创建领域对象的新实例。
2	设置要查询的属性。
3	创建 `Example`。

您可以使用 repositories 运行 example 查询。为此，让您的 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 Matchers

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 期望 probe 上设置的所有值都匹配。如果您想获取匹配隐式定义的任何谓词的结果，请使用 ExampleMatcher.matchingAny()。

您可以为单个属性（例如 "firstname" 和 "lastname"，或对于嵌套属性，例如 "address.city"）指定行为。您可以通过匹配选项和大小写敏感性对其进行调整，如下例所示

配置 matcher 选项

ExampleMatcher matcher = ExampleMatcher.matching()
  .withMatcher("firstname", endsWith())
  .withMatcher("lastname", startsWith().ignoreCase());
}

另一种配置 matcher 选项的方法是使用 lambda 表达式（Java 8 中引入）。这种方法创建一个回调，要求实现者修改 matcher。您无需返回 matcher，因为配置选项保存在 matcher 实例中。以下示例显示了一个使用 lambda 表达式的 matcher

使用 lambda 表达式配置 matcher 选项

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