定义查询方法

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

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

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

查询查找策略

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

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

查询创建

Spring Data repository 基础设施内置的查询构建器机制对于构建针对 repository 实体限制性查询非常有用。

以下示例展示了如何创建一些查询

从方法名称创建查询

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 来设置要创建的查询的 distinct 标志，或 Top/First 来限制查询结果。

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

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

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

保留的方法名称

虽然派生的 repository 方法按名称绑定到属性，但当涉及到从基础 repository 继承的某些方法名称时，存在一些例外，这些方法名称是针对*标识符*属性的。这些*保留方法*，例如 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` 基础 repository 方法，因此它针对的是 `pk` 属性（使用 `@Id` 标记的属性，被认为是标识符）。因此，它不是一个派生的查询，尽管属性名称 `id` 可能暗示它是，因为它属于保留方法之一。
4	由于它是派生的查询，因此按名称针对 `pk` 属性。
5	通过使用 `find` 和 `by` 之间的描述性标记来避免与保留方法冲突，从而针对 `id` 属性。

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

属性表达式

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

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。

返回集合或可迭代对象的 Repository 方法

返回多个结果的查询方法可以使用标准的 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。通常，这些类型通过调用返回类似集合类型的 repository 方法并手动创建包装器类型的实例来使用。您可以避免这个额外的步骤，因为如果这些包装器类型满足以下条件，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>` 并在 repository 客户端中查询后手动将其包装。

支持 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 的异步方法运行能力异步运行 repository 查询。这意味着方法在调用后立即返回，而实际查询则在提交到 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` 的消费方式。	通常使用游标的单一查询。	使用后必须关闭流，以避免资源泄漏。
`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 查询的数据存储的 Distinct 关键字。此外，对于将结果集限制为单个实例的查询，支持使用 Optional 关键字包装结果。

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

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