按示例查询

简介

本章介绍按示例查询（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 值的字段会被忽略，字符串使用存储特定的默认值进行匹配。

将属性包含到按示例查询条件中基于其是否为 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 运行示例查询。为此，让您的 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

Examples 不限于默认设置。您可以使用 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()
);