定义查询方法

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

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

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

查询查找策略

Repository 基础设施提供以下策略来解析查询。使用 XML 配置时，可以通过命名空间中的 query-lookup-strategy 属性来配置策略。对于 Java 配置，可以使用 EnableMongoRepositories 注解的 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 用于为创建的查询设置去重标志，或 Top/First 用于限制查询结果。

附录包含查询方法主语关键字的完整列表和查询方法谓语关键字（包括排序和大小写修饰符）。但是，第一个 By 充当分隔符，指示实际条件谓语的开始。在非常基本的层面，你可以在实体属性上定义条件，并使用 And 和 Or 将它们连接起来。

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

表达式通常是属性遍历（property traversal）与可串联的运算符结合而成。你可以使用 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` 所暗示的那样使用 `id` 的派生查询，因为它是一个保留方法。
4	它针对 `pk` 属性，因为这是一个派生查询。
5	通过使用 `find` 和 `by` 之间的描述性标记，它针对 `id` 属性，以避免与保留方法冲突。

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

属性表达式

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

List<Person> findByAddressZipCode(ZipCode zipCode);

假设一个 Person 有一个 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。通常，这些类型通过调用返回集合类型结果的 repository 方法并手动创建包装类型的实例来使用。你可以避免这个额外的步骤，因为如果这些包装类型满足以下条件，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` 的消费方式。	通常使用游标的单个查询。	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' 个最大元素的查询方法。