跳到主要内容

定义查询方法

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

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

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

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

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

查询查找策略​

以下策略可用于存储库基础设施以解析查询。通过 XML 配置，您可以通过 query-lookup-strategy 属性在命名空间中配置策略。对于 Java 配置，您可以使用 EnableCouchbaseRepositories 注解的 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 等运算符来处理属性表达式。支持的运算符可能因数据存储而异，因此请查阅您参考文档中的相关部分。

  • 方法解析器支持为单个属性（例如，findByLastnameIgnoreCase(…)）或为所有支持忽略大小写的类型的属性（通常是 String 实例，例如 findByLastnameAndFirstnameAllIgnoreCase(…)）设置 IgnoreCase 标志。是否支持忽略大小写可能因存储而异，因此请查阅相关的存储特定查询方法的参考文档部分。

  • 您可以通过在查询方法中附加 OrderBy 子句来应用静态排序，该子句引用属性并提供排序方向（Asc 或 Desc）。要创建支持动态排序的查询方法，请参阅 “分页、大结果集迭代、排序和限制”。

保留的方法名称​

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

考虑以下域类型，其中有一个属性 pk 被标记为标识符，使用 @Id，还有一个名为 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

:::重要
接受 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 已经定义了一个 limit。

用于限制结果的 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' 个最大元素。