定义查询方法

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

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

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

查询查找策略

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

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

解析方法的结果取决于你为其创建查询的持久化存储。然而，有一些需要注意的普遍事项：

表达式通常是属性遍历与可连接的运算符的组合。你可以将属性表达式与 AND 和 OR 结合使用。属性表达式还支持 Between、LessThan、GreaterThan 和 Like 等运算符。支持的运算符可能因数据存储而异，请查阅参考文档的相应部分。
方法解析器支持为单个属性设置 IgnoreCase 标志（例如 findByLastnameIgnoreCase(…)），或为支持忽略大小写的类型的所有属性设置（通常是 String 实例 — 例如 findByLastnameAndFirstnameAllIgnoreCase(…)）。是否支持忽略大小写可能因存储而异，请查阅参考文档中特定于存储的查询方法的相应章节。
你可以通过在查询方法后附加引用属性的 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	指向 `pk` 属性（使用 `@Id` 标记的属性，被视为标识符），因为它引用了一个 `CrudRepository` 基础仓库方法。因此，它不是一个使用 `id` 作为属性名称的派生查询，因为它属于保留方法之一。
4	按名称指向 `pk` 属性，因为它是一个派生查询。
5	通过使用 `find` 和 `by` 之间的描述性标记来指向 `id` 属性，以避免与保留方法冲突。

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

属性表达式

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

List<Person> findByAddressZipCode(ZipCode zipCode);

假设一个 Person 有一个 Address，其中包含一个 ZipCode。在这种情况下，该方法会创建 x.address.zipCode 属性遍历。解析算法首先将整个部分（AddressZipCode）解释为属性，并在域类中查找具有该名称（首字母小写）的属性。如果算法成功，它将使用该属性。如果失败，算法将从右侧开始，在驼峰大小写部分将源分割为头部（head）和尾部（tail），然后尝试查找相应的属性——在我们的示例中是 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 允许你将这些包装类型用作查询方法的返回类型，只要它们满足以下条件

该类型实现了 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>` 并在仓库客户端的查询后手动包装它。

支持 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 的异步方法运行能力来异步运行仓库查询。这意味着方法调用后立即返回，而实际查询则在提交给 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` 的消费方式。	通常使用游标的单个查询。	使用后必须关闭 Streams 以避免资源泄露。
`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' 个最大元素。