查询示例

简介

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

查询示例（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。
其他属性类型的精确匹配。

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

示例 Person 对象

public class Person {

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

  // … getters and setters omitted
}

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

属性是否包含在查询示例条件中是基于可空性的。使用原始类型（int、double 等）的属性始终包含在内，除非 ExampleMatcher 忽略该属性路径。

可以通过使用 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.
}

示例匹配器

示例不限于默认设置。您可以使用 ExampleMatcher 为字符串匹配、空值处理和属性特定设置指定自己的默认值，如以下示例所示

示例 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` 属性路径并包含空值。
6	构造一个新的 `ExampleMatcher` 以忽略 `lastname` 属性路径、包含空值并执行后缀字符串匹配。
7	基于领域对象和配置的 `ExampleMatcher` 创建一个新的 `Example`。

默认情况下，ExampleMatcher 期望 probe 上设置的所有值都匹配。如果您希望获得匹配隐式定义的任何谓词的结果，请使用 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` 设置的范围
设置	作用域
空值处理	`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、slice、stream、count 和 exists 定义了您获得的结果类型以及当结果数量超出预期时查询的行为方式。

使用流式 API 获取可能存在多个结果中的最后一个，按姓氏排序。

Optional<Person> match = repository.findBy(example,
    q -> q
        .sortBy(Sort.by("lastname").descending())
        .first()
);