定义查询方法

Doubao 中英对照 Defining Query Methods

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

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

• 使用手动定义的查询。

可用的选项取决于实际使用的存储。不过，必须有一种策略来决定创建何种实际查询。下一节介绍可用的选项。

查询查找策略

仓库基础设施可使用以下策略来解析查询。使用 XML 配置时，您可以在命名空间中通过 query-lookup-strategy 属性配置该策略。对于 Java 配置，您可以使用 EnableJpaRepositories 注解的 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），来应用静态排序。要创建支持动态排序的查询方法，请参阅「分页、迭代大量结果、排序与限制」。

保留方法名

虽然派生仓库方法按名称绑定到属性，但对于从基础仓库继承的、面向标识符（identifier）属性的某些方法名，这条规则存在一些例外。那些保留方法（reserved methods），例如 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 作为属性名的派生查询所暗示的那样，因为它是保留方法（reserved methods）之一。

• 按名称面向 pk 属性，因为它是一个派生查询。

• 通过使用 find 与 by 之间的描述性标记来面向 id 属性，以避免与保留方法冲突。

这种特殊行为不仅面向查找方法，也适用于 exists 和 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

返回自定义 Streamable 包装类型

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

流式查询结果

您可以使用 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 的异步方法执行能力 来异步运行仓库查询。这意味着方法在被调用时立即返回，而实际查询则在已提交给 Spring TaskExecutor 的任务中执行。异步查询与响应式查询不同，不应混用。有关响应式支持的更多详情，请参阅特定存储的文档。以下示例展示了若干异步查询：

@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 知道元素和可用页的总数。它是通过基础设施触发一个计数查询来计算总数的。由于这可能代价较高（取决于所使用的存储），您可以改为返回 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 提供是否还有更多数据可获取的详情。 - 当偏移量过大时，基于偏移量的查询会变得低效，因为数据库仍然必须物化完整结果。
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 关键字。此外，对于将结果集限制为一个实例的查询，支持使用 Optional 关键字包装结果。

如果对带限制的查询应用分页或切片（以及对可用页数的计算），则该分页或切片是在被限制的结果之内应用的。

备注

将限制结果与使用 Sort 参数的动态排序相结合，可以让您表达出用于查询「第 K 个最小」以及「第 K 个最大」元素的查询方法。