定义查询方法

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

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

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

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

查询查找策略

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

  • CREATE 尝试根据查询方法名称构建特定于存储的查询。通用方法是删除方法名称中一组已知的特定前缀，然后解析方法的其余部分。您可以在“查询创建”中阅读有关查询构建的更多信息。

  • USE_DECLARED_QUERY 尝试查找声明的查询，如果找不到，则抛出异常。查询可以通过注解或其他方式定义。请参阅特定存储的文档以查找该存储的可用选项。如果在引导时 repository 基础设施找不到方法的声明查询，则会失败。

  • CREATE_IF_NOT_FOUND (默认) 结合了 CREATE 和 USE_DECLARED_QUERY。它首先查找声明的查询，如果找不到声明的查询，则创建一个自定义的基于方法名称的查询。这是默认的查找策略，因此在您没有明确配置任何内容时使用。它允许通过方法名称快速定义查询，也可以通过根据需要引入声明的查询来对这些查询进行自定义调整。

查询创建

集成到 Spring Data repository 基础设施中的查询构建器机制对于构建针对 repository 实体的约束性查询非常有用。

以下示例展示了如何创建多种查询

从方法名称创建查询
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。支持的运算符可能因数据存储而异，因此请查阅参考文档的相应部分。

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

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

保留方法名称

虽然派生的 repository 方法按名称绑定到属性，但对于从基 repository 继承的针对标识符属性的某些方法名称，存在一些例外。那些保留方法，例如 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 目标指向 pk 属性（即标记有 @Id 并被视为标识符的属性），因为它引用了 CrudRepository 基 repository 方法。因此，它不是使用 id 作为属性名称所暗示的派生查询，因为它属于保留方法之一。
4 按名称目标指向 pk 属性，因为它是一个派生查询。
5 通过使用 find 和 by 之间的描述性标记来目标指向 id 属性，以避免与保留方法发生冲突。

这种特殊行为不仅适用于查找方法，也适用于 exits 和 delete 方法。请参阅“Repository 查询关键字”以获取方法列表。

属性表达式

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

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。

返回集合或可迭代对象的 Repository 方法

返回多个结果的查询方法可以使用标准 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"));

返回自定义 Streamable 包装类型

为集合提供专用的包装类型是一种常用模式，用于为返回多个元素的查询结果提供 API。通常，这些类型是通过调用返回类似集合类型的 repository 方法并手动创建包装类型实例来使用的。您可以避免这个额外的步骤，因为 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> 并在 repository 客户端中在查询后手动对其进行包装。

支持 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 的异步方法运行能力来异步运行 repository 查询。这意味着方法在调用后立即返回，而实际查询发生在提交给 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.getPageSize() + 1 at Pageable.getOffset()

从 Pageable.getOffset() 开始获取数据，并应用限制的一对多查询。

Slice 只能导航到下一个 Slice。

  • Slice 提供了是否有更多数据可供获取的详细信息。

  • 当偏移量过大时，基于偏移量的查询会变得低效，因为数据库仍然必须实体化完整的结果。

  • Window 提供了是否有更多数据可供获取的详细信息。

  • 当偏移量过大时，基于偏移量的查询会变得低效，因为数据库仍然必须实体化完整的结果。

Page<T>

Pageable.getPageSize() at Pageable.getOffset()

从 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' 个最大元素。