定义查询方法

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

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

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

查询查找策略

以下策略可用于存储库基础设施来解析查询。通过 XML 配置，您可以通过 query-lookup-strategy 属性在命名空间中配置策略。对于 Java 配置，您可以使用 EnableCouchbaseRepositories 注解的 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）来应用静态排序。要创建支持动态排序的查询方法，请参阅“分页、迭代大型结果集、排序和限制”。

保留方法名称

虽然派生存储库方法按名称绑定到属性，但在涉及从目标标识符属性的基础存储库继承的某些方法名称时，此规则有一些例外。这些保留方法，如 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 有一个带有 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

使用 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` 消耗。	通常使用游标进行单次查询。	使用后必须关闭流以避免资源泄漏。
`Flux<T>`	分块（逐个或批量），取决于 `Flux` 消耗。	通常使用游标进行单次查询。	存储模块必须提供反应式基础设施。
`Slice<T>`	在 `Pageable.getOffset()` 处，`Pageable.getPageSize() + 1`	一次到多次查询，从 `Pageable.getOffset()` 开始获取数据并应用限制。	`Slice` 只能导航到下一个 `Slice`。 `Slice` 提供是否还有更多数据可获取的详细信息。当偏移量过大时，基于偏移量的查询效率会降低，因为数据库仍然必须实现完整的结果。
`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 查询的数据存储的 Distinct 关键字。此外，对于将结果集限制为一个实例的查询，支持使用 Optional 关键字包装结果。

如果将分页或切片应用于限制查询分页（和可用页面数的计算），则它将在限制结果中应用。

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