跳到主要内容

定义查询方法

ChatGPT-4o-mini 中英对照 Defining Query Methods

该存储库代理有两种方法可以根据方法名称推导出特定于存储的查询：

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

  • 通过使用手动定义的查询。

可用的选项取决于实际的商店。然而，必须有一个策略来决定创建实际查询的方式。下一部分将描述可用的选项。

查询查找策略​

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

  • CREATE 尝试从查询方法名称构造特定于存储的查询。一般方法是去除方法名称中已知的前缀，并解析方法的其余部分。你可以在 “Query Creation” 中阅读更多关于查询构造的内容。

  • 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）。要创建支持动态排序的查询方法，请参见 “Paging, Iterating Large Results, Sorting & Limiting”。

保留的方法名称​

虽然派生的仓库方法通过名称绑定到属性，但对于一些从基仓库继承的方法，在涉及到标识符属性时，这条规则有一些例外。那些保留方法，如 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 方法。有关方法列表，请参阅 “Repository query keywords”。

属性表达式​

属性表达式只能引用托管实体的

List<Person> findByAddressZipCode(ZipCode zipCode);
java

假设一个 Person 拥有一个 Address，其中包含一个 ZipCode。在这种情况下，该方法创建 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 连接到其他集合：

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.Seqio.vavr.collection.Listjava.util.Iterable
io.vavr.collection.Setio.vavr.collection.LinkedHashSetjava.util.Iterable
io.vavr.collection.Mapio.vavr.collection.LinkedHashMapjava.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 和 SortfindBy…​(Pageable page, Sort sort)Pageable 已经定义了 Sort
Pageable 和 LimitfindBy…​(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 等工具进行原生镜像编译时产生冲突。

如果您的存储实现支持 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' 个最大元素。