定义查询方法

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

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

  • 使用手动定义的查询。

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

查询查找策略

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

  • CREATE 尝试从查询方法名称构建特定于存储的查询。通用方法是移除方法名称中一组众所周知的（well known）前缀，然后解析方法的其余部分。您可以在“查询创建”中阅读更多关于查询构建的信息。

  • 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 继承的、针对标识符属性的某些方法名称，此规则有一些例外。这些保留方法（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)
}
1 标识符属性（主键）。
2 一个名为 id 的属性，但不是标识符。
3 由于它引用了 CrudRepository 基础 Repository 方法，因此它针对 pk 属性（即标记有 @Id 并被视为标识符的属性）。因此，它不是一个使用 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 的能力

使用 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。通常，这些类型通过调用返回集合类型（collection-like type）的 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.getOffset() 位置获取 Pageable.getPageSize() + 1 个元素

一个或多个查询，从 Pageable.getOffset() 位置开始获取数据并应用限制。

Slice 只能导航到下一个 Slice。

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

  • 当 offset 过大时，基于 offset 的查询效率会降低，因为数据库仍然必须具体化（materialize）完整的结果。

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

  • 当 offset 过大时，基于 offset 的查询效率会降低，因为数据库仍然必须具体化（materialize）完整的结果。

Page<T>

在 Pageable.getOffset() 位置获取 Pageable.getPageSize() 个元素

一个或多个查询，从 Pageable.getOffset() 位置开始并应用限制。此外，可能需要 COUNT(…) 查询来确定元素的总数。

通常需要 COUNT(…) 查询，而这些查询代价高昂。

  • 当 offset 过大时，基于 offset 的查询效率会降低，因为数据库仍然必须具体化（materialize）完整的结果。

分页与排序

您可以使用属性名定义简单的排序表达式。您可以连接表达式，将多个条件组合成一个表达式。

定义排序表达式
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 关键词将结果包装起来。

如果分页或分块（slicing）应用于限制性查询的分页（以及可用页数的计算），则该分页会应用在限制的结果范围内。

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