跳到主要内容

定义 Query Methods

QWen Flash 中英对照 Defining Query Methods

repository proxy 有两种从 method name 派生 store-specific query 的方式:

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

  • 使用手动定义的查询。

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

查询查找策略​

以下策略可供仓储基础设施用于解析查询。使用 XML 配置时，你可以通过 query-lookup-strategy 属性在命名空间中配置策略。对于 Java 配置，你可以使用 EnableLdapRepositories 注解的 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 为要创建的查询设置 distinct 标志，或 Top/First 限制查询结果。

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

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

  • 这些表达式通常是属性遍历与可串联运算符的组合。你可以将属性表达式与 AND 和 OR 组合。属性表达式还支持 Between、LessThan、GreaterThan 和 Like 等运算符。支持的运算符可能因数据存储而异，因此请参阅参考文档中的相应部分。

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

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

保留方法名称​

尽管派生仓库方法通过名称绑定属性，但当涉及某些继承自基础仓库、针对 identifier 属性的方法名称时，这一规则有几个例外。像 CrudRepository#findById（或仅 findById）这样的 reserved methods 都会针对 identifier 属性，而无论声明的方法中实际使用的属性名称是什么。

请考虑以下 domain type，其中包含一个通过 @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 之间使用描述性 token 来指向 id 属性，以避免与 保留方法 发生冲突。

这种特殊行为不仅针对 lookup methods，也适用于 exists 和 delete 方法。请参阅“Repository query keywords”以获取方法列表。

属性表达式​

Property expressions 只能引用 managed entity 的直接属性，如前面的示例所示。在创建查询时，你已经确保解析出的属性是 managed domain class 的属性。不过，也可以通过遍历嵌套属性来定义约束。考虑以下方法签名：

List<Person> findByAddressZipCode(ZipCode zipCode);
java

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

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

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

List<Person> findByAddress_ZipCode(ZipCode zipCode);
java
备注

由于我们将下划线 (_) 视为保留字符，因此强烈建议遵循标准 Java 命名规范（即在属性名中不使用下划线，而是采用 camel case）。

警告

以下划线开头的字段名称：

字段名称可以以下划线开头，如 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。

Repository 方法返回 Collections 或 Iterables​

返回多个结果的查询方法可以使用标准 Java Iterable、List 和 Set。除此之外，我们支持返回 Spring Data’s 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

返回自定义 Streamable Wrapper Types​

为集合提供专用的包装类型是一种常用模式，用于为返回多个元素的查询结果提供 API。通常，这些类型会通过调用返回集合类型的数据仓库方法，并手动创建包装类型实例来使用。如果这些包装类型满足以下条件，你可以避免这一额外步骤，因为 Spring Data 允许将它们用作查询方法的返回类型：

  1. 该类型实现了 Streamable。

  2. 该类型公开了以 Streamable 作为参数的构造函数或名为 of(…) 或 valueOf(…) 的静态工厂方法。

以下清单展示了一个示例：

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 extends Repository<Product, Long> {
  Products findAllByDescriptionContaining(String text); 5
}
java

  • 一个暴露 API 以访问产品价格的 Product 实体。

  • 一个用于 Streamable<Product> 的包装类型，可以通过使用 Products.of(…) 构造（使用 Lombok 注解创建的工厂方法）。采用 Streamable<Product> 的标准构造函数也可以。

  • 该包装类型暴露了额外的 API，用于在 Streamable<Product> 上计算新值。

  • 实现 Streamable 接口并委托给实际结果。

  • 该包装类型 Products 可以直接用作查询方法的返回类型。你无需返回 Streamable<Product>，也无需在 repository client 中查询后手动包装它。

对 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，依此类推。

流式查询结果​

您可以将 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，也可以使用 try-with-resources 块，如下例所示：

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

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

异步查询结果​

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

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

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

  • 使用 java.util.concurrent.Future 作为返回类型。

  • 使用 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 包含可用元素和页的总数信息。它是通过底层基础设施触发 count 查询来计算总数量。由于这可能开销较大（取决于所使用的 store），你可以改为返回 Slice。Slice 只知道是否还有下一个 Slice，这在遍历较大的结果集时可能就足够了。

排序选项也通过 Pageable 实例处理。如果你只需要排序，请在方法中添加一个 org.springframework.data.domain.Sort 参数。如你所见，返回 List 也是可以的。在这种情况下，构建实际 Page 实例所需的额外元数据不会被创建（这反过来意味着不会发出本来必要的额外 count 查询）。相反，它会将查询限制为只查找给定范围内的实体。

备注

要确定整个查询会得到多少页，你需要触发一个额外的 count 查询。默认情况下，该查询是从你实际触发的查询派生而来的。

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 的消费方式。通常使用游标的单次查询。Store 模块必须提供响应式基础设施。
Slice<T>在 Pageable.getOffset() 处获取 Pageable.getPageSize() + 1 条数据一次到多次查询，从 Pageable.getOffset() 开始获取数据并应用限制。Slice 只能导航到下一个 Slice。

- 当偏移量过大时，基于偏移量的查询会变得低效，因为数据库仍必须物化完整结果。
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 来实现运行时代理，这可能会在使用 GraalVM Native Image 等工具时干扰原生镜像编译。

如果你的存储实现支持 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(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);
java

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

如果对限制查询分页（以及可用页数的计算）应用分页或切片，则它会在限制后的结果中应用。

备注

通过 Sort 参数结合动态排序来限制结果，即可表达用于查询 'K' 个最小元素和 'K' 个最大元素的方法。