文档内容来源于 spring.io，由 springdoc.tech 翻译，版权归属于 SPRING.IO (VMware, Inc.)。可供个人学习、研究，未经许可，不得进行转载或用于商业行为。

定义查询方法

DeepSeek V3 中英对照 Defining Query Methods

存储库代理有两种方式从方法名称中派生特定于存储的查询：

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

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

查询查找策略

存储库基础设施可用的查询解析策略如下。通过 XML 配置，你可以在命名空间中使用 query-lookup-strategy 属性来配置策略。对于 Java 配置，你可以使用 EnableJdbcRepositories 注解的 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);
}
java

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

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

解析该方法的结果实际上取决于您为其创建查询的持久化存储。然而，有一些通用的注意事项：

表达式通常是属性遍历与可以连接的运算符的组合。你可以使用 AND 和 OR 来组合属性表达式。你还可以使用诸如 Between、LessThan、GreaterThan 和 Like 等运算符来处理属性表达式。支持的运算符可能因数据存储而异，因此请查阅参考文档的相应部分。
方法解析器支持为各个属性设置 IgnoreCase 标志（例如，findByLastnameIgnoreCase(…)），或者为支持忽略大小写的类型的所有属性设置该标志（通常是 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
}
java

标识符属性（主键）。
一个名为 id 的属性，但不是标识符。
目标为 pk 属性（标记为 @Id 的属性，被视为标识符），因为它引用了一个 CrudRepository 基础仓库方法。因此，它不是使用 id 作为属性名的派生查询，因为它是保留方法之一。
通过名称目标为 pk 属性，因为它是一个派生查询。
通过在 find 和 by 之间使用描述性标记来目标为 id 属性，以避免与保留方法冲突。

这种特殊行为不仅针对查找方法，还适用于 exits 和 delete 方法。请参阅“仓库查询关键字”以获取方法列表。

属性表达式

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

List<Person> findByAddressZipCode(ZipCode zipCode);
java

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

尽管这在大多数情况下应该是有效的，但算法仍有可能选择错误的属性。假设 Person 类也有一个 addressZip 属性。算法在第一次拆分时就会匹配，选择错误的属性，从而导致失败（因为 addressZip 的类型可能没有 code 属性）。

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

List<Person> findByAddress_ZipCode(ZipCode zipCode);
java

备注

由于我们将下划线（_）视为保留字符，因此我们强烈建议遵循标准的 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) {}
java

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

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

返回多个结果的查询方法可以使用标准的 Java Iterable、List 和 Set。除此之外，我们还支持返回 Spring Data 的 Streamable，它是 Iterable 的自定义扩展，以及由 Vavr 提供的集合类型。详细信息请参见附录中解释的所有可能的查询方法返回类型。

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

你可以使用 Streamable 作为 Iterable 或任何集合类型的替代。它提供了便捷的方法来访问非并行的 Stream（这在 Iterable 中是缺失的），并且能够直接对元素进行 ….filter(…) 和 ….map(…) 操作，以及将 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"));
java

返回自定义的可流式包装类型

为集合提供专用的包装器类型是一种常用模式，用于为返回多个元素的查询结果提供 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
}
java

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

对 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`

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

流式查询结果

你可以通过使用 Java 8 的 Stream<T> 作为返回类型来逐步处理查询方法的结果。与将查询结果包装在 Stream 中不同，数据存储特定的方法被用来执行流式处理，如下例所示：

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

Stream<User> readAllByFirstnameNotNull();

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

备注

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

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

备注

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

异步查询结果

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

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

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

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

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

为了在查询中处理参数，可以像前面示例中那样定义方法参数。除此之外，基础设施还识别某些特定类型，如 Pageable、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);
java

important

接收 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 实例所需的额外元数据（这反过来意味着不会发出原本需要的额外计数查询）。相反，它会将查询限制为仅查找给定范围的实体。

备注

要获取整个查询的总页数，您需要触发一个额外的计数查询。默认情况下，该查询是从您实际触发的查询中派生的。

important

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

参数	示例	原因
`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());
java

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

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

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

备注

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

如果你的 store 实现支持 Querydsl，你也可以使用生成的元模型类型来定义排序表达式：

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

限制查询结果

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

List<User> findByLastname(Limit limit);

User findFirstByOrderByLastnameAsc();

User findTopByOrderByAgeDesc();

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

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

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

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

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

如果对限制查询应用分页或切片（以及可用页面数量的计算），它将在有限结果内应用。

备注

通过结合使用 Sort 参数来限制结果并动态排序，您可以表达查询方法以获取最小的 'K' 个元素以及最大的 'K' 个元素。

查询查找策略​

查询创建​

保留方法名称​

属性表达式​

返回集合或可迭代对象的仓库方法​

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

返回自定义的可流式包装类型​

对 Vavr 集合的支持​

流式查询结果​

异步查询结果​

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

哪种方法合适？​

分页与排序​

限制查询结果​