定义查询方法

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

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

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

查询查找策略

以下策略可用于存储库基础结构来解析查询。使用 XML 配置，可以通过 query-lookup-strategy 属性在命名空间中配置策略。对于 Java 配置，可以使用 EnableJpaRepositories 注释的 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);
}

解析查询方法名称分为主题和谓词。第一部分（find…By、exists…By）定义查询的主题，第二部分形成谓词。引入子句（主题）可以包含更多表达式。find（或其他引入关键字）和 By 之间的任何文本都被视为描述性文本，除非使用结果限制关键字（例如 Distinct，用于在要创建的查询上设置 distinct 标志，或 Top/First，用于限制查询结果）。

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

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

表达式通常是属性遍历与可连接的运算符的组合。你可以使用 AND 和 OR 组合属性表达式。你还可以获得对属性表达式的 Between、LessThan、GreaterThan 和 Like 等运算符的支持。支持的运算符因数据存储而异，因此请查阅参考文档的相应部分。
方法解析器支持为各个属性（例如，findByLastnameIgnoreCase(…)）或支持忽略大小写的类型的所有属性（通常为 String 实例，例如，findByLastnameAndFirstnameAllIgnoreCase(…)）设置 IgnoreCase 标志。是否支持忽略大小写可能因存储而异，因此请查阅参考文档中与特定于存储的查询方法相关的部分。
你可以通过向引用属性的查询方法附加 OrderBy 子句并提供排序方向（Asc 或 Desc）来应用静态排序。要创建支持动态排序的查询方法，请参阅“分页、迭代大型结果、排序和限制”。

属性表达式

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

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。

返回集合或可迭代对象的存储库方法

返回多个结果的查询方法可以使用标准 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。通常，这些类型通过调用返回类似集合类型的存储库方法并手动创建包装器类型的实例来使用。您可以避免这个额外的步骤，因为 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(Priced::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	一个公开 API 以访问产品价格的 `Product` 实体。
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` 使用情况。	通常使用游标的单个查询。	使用后必须关闭流以避免资源泄漏。
`Flux<T>`	分块（逐个或批量），具体取决于 `Flux` 使用情况。	通常使用游标的单个查询。	存储模块必须提供反应式基础设施。
`Slice<T>`	`Pageable.getPageSize() + 1` 在 `Pageable.getOffset()`	一对多查询从 `Pageable.getOffset()` 开始获取数据，并应用限制。	`Slice` 只能导航到下一个 `Slice`。 `Slice` 提供有关是否存在更多要获取数据的详细信息。当偏移量太大时，基于偏移量的查询会变得效率低下，因为数据库仍然必须实现完整结果。 `Window` 提供有关是否存在更多要获取数据的详细信息。当偏移量太大时，基于偏移量的查询会变得效率低下，因为数据库仍然必须实现完整结果。
`Page<T>`	`Pageable.getPageSize()` 在 `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(Limit limit);

User findFirstByOrderByLastnameAsc();

User findTopByOrderByAgeDesc();

Page<User> queryFirst10ByLastname(String lastname, Pageable pageable);

Slice<User> findTop3ByLastname(String lastname, Pageable pageable);

List<User> findFirst10ByLastname(String lastname, Sort sort);

List<User> findTop10ByLastname(String lastname, Pageable pageable);

限制表达式还支持对支持不同查询的数据存储的 Distinct 关键字。此外，对于将结果集限制为一个实例的查询，支持使用 Optional 关键字将结果包装起来。

如果将分页或切片应用于限制查询分页（以及可用页数的计算），则将其应用于限制结果中。

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