定义查询方法

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

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

  • 使用手动定义的查询。

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

查询查找策略

仓库基础设施可以使用以下策略来解析查询。使用 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);
}

查询方法名称的解析分为主题（subject）和谓语（predicate）。第一部分（find…By, exists…By）定义了查询的主题，第二部分构成了谓语。引入子句（主题）可以包含进一步的表达式。find（或其他引入关键词）和 By 之间的任何文本都被认为是描述性的，除非使用了限制结果的关键词，例如 Distinct 用于在创建的查询上设置 distinct 标志，或者 Top/First 用于限制查询结果。

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

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

  • 表达式通常是属性遍历与可连接的操作符的结合。您可以使用 AND 和 OR 组合属性表达式。您还可以获得对属性表达式的支持，例如 Between、LessThan、GreaterThan 和 Like 等操作符。支持的操作符可能因数据存储而异，因此请查阅您的参考文档中相应的章节。

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

  • 您可以通过在查询方法中追加 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)
}
1 标识符属性（主键）。
2 一个名为 id 的属性，但不是标识符。
3 由于它引用了 CrudRepository 的基础仓库方法，因此它针对的是 pk 属性（即被标记为 @Id 并被认为是标识符的属性）。因此，它不是使用 id 作为属性名称所暗示的派生查询，因为它属于*保留方法*之一。
4 由于它是派生查询，因此通过名称针对 pk 属性。
5 通过使用 find 和 by 之间的描述性标记来针对 id 属性，以避免与*保留方法*冲突。

这种特殊行为不仅针对查找方法，也适用于 exists 和 delete 方法。请参阅“仓库查询关键词”以获取方法列表。

属性表达式

属性表达式只能引用受管实体的直接属性，如前面的示例所示。在查询创建时，您已经确保解析的属性是受管领域类的属性。但是，您也可以通过遍历嵌套属性来定义约束。考虑以下方法签名

List<Person> findByAddressZipCode(ZipCode zipCode);

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

虽然这在大多数情况下应该可行，但算法有可能选择错误的属性。假设 Person 类也具有一个 addressZip 属性。算法会在第一次拆分时就匹配到，选择错误的属性，并失败（因为 addressZip 的类型可能没有 code 属性）。

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

List<Person> findByAddress_ZipCode(ZipCode zipCode);

因为我们将下划线 (_) 视为保留字符，所以强烈建议遵循标准的 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) {}

由于首先考虑直接匹配属性，任何潜在的嵌套路径都不会被考虑，算法会选择 qCode 字段。为了选择 q 中的 code 字段，需要使用下划线表示法 Q_Code。

返回集合或迭代器的仓库方法

返回多个结果的查询方法可以使用标准的 Java Iterable、List 和 Set。此外，我们还支持返回 Spring Data 的 Streamable（一个自定义的 Iterable 扩展），以及 Vavr 提供的集合类型。请参阅附录，其中解释了所有可能的查询方法返回类型。

使用 Streamable 作为查询方法返回类型

您可以将 Streamable 用作 Iterable 或任何集合类型的替代。它提供了方便的方法来访问非并行 Stream（Iterable 所没有的），并且能够直接对元素进行 ….filter(…) 和 ….map(…) 操作，并将 Streamable 与其他 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"));

返回自定义 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 implements Repository<Product, Long> {
  Products findAllByDescriptionContaining(String text); (5)
}
1 一个 Product 实体，暴露了访问产品价格的 API。
2 Streamable<Product> 的包装类型，可以通过使用 Products.of(…)（通过 Lombok 注解创建的工厂方法）来构造。接受 Streamable<Product> 的标准构造函数也可以。
3 该包装类型暴露了一个额外的 API，用于在 Streamable<Product> 上计算新值。
4 实现 Streamable 接口并委托给实际结果。
5 该包装类型 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 中不同，这里使用特定于数据存储的方法来执行流式处理，如下例所示

使用 Java 8 Stream<T> 流式处理查询结果
@Query("select u from User u")
Stream<User> findAllByCustomQueryAndStream();

Stream<User> readAllByFirstnameNotNull();

@Query("select u from User u")
Stream<User> streamAllPaged(Pageable pageable);
Stream 可能包装了底层特定于数据存储的资源，因此使用后必须关闭。您可以通过使用 close() 方法手动关闭 Stream，或者使用 Java 7 的 try-with-resources 块，如下例所示
在 try-with-resources 块中处理 Stream<T> 结果
try (Stream<User> stream = repository.findAllByCustomQueryAndStream()) {
  stream.forEach(…);
}
并非所有 Spring Data 模块目前都支持 Stream<T> 作为返回类型。

异步查询结果

您可以使用Spring 的异步方法运行能力来异步运行仓库查询。这意味着方法在调用后立即返回，而实际查询发生在已提交到 Spring TaskExecutor 的任务中。异步查询与响应式查询不同，不应混合使用。有关响应式支持的更多详细信息，请参阅特定于存储的文档。以下示例显示了一些异步查询

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

@Async
CompletableFuture<User> findOneByFirstname(String firstname); (2)
1 使用 java.util.concurrent.Future 作为返回类型。
2 使用 Java 8 的 java.util.concurrent.CompletableFuture 作为返回类型。

分页、迭代大型结果集、排序和限制

要处理查询中的参数，请像前面的示例一样定义方法参数。除此之外，基础设施还识别某些特定类型，如 Pageable、Sort 和 Limit，以便动态地将分页、排序和限制应用于您的查询。以下示例演示了这些功能

在查询方法中使用 Pageable、Slice、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);
接受 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 实例所需的额外元数据不会被创建（反过来，这意味着本来必要的额外计数查询不会被发出）。相反，它将查询限制为仅查找给定范围的实体。

要了解整个查询有多少页，您必须触发一个额外的计数查询。默认情况下，此查询派生自您实际触发的查询。

特殊参数在一个查询方法中只能使用一次。
上面描述的一些特殊参数是互斥的。请考虑以下无效参数组合列表。

参数 示例 原因

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 的消费方式。

通常使用游标进行单次查询。

使用后必须关闭 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());

为了更类型安全地定义排序表达式，请从要定义排序表达式的类型开始，并使用方法引用来定义要排序的属性。

使用类型安全 API 定义排序表达式
TypedSort<Person> person = Sort.sort(Person.class);

Sort sort = person.by(Person::getFirstname).ascending()
  .and(person.by(Person::getLastname).descending());
TypedSort.by(…) 利用运行时代理（通常使用 CGlib），这在使用 Graal VM Native 等工具进行原生镜像编译时可能会产生干扰。

如果您的存储实现支持 Querydsl，您也可以使用生成的元模型类型来定义排序表达式

使用 Querydsl API 定义排序表达式
QSort sort = QSort.by(QPerson.firstname.asc())
  .and(QSort.by(QPerson.lastname.desc()));

限制查询结果

除了分页之外，还可以使用专门的 Limit 参数来限制结果大小。您还可以使用 First 或 Top 关键词来限制查询方法的结果，这两个关键词可以互换使用，但不能与 Limit 参数混用。您可以在 Top 或 First 后面追加一个可选的数字值，以指定要返回的最大结果大小。如果省略数字，则假定结果大小为 1。以下示例显示了如何限制查询大小

使用 Top 和 First 限制查询结果大小
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);

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

如果分页或切片应用于限制性查询（以及可用页数的计算），则它将在限制的结果范围内应用。

将限制结果与使用 Sort 参数进行动态排序结合使用，可以表达查询方法来获取“最小的 K 个”和“最大的 K 个”元素。