定义查询方法

DeepSeek V3 中英对照 Defining Query Methods

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

• 直接从方法名称派生查询。

• 使用手动定义的查询。

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

查询查找策略

以下策略可用于存储库基础设施以解析查询。通过 XML 配置，您可以通过 query-lookup-strategy 属性在命名空间配置策略。对于 Java 配置，您可以使用 EnableElasticsearchRepositories 注解的 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 允许你避免这个额外的步骤，直接将它们用作查询方法的返回类型：

1. 该类型实现了 Streamable 接口。

2. 该类型公开了一个构造函数或一个名为 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.getPageSize() + 1 在 Pageable.getOffset()	一个或多个查询，从 Pageable.getOffset() 开始获取数据并应用限制。	Slice 只能导航到下一个 Slice。 - Slice 提供详细信息以判断是否还有更多数据需要获取。 - 当偏移量过大时，基于偏移量的查询会变得低效，因为数据库仍然需要物化完整的结果。 - Window 提供详细信息以判断是否还有更多数据需要获取。 - 当偏移量过大时，基于偏移量的查询会变得低效，因为数据库仍然需要物化完整的结果。
Page<T>	Pageable.getPageSize() 在 Pageable.getOffset()	一个或多个查询，从 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 等工具进行原生镜像编译时产生干扰。

如果你的商店实现支持 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”个最大元素表达查询方法。