定义查询方法

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

  • 直接从方法名称派生查询。

  • 使用手动定义的查询。

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

查询查找策略

存储库基础结构可以使用以下策略来解析查询。使用 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);
}

解析查询方法名称分为主题和谓词。第一部分（find…By、exists…By）定义查询的主题，第二部分形成谓词。引入子句（主题）可以包含更多表达式。find（或其他引入关键字）和 By 之间的任何文本都被视为描述性文本，除非使用其中一个结果限制关键字，例如 Distinct 来设置要创建的查询上的 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`有一个带`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允许您将这些包装器类型用作查询方法返回类型，前提是它们满足以下条件

  1. 该类型实现了`Streamable`。

  2. 该类型公开了一个构造函数或一个名为`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源类型

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 提供有关是否还有更多数据要获取的详细信息。

  • 当偏移量过大时，基于偏移量的查询效率会降低，因为数据库仍然需要具体化完整的结果。

  • 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(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 关键字，用于支持 distinct 查询的数据存储。此外，对于将结果集限制为一个实例的查询，支持将结果包装到 Optional 关键字中。

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

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