查询示例

简介

本章介绍了查询示例（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。
对其他属性类型进行精确匹配。

在开始使用查询示例之前，您需要有一个领域对象。要开始使用，请为您的 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。除非 ExampleMatcher 忽略属性路径，否则使用基本类型（int, double 等）的属性总是会被包含。

可以使用 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`。

您可以使用 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 期望 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 派生的查询。然而，通过第二个参数，您可以控制执行的各个方面，这是否则无法动态控制的。您可以通过在第二个参数中调用 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()
);