定义查询方法

仓库代理有两种方法可以从方法名派生出特定于存储的查询

直接从方法名派生查询。
使用手动定义的查询。

可用选项取决于实际的存储。但是，必须有一种策略来决定创建什么样的实际查询。下一节描述了可用的选项。

查询查找策略

仓库基础设施可以使用以下策略来解析查询。使用 XML 配置时，可以通过命名空间中的 query-lookup-strategy 属性配置策略。对于 Java 配置，可以使用 EnableJpaRepositories 注解的 queryLookupStrategy 属性。某些策略可能不支持特定的数据存储。

CREATE 尝试根据查询方法名构建特定于存储的查询。通用方法是从方法名中移除一组已知的特定前缀，并解析方法的其余部分。您可以在“查询创建”中了解更多关于查询构建的信息。
USE_DECLARED_QUERY 尝试查找已声明的查询，如果找不到则抛出异常。查询可以通过注解或其他方式定义。请查阅特定存储的文档以查找该存储的可用选项。如果在引导时仓库基础设施没有找到方法的已声明查询，则会失败。
CREATE_IF_NOT_FOUND（默认）结合了 CREATE 和 USE_DECLARED_QUERY。它首先查找已声明的查询，如果没有找到已声明的查询，则创建一个基于方法名的自定义查询。这是默认的查找策略，因此如果您没有显式配置任何内容，就会使用此策略。它允许通过方法名快速定义查询，同时也可以通过按需引入已声明的查询来对这些查询进行自定义调整。

查询创建

Spring Data 仓库基础设施内置的查询构建器机制对于在仓库实体上构建约束查询非常有用。

以下示例展示了如何创建多个查询

从方法名创建查询

interface PersonRepository extends Repository<Person, Long> {

  List<Person> findByEmailAddressAndLastname(EmailAddress emailAddress, String lastname);

  // Enables the distinct flag for the query
  List<Person> findDistinctPeopleByLastnameOrFirstname(String lastname, String firstname);
  List<Person> findPeopleDistinctByLastnameOrFirstname(String lastname, String firstname);

  // Enabling ignoring case for an individual property
  List<Person> findByLastnameIgnoreCase(String lastname);
  // Enabling ignoring case for all suitable properties
  List<Person> findByLastnameAndFirstnameAllIgnoreCase(String lastname, String firstname);

  // Enabling static ORDER BY for a query
  List<Person> findByLastnameOrderByFirstnameAsc(String lastname);
  List<Person> findByLastnameOrderByFirstnameDesc(String lastname);
}

解析查询方法名分为主题和谓语。第一部分 (find…By, exists…By) 定义查询的主题，第二部分构成谓语。引入子句（主题）可以包含进一步的表达式。在 find（或其他引入关键字）和 By 之间的任何文本都被认为是描述性的，除非使用了结果限制关键字，例如 Distinct 用于在要创建的查询上设置去重标志，或者 Top/First 用于限制查询结果。

附录包含完整的查询方法主题关键字列表以及查询方法谓语关键字，包括排序和字母大小写修饰符。然而，第一个 By 作为分隔符，指示实际条件谓语的开始。在非常基本的层面，您可以定义实体属性上的条件，并使用 And 和 Or 将它们连接起来。

解析方法的实际结果取决于您创建查询的持久化存储。但是，有一些通用的注意事项

表达式通常是属性遍历与可以连接的运算符结合。您可以将属性表达式与 AND 和 OR 结合使用。属性表达式还支持 Between, LessThan, GreaterThan 和 Like 等运算符。支持的运算符可能因数据存储而异，因此请查阅参考文档中相应的部分。
方法解析器支持为单个属性设置 IgnoreCase 标志（例如，findByLastnameIgnoreCase(…)），或者为支持忽略大小写的类型的所有属性设置 IgnoreCase 标志（通常是 String 实例——例如，findByLastnameAndFirstnameAllIgnoreCase(…)）。是否支持忽略大小写可能因存储而异，因此请查阅参考文档中针对特定存储查询方法的相关部分。
您可以通过在引用属性的查询方法后附加 OrderBy 子句并提供排序方向（Asc 或 Desc）来应用静态排序。要创建支持动态排序的查询方法，请参阅“分页、迭代大型结果集、排序与限制”。

保留的方法名

虽然派生的仓库方法通过名称绑定到属性，但对于从基础仓库继承的针对*标识符*属性的某些方法名，这条规则有一些例外。这些*保留方法*，例如 CrudRepository#findById（或仅 findById），无论声明方法中使用的实际属性名称是什么，它们都针对*标识符*属性。

考虑以下域类型，它包含一个通过 @Id 标记为标识符的属性 pk 和一个名为 id 的属性。在这种情况下，您需要密切注意查找方法的命名，因为它们可能与预定义签名冲突

class User {
  @Id Long pk;                          (1)

  Long id;                              (2)

  // …
}

interface UserRepository extends Repository<User, Long> {

  Optional<User> findById(Long id);     (3)

  Optional<User> findByPk(Long pk);     (4)

  Optional<User> findUserById(Long id); (5)
}

1	标识符属性（主键）。
2	一个名为 `id` 的属性，但不是标识符。
3	因为它引用了 `CrudRepository` 的基础仓库方法，所以它针对的是 `pk` 属性（即标记有 `@Id` 的那个，被视为标识符）。因此，它不是一个使用 `id` 作为属性名所暗示的派生查询，因为它是一个保留方法。
4	因为它是一个派生查询，所以它按名称针对 `pk` 属性。
5	通过使用 `find` 和 `by` 之间的描述性标记来针对 `id` 属性，以避免与保留方法冲突。

这种特殊行为不仅适用于查找方法，也适用于 exists 和 delete 方法。有关方法列表，请参阅“仓库查询关键字”。

属性表达式

属性表达式只能引用受管实体的直接属性，如前面的示例所示。在查询创建时，您就已经确保解析的属性是受管域类的属性。但是，您也可以通过遍历嵌套属性来定义约束。考虑以下方法签名

List<Person> findByAddressZipCode(ZipCode zipCode);

假设一个 Person 有一个带 ZipCode 的 Address。在这种情况下，该方法创建 x.address.zipCode 属性遍历。解析算法首先将整个部分 (AddressZipCode) 解释为属性，并检查域类中是否存在以此名称（未首字母大写）命名的属性。如果算法成功，则使用该属性。如果失败，算法将从右侧开始按驼峰命名部分将源字符串拆分为头部和尾部，并尝试查找对应的属性——在我们的示例中是 AddressZip 和 Code。如果算法找到一个以该头部命名的属性，则取尾部并从那里继续构建树，以刚描述的方式拆分尾部。如果第一次拆分不匹配，算法将拆分点向左移动 (Address, ZipCode) 并继续。

虽然这适用于大多数情况，但算法有可能选择了错误的属性。假设 Person 类还有一个 addressZip 属性。算法在第一次拆分时就会匹配到，选择了错误的属性，然后失败（因为 addressZip 的类型可能没有 code 属性）。

为了解决这种歧义，您可以在方法名中使用 _ 手动定义遍历点。因此我们的方法名将如下所示

List<Person> findByAddress_ZipCode(ZipCode zipCode);

因为我们将下划线 (_) 视为保留字符，所以强烈建议遵循标准的 Java 命名约定（即不在属性名中使用下划线，而是使用驼峰命名）。

以下划线开头的字段名

字段名可以以下划线开头，例如 String _name。请确保保留 _，例如在 _name 中，并使用双下划线 __ 来分隔嵌套路径，例如 user__name。

大写字段名

全大写的字段名可以照常使用。如果适用嵌套路径，则需要通过 _ 进行分隔，例如 USER_name。

第二个字母大写的字段名

由一个开头小写字母后跟一个大写字母组成的字段名，例如 String qCode，可以通过以两个大写字母开头来解析，例如 QCode。请注意潜在的路径歧义。

路径歧义

在以下示例中，属性 qCode 和 q 的排列方式，其中 q 包含一个名为 code 的属性，为路径 QCode 创建了歧义。

record Container(String qCode, Code q) {}
record Code(String code) {}

由于优先考虑直接匹配属性，因此任何潜在的嵌套路径都不会被考虑，算法将选择 qCode 字段。为了选择 q 中的 code 字段，需要使用下划线表示法 Q_Code。

返回集合或迭代器的仓库方法

返回多个结果的查询方法可以使用标准的 Java Iterable, List 和 Set。此外，我们还支持返回 Spring Data 的 Streamable（Iterable 的自定义扩展）以及 Vavr 提供的集合类型。请参阅附录，了解所有可能的查询方法返回类型。

使用 Streamable 作为查询方法返回类型

您可以使用 Streamable 作为 Iterable 或任何集合类型的替代。它提供了便捷方法来访问非并行 Stream（Iterable 中缺失）以及直接对元素进行 ….filter(…) 和 ….map(…) 操作并将 Streamable 与其他 Streamable 连接起来的能力。

使用 Streamable 组合查询方法结果

interface PersonRepository extends Repository<Person, Long> {
  Streamable<Person> findByFirstnameContaining(String firstname);
  Streamable<Person> findByLastnameContaining(String lastname);
}

Streamable<Person> result = repository.findByFirstnameContaining("av")
  .and(repository.findByLastnameContaining("ea"));

返回自定义 Streamable 包装器类型

为集合提供专门的包装器类型是一种常用模式，用于为返回多个元素的查询结果提供 API。通常，使用这些类型的方法是调用返回集合类型数据的仓库方法，然后手动创建包装器类型的实例。您可以避免这个额外的步骤，因为 Spring Data 允许您将这些包装器类型用作查询方法的返回类型，前提是它们符合以下条件

该类型实现了 Streamable 接口。
该类型公开了一个构造函数或一个名为 of(…) 或 valueOf(…) 的静态工厂方法，该方法接受 Streamable 作为参数。

以下列表展示了一个示例

class Product {                                         (1)
  MonetaryAmount getPrice() { … }
}

@RequiredArgsConstructor(staticName = "of")
class Products implements Streamable<Product> {         (2)

  private final Streamable<Product> streamable;

  public MonetaryAmount getTotal() {                    (3)
    return streamable.stream()
      .map(Product::getPrice)
      .reduce(Money.of(0), MonetaryAmount::add);
  }


  @Override
  public Iterator<Product> iterator() {                 (4)
    return streamable.iterator();
  }
}

interface ProductRepository implements Repository<Product, Long> {
  Products findAllByDescriptionContaining(String text); (5)
}

1	一个 `Product` 实体，提供了访问产品价格的 API。
2	一个用于 `Streamable<Product>` 的包装器类型，可以通过 `Products.of(…)`（使用 Lombok 注解创建的工厂方法）构建。接受 `Streamable<Product>` 的标准构造函数也可以。
3	该包装器类型提供了额外的 API，用于在 `Streamable<Product>` 上计算新值。
4	实现 `Streamable` 接口并委托给实际结果。
5	该包装器类型 `Products` 可以直接用作查询方法的返回类型。您无需返回 `Streamable<Product>` 并在仓库客户端查询后手动包装它。

Vavr 集合支持

Vavr 是一个在 Java 中支持函数式编程概念的库。它带有一组自定义的集合类型，您可以将它们用作查询方法的返回类型，如下表所示

Vavr 集合类型使用的 Vavr 实现类型有效的 Java 源类型

Vavr 集合类型	使用的 Vavr 实现类型	有效的 Java 源类型
`io.vavr.collection.Seq`	`io.vavr.collection.List`	`java.util.Iterable`
`io.vavr.collection.Set`	`io.vavr.collection.LinkedHashSet`	`java.util.Iterable`
`io.vavr.collection.Map`	`io.vavr.collection.LinkedHashMap`	`java.util.Map`

io.vavr.collection.Seq

io.vavr.collection.List

java.util.Iterable

io.vavr.collection.Set

io.vavr.collection.LinkedHashSet

java.util.Iterable

io.vavr.collection.Map

io.vavr.collection.LinkedHashMap

java.util.Map

您可以使用第一列中的类型（或其子类型）作为查询方法的返回类型，并根据实际查询结果的 Java 类型（第三列）获得第二列中用作实现类型的类型。或者，您可以声明 Traversable（相当于 Vavr 的 Iterable），然后我们从实际返回值派生出实现类。也就是说，java.util.List 将转换为 Vavr List 或 Seq，java.util.Set 变为 Vavr LinkedHashSet Set，依此类推。

流式处理查询结果

您可以使用 Java 8 的 Stream<T> 作为返回类型来增量处理查询方法的结果。不是将查询结果包装在 Stream 中，而是使用数据存储特定的方法来执行流式处理，如下例所示

使用 Java 8 Stream<T> 流式处理查询结果

@Query("select u from User u")
Stream<User> findAllByCustomQueryAndStream();

Stream<User> readAllByFirstnameNotNull();

@Query("select u from User u")
Stream<User> streamAllPaged(Pageable pageable);

Stream 可能包装了底层数据存储特定的资源，因此在使用后必须关闭。您可以通过使用 close() 方法手动关闭 Stream，或者使用 Java 7 的 try-with-resources 块，如下例所示

在 try-with-resources 块中使用 Stream<T> 结果

try (Stream<User> stream = repository.findAllByCustomQueryAndStream()) {
  stream.forEach(…);
}

并非所有 Spring Data 模块目前都支持使用 Stream<T> 作为返回类型。

异步查询结果

您可以使用 Spring 的异步方法运行能力来异步运行仓库查询。这意味着方法调用后会立即返回，而实际的查询发生在已提交到 Spring TaskExecutor 的任务中。异步查询与响应式查询不同，不应混用。有关响应式支持的更多详细信息，请参阅特定存储的文档。以下示例展示了几个异步查询

@Async
Future<User> findByFirstname(String firstname);               (1)

@Async
CompletableFuture<User> findOneByFirstname(String firstname); (2)

1	使用 `java.util.concurrent.Future` 作为返回类型。
2	使用 Java 8 的 `java.util.concurrent.CompletableFuture` 作为返回类型。

分页、迭代大型结果集、排序与限制

要在查询中处理参数，请定义方法参数，如前面示例所示。除此之外，基础设施还可以识别某些特定类型，例如 Pageable, Sort 和 Limit，以便动态地将分页、排序和限制应用于您的查询。以下示例演示了这些特性

在查询方法中使用 Pageable, Slice, Sort 和 Limit

Page<User> findByLastname(String lastname, Pageable pageable);

Slice<User> findByLastname(String lastname, Pageable pageable);

List<User> findByLastname(String lastname, Sort sort);

List<User> findByLastname(String lastname, Sort sort, Limit limit);

List<User> findByLastname(String lastname, Pageable pageable);

接受 Sort, Pageable 和 Limit 的 API 要求传递非 null 值给方法。如果您不想应用任何排序或分页，请使用 Sort.unsorted(), Pageable.unpaged() 和 Limit.unlimited()。

第一个方法允许您将 org.springframework.data.domain.Pageable 实例传递给查询方法，以便动态地为您的静态定义查询添加分页。Page 知道总元素数和可用的总页数。这是通过基础设施触发一个计数查询来计算总数实现的。由于这可能很耗时（取决于所使用的存储），您可以改为返回 Slice。Slice 只知道是否有下一个 Slice 可用，这在遍历大型结果集时可能足够了。

排序选项也通过 Pageable 实例处理。如果您只需要排序，请为您的方法添加一个 org.springframework.data.domain.Sort 参数。正如您所见，返回 List 也是可能的。在这种情况下，不会创建构建实际 Page 实例所需的额外元数据（这意味着，本来必要的额外计数查询也不会发出）。相反，它将查询限制为仅查找给定范围内的实体。

要了解整个查询有多少页，您必须触发一个额外的计数查询。默认情况下，此查询是从您实际触发的查询派生出来的。

特殊参数在查询方法中只能使用一次。
上述一些特殊参数是互斥的。请考虑以下无效参数组合列表。

参数示例原因

Pageable 和 Sort

findBy…(Pageable page, Sort sort)

Pageable 已定义 Sort

Pageable 和 Limit

findBy…(Pageable page, Limit limit)

Pageable 已定义了限制。

用于限制结果的 Top 关键字可以与 Pageable 一起使用，其中 Top 定义了总结果的最大数量，而 Pageable 参数可能会减少这个数量。

哪种方法合适？

Spring Data 抽象提供的价值或许最好地体现在下表列出的可能的查询方法返回类型中。下表显示了您可以从查询方法返回哪些类型

表 1. 消费大型查询结果
方法	获取的数据量	查询结构	约束
`List<T>`	所有结果。	单个查询。	查询结果可能耗尽所有内存。获取所有数据可能非常耗时。
`Streamable<T>`	所有结果。	单个查询。	查询结果可能耗尽所有内存。获取所有数据可能非常耗时。
`Stream<T>`	分块（按需逐个或批量），取决于 `Stream` 的消费方式。	通常使用游标的单个查询。	使用后必须关闭 Stream，以避免资源泄漏。
`Flux<T>`	分块（按需逐个或批量），取决于 `Flux` 的消费方式。	通常使用游标的单个查询。	存储模块必须提供响应式基础设施。
`Slice<T>`	`Pageable.getOffset()` 处的 `Pageable.getPageSize() + 1`	从 `Pageable.getOffset()` 开始获取数据并应用限制的单到多条查询。	`Slice` 只能导航到下一个 `Slice`。 `Slice` 提供了是否有更多数据可获取的详细信息。当偏移量过大时，基于偏移量的查询效率会降低，因为数据库仍然必须具体化全部结果。 `Window` 提供了是否有更多数据可获取的详细信息。当偏移量过大时，基于偏移量的查询效率会降低，因为数据库仍然必须具体化全部结果。
`Page<T>`	`Pageable.getOffset()` 处的 `Pageable.getPageSize()`	从 `Pageable.getOffset()` 开始获取数据并应用限制的单到多条查询。此外，可能需要 `COUNT(…)` 查询来确定总元素数。	通常需要 `COUNT(…)` 查询，这成本较高。当偏移量过大时，基于偏移量的查询效率会降低，因为数据库仍然必须具体化全部结果。

分页和排序

您可以使用属性名称定义简单的排序表达式。您可以连接表达式将多个条件组合到一个表达式中。

定义排序表达式

Sort sort = Sort.by("firstname").ascending()
  .and(Sort.by("lastname").descending());

为了更类型安全地定义排序表达式，请从要定义排序表达式的类型开始，并使用方法引用来定义要排序的属性。

使用类型安全 API 定义排序表达式

TypedSort<Person> person = Sort.sort(Person.class);

Sort sort = person.by(Person::getFirstname).ascending()
  .and(person.by(Person::getLastname).descending());

TypedSort.by(…)（通常）使用 CGlib 利用运行时代理，这在使用 Graal VM Native 等工具进行原生镜像编译时可能会产生干扰。

如果您的存储实现支持 Querydsl，您还可以使用生成的元模型类型来定义排序表达式

使用 Querydsl API 定义排序表达式

QSort sort = QSort.by(QPerson.firstname.asc())
  .and(QSort.by(QPerson.lastname.desc()));

限制查询结果

除了分页，还可以使用专用的 Limit 参数限制结果集大小。您还可以使用 First 或 Top 关键字限制查询方法的结果，这两个关键字可以互换使用，但不能与 Limit 参数混用。您可以在 Top 或 First 后附加一个可选的数值来指定返回的最大结果集大小。如果省略该数值，则假定结果集大小为 1。以下示例展示了如何限制查询大小

使用 Top 和 First 限制查询结果集大小

List<User> findByLastname(String lastname, Limit limit);

User findFirstByOrderByLastnameAsc();

User findTopByLastnameOrderByAgeDesc(String lastname);

Page<User> queryFirst10ByLastname(String lastname, Pageable pageable);

Slice<User> findTop3By(Pageable pageable);

List<User> findFirst10ByLastname(String lastname, Sort sort);

List<User> findTop10ByLastname(String lastname, Pageable pageable);

限制表达式也支持支持去重查询的数据存储的 Distinct 关键字。此外，对于将结果集限制为单个实例的查询，支持使用 Optional 关键字包装结果。

如果对限制查询应用了分页或切片（以及可用页数的计算），则它们应用于有限结果集内。

将结果集限制与使用 Sort 参数的动态排序结合使用，可以让您表达查询 'K' 个最小元素和 'K' 个最大元素的方法。