定义查询方法

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

直接从方法名派生查询。
使用手动定义的查询。

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

查询查找策略

Repository 基础设施可以使用以下策略来解析查询。通过 XML 配置，您可以在命名空间上通过 query-lookup-strategy 属性配置策略。对于 Java 配置，您可以使用 EnableElasticsearchRepositories 注解的 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);
}

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

附录包含查询方法主体关键字的完整列表以及查询方法谓词关键字，包括排序和字母大小写修饰符。但是，第一个 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	由于它引用了 `CrudRepository` 基础 Repository 方法，因此它针对 `pk` 属性（标记有 `@Id` 的属性，被认为是标识符）。因此，它不是一个派生的查询，使用了 `id` 作为属性名所暗示的，因为它是一个保留方法。
4	作为派生查询，它通过名称针对 `pk` 属性。
5	通过使用 `find` 和 `by` 之间的描述性标记，避免与保留方法发生冲突，从而针对 `id` 属性。

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

属性表达式

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

List<Person> findByAddressZipCode(ZipCode zipCode);

假设一个 Person 有一个 Address，该 Address 有一个 ZipCode。在这种情况下，该方法会创建 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。

返回 Collection 或 Iterable 的 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。通常，这些类型通过调用返回集合类型的方法并在手动创建包装类型的实例来使用。您可以通过 Spring Data 避免这个额外的步骤，如果这些包装类型满足以下条件，您可以将其用作查询方法的返回类型：

该类型实现了 Streamable。
该类型暴露了一个构造函数或一个名为 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 源类型

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`

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` 消费。	通常使用游标进行单次查询。	使用后必须关闭流以避免资源泄露。
`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 关键字。此外，对于将结果集限制为一个实例的查询，支持使用 Optional 关键字包装结果。

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

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