Query by Example

介绍

本章介绍了 Query by Example 并解释了如何使用它。

Query by Example (QBE) 是一种用户友好的查询技术，界面简单。它允许动态创建查询，并且不需要你编写包含字段名称的查询。实际上，Query by Example 完全不需要你使用特定于存储的查询语言来编写查询。

本章解释了 Query by Example 的核心概念。这些信息来自于 Spring Data Commons 模块。根据你的数据库，字符串匹配支持可能会有限。

用法

Query by Example API 包含四个部分

Probe: 填充了字段的领域对象的实际示例。
ExampleMatcher: ExampleMatcher 包含如何匹配特定字段的详细信息。它可以在多个 Example 中重复使用。
Example: 一个 Example 由 Probe 和 ExampleMatcher 组成。它用于创建查询。
FetchableFluentQuery: 一个 FetchableFluentQuery 提供了流畅的 API，允许进一步自定义从 Example 派生的查询。使用流畅的 API 可以为你的查询指定排序、投影和结果处理。

Query by Example 非常适合几种用例

使用一组静态或动态约束查询你的数据存储。
频繁重构领域对象，而无需担心破坏现有查询。
独立于底层数据存储 API 工作。

Query by Example 也有一些限制

不支持嵌套或分组属性约束，例如 firstname = ?0 or (firstname = ?1 and lastname = ?2)。
特定于存储的字符串匹配支持。根据你的数据库，字符串匹配可能支持字符串的 starts/contains/ends/regex。
其他属性类型的精确匹配。

在使用 Query by Example 之前，你需要一个领域对象。首先，为你的 repository 创建一个接口，如下例所示

示例 Person 对象

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

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