按示例查询

简介

本章介绍按示例查询并说明如何使用它。

按示例查询 (QBE) 是一种用户友好的查询技术，具有简单的界面。它允许动态查询创建，不需要编写包含字段名称的查询。事实上，按示例查询根本不需要使用特定于存储的查询语言编写查询。

本章介绍按示例查询的核心概念。这些信息从 Spring Data Commons 模块中提取。根据数据库的不同，字符串匹配支持可能受限。

用法

按示例查询 API 由四部分组成

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

按示例查询非常适合多种用例

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

按示例查询也有一些限制

不支持嵌套或分组属性约束，例如 firstname = ?0 or (firstname = ?1 and lastname = ?2)。
字符串匹配的存储特定支持。根据数据库，字符串匹配可以支持字符串的开始/包含/结束/正则表达式。
其他属性类型的精确匹配。

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

示例人员对象

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 是不可变的。以下列表显示了一个简单的示例

示例 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 期望探测器上设置的所有值都匹配。如果您希望获得与隐式定义的任何谓词匹配的结果，请使用 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` 和属性路径
值转换	属性路径

Fluent 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 定义您获得哪种结果以及当结果数量超过预期时查询的行为。

使用 fluent API 按 lastname 排序，获取潜在的众多结果中的最后一个。

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