对于最新的稳定版本，请使用 Spring Data Couchbase 5.4.0！spring-doc.cn

定义查询方法

存储库代理有两种方法可以从方法名称派生特定于存储的查询：spring-doc.cn

通过直接从方法名称派生查询。spring-doc.cn
通过使用手动定义的查询。spring-doc.cn

可用选项取决于实际商店。但是，必须有一个策略来决定创建什么实际的查询。下一节将介绍可用选项。spring-doc.cn

查询查找策略

存储库基础设施可以使用以下策略来解析查询。使用 XML 配置，您可以通过属性在命名空间处配置策略。对于 Java 配置，您可以使用 Comments 的属性。某些策略可能不支持特定数据存储。query-lookup-strategyqueryLookupStrategyEnableCouchbaseRepositoriesspring-doc.cn

CREATE尝试从查询方法名称构造特定于存储的查询。一般的方法是从方法名称中删除一组给定的已知前缀，并解析方法的其余部分。您可以在 “Query Creation” 中阅读有关查询构造的更多信息。spring-doc.cn
USE_DECLARED_QUERY尝试查找已声明的查询，如果找不到，则引发异常。查询可以通过某处的 Comments 定义，也可以通过其他方式声明。请参阅特定商店的文档，以查找该商店的可用选项。如果存储库基础结构在引导时未找到该方法的声明查询，则它将失败。spring-doc.cn
CREATE_IF_NOT_FOUND（默认）合并和。它首先查找已声明的查询，如果未找到已声明的查询，则创建基于自定义方法名称的查询。这是默认的查找策略，因此，如果您未显式配置任何内容，则使用该策略。它允许通过方法名称快速定义查询，但也允许通过根据需要引入声明的查询来自定义调整这些查询。CREATEUSE_DECLARED_QUERYspring-doc.cn

查询创建

Spring Data 存储库基础结构中内置的查询生成器机制对于构建对存储库实体的约束查询非常有用。spring-doc.cn

以下示例显示如何创建多个查询：spring-doc.cn

从方法名称创建查询

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）可以包含进一步的表达式。介于和之间（或其他引入关键字）和之间的任何文本都被视为描述性文本，除非使用结果限制关键字之一，例如 a 在要创建的查询上设置不同的标志，或使用 Top/First 限制查询结果。find…Byexists…ByfindByDistinctspring-doc.cn

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

解析方法的实际结果取决于您为其创建查询的持久性存储。但是，有一些一般事项需要注意：spring-doc.cn

表达式通常是属性遍历与可以连接的运算符组合。您可以将属性表达式与和组合在一起。您还可以获得对运算符（如、、、）和属性表达式的支持。支持的运算符可能因数据存储而异，因此请参阅参考文档的相应部分。ANDORBetweenLessThanGreaterThanLikespring-doc.cn
方法解析器支持为单个属性（例如）或支持忽略大小写的类型的所有属性（通常是 instances — 例如）设置标志。是否支持忽略大小写可能因商店而异，因此请参阅参考文档中的相关部分，了解特定于商店的查询方法。IgnoreCasefindByLastnameIgnoreCase(…)StringfindByLastnameAndFirstnameAllIgnoreCase(…)spring-doc.cn
您可以通过将子句附加到引用属性的查询方法并提供排序方向（或）来应用静态排序。要创建支持动态排序的查询方法，请参阅“分页，迭代大结果，排序和限制”。OrderByAscDescspring-doc.cn

保留方法名称

虽然派生的存储库方法按名称绑定到属性，但当涉及到从面向 identifier 属性的基本存储库继承的某些方法名称时，此规则有一些例外。那些保留方法（如（或只是））以 identifier 属性为目标，而不管声明的方法中使用的实际属性名称如何。CrudRepository#findByIdfindByIdspring-doc.cn

请考虑以下域类型，其中包含一个标记为标识符 via 的属性和一个名为 . 在这种情况下，您需要密切注意查找方法的命名，因为它们可能会与预定义的签名发生冲突：pk@Ididspring-doc.cn

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	identifier 属性（primary key）。
2	名为的属性，但不是标识符。`id`
3	以属性为目标（标有的那个被视为标识符），因为它引用基本存储库方法。因此，它不是使用 of 作为属性名称所建议的派生查询，因为它是保留方法之一。`pk@IdCrudRepositoryid`
4	按名称确定属性的目标，因为它是派生查询。`pk`
5	通过在和之间使用描述性标记来定位属性，以避免与保留方法发生冲突。`idfindby`

这种特殊行为不仅适用于 lookup 方法，也适用于和方法。有关方法列表，请参阅“存储库查询关键字”。exitsdeletespring-doc.cn

属性表达式

属性表达式只能引用托管实体的直接属性，如前面的示例所示。在创建查询时，您已确保 parsed 属性是托管域类的属性。但是，您也可以通过遍历嵌套属性来定义约束。请考虑以下方法签名：spring-doc.cn

List<Person> findByAddressZipCode(ZipCode zipCode);

假设 a 具有和 . 在这种情况下，该方法将创建属性 traversal。解析算法首先将整个部分（）解释为属性，并检查域类中是否有具有该名称（未大写）的属性。如果算法成功，它将使用该属性。如果不是，算法将右侧驼峰式部分的源拆分为 head 和 tail，并尝试找到相应的属性 — 在我们的示例中为和。如果算法找到具有该 head 的属性，它会获取 tail 并继续从那里构建树，以刚才描述的方式将 tail 向上拆分。如果第一个分割不匹配，则算法将分割点向左移动（，）并继续。PersonAddressZipCodex.address.zipCodeAddressZipCodeAddressZipCodeAddressZipCodespring-doc.cn

尽管这应该适用于大多数情况，但算法可能会选择错误的属性。假设该类也有一个属性。该算法在第一轮拆分中已经匹配，选择了错误的属性，然后失败（因为的类型可能没有属性）。PersonaddressZipaddressZipcodespring-doc.cn

要解决这种歧义，您可以在方法名称中使用来手动定义遍历点。所以我们的方法名称将如下所示：_spring-doc.cn

List<Person> findByAddress_ZipCode(ZipCode zipCode);

因为我们将下划线（）视为保留字符，所以我们强烈建议遵循标准的 Java 命名约定（即，不要在属性名称中使用下划线，而是应用驼峰式大小写）。_spring-doc.cn

以下划线开头的字段名称：

字段名称可以以下划线开头，例如 . 确保保留 as in 并使用 double 拆分嵌套路径，例如 .String _name__name_user__namespring-doc.cn

大写字段名称：

全大写的字段名称可以这样使用。嵌套路径（如果适用）需要 split via ，如 ._USER_namespring-doc.cn

第 2 个大写字母的字段名称：

由一个开头的小写字母后跟一个大写字母组成的字段名称（如）可以通过以两个大写字母开头来解析，如。请注意可能的路径歧义。String qCodeQCodespring-doc.cn

路径歧义：

在以下示例中，属性和的排列，其中包含名为的属性，这会为路径创建歧义。qCodeqqcodeQCodespring-doc.cn

record Container(String qCode, Code q) {}
record Code(String code) {}

由于首先考虑对属性的直接匹配，因此不会考虑任何可能的嵌套路径，并且算法会选取该字段。为了选择下划线表示法中的字段，需要表示法。qCodecodeqQ_Codespring-doc.cn

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

返回多个结果的查询方法可以使用标准 Java 、和。除此之外，我们还支持返回 Spring Data 的、的自定义扩展以及 Vavr 提供的集合类型。请参阅附录，其中说明了所有可能的查询方法返回类型。IterableListSetStreamableIterablespring-doc.cn

使用 Streamable 作为查询方法返回类型

您可以用作集合类型的替代项或任何集合类型。它提供了访问非 parallel （missing from ）的便捷方法，并能够直接和覆盖元素并将连接到其他元素：StreamableIterableStreamIterable….filter(…)….map(…)Streamablespring-doc.cn

使用 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 允许你使用这些包装器类型作为查询方法返回类型，如果它们满足以下条件：spring-doc.cn

该类型实现 .Streamablespring-doc.cn
该类型公开一个构造函数或一个名为 OR 的静态工厂方法，该方法作为参数。of(…)valueOf(…)Streamablespring-doc.cn

下面的清单显示了一个示例：spring-doc.cn

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	一个公开 API 以访问产品价格的实体。`Product`
2	可以使用（使用 Lombok 注释创建的工厂方法）构造的 a 的包装器类型。采用 will 的标准构造函数也可以。`Streamable<Product>Products.of(…)Streamable<Product>`
3	包装器类型公开一个附加 API，用于计算 .`Streamable<Product>`
4	实现接口并委托给实际结果。`Streamable`
5	该包装类型可以直接用作查询方法返回类型。您无需在存储库客户端的查询后返回并手动包装它。`ProductsStreamable<Product>`

支持 Vavr 集合

Vavr 是一个包含 Java 函数式编程概念的库。它附带了一组自定义的集合类型，您可以将其用作查询方法返回类型，如下表所示：spring-doc.cn

Vavr 集合类型使用的 Vavr 实现类型有效的 Java 源类型

Vavr 集合类型	使用的 Vavr 实现类型	有效的 Java 源类型
`io.vavr.collection.Seq`spring-doc.cn	`io.vavr.collection.List`spring-doc.cn	`java.util.Iterable`spring-doc.cn
`io.vavr.collection.Set`spring-doc.cn	`io.vavr.collection.LinkedHashSet`spring-doc.cn	`java.util.Iterable`spring-doc.cn
`io.vavr.collection.Map`spring-doc.cn	`io.vavr.collection.LinkedHashMap`spring-doc.cn	`java.util.Map`spring-doc.cn

io.vavr.collection.Seqspring-doc.cn

io.vavr.collection.Listspring-doc.cn

java.util.Iterablespring-doc.cn

io.vavr.collection.Setspring-doc.cn

io.vavr.collection.LinkedHashSetspring-doc.cn

java.util.Iterablespring-doc.cn

io.vavr.collection.Mapspring-doc.cn

io.vavr.collection.LinkedHashMapspring-doc.cn

java.util.Mapspring-doc.cn

您可以使用第一列（或其子类型）中的类型作为查询方法返回类型，并获取第二列中用作实现类型的类型，具体取决于实际查询结果的 Java 类型（第三列）。或者，你可以声明（Vavr 等价物），然后我们从实际的返回值中派生出实现类。也就是说，a 变成 Vavr 或，a 变成 Vavr ，依此类推。TraversableIterablejava.util.ListListSeqjava.util.SetLinkedHashSetSetspring-doc.cn

流式处理查询结果

您可以使用 Java 8 作为返回类型以增量方式处理查询方法的结果。不是将查询结果包装在中，而是使用特定于数据存储的方法来执行流式处理，如以下示例所示：Stream<T>Streamspring-doc.cn

使用 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);

A 可能会包装特定于底层数据存储的资源，因此必须在使用后关闭。您可以使用该方法或使用 Java 7 块手动关闭，如以下示例所示：StreamStreamclose()try-with-resources

在块中处理结果Stream<T>try-with-resources

try (Stream<User> stream = repository.findAllByCustomQueryAndStream()) {
  stream.forEach(…);
}

并非所有 Spring Data 模块当前都支持作为返回类型。Stream<T>

异步查询结果

您可以使用 Spring 的异步方法运行功能异步运行存储库查询。这意味着该方法在调用时立即返回，而实际查询发生在已提交给 Spring 的任务中。异步查询与反应式查询不同，不应混合使用。有关反应式支持的更多详细信息，请参阅特定于 store 的文档。以下示例显示了许多异步查询：TaskExecutorspring-doc.cn

@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`

分页，迭代大结果，排序和限制

要处理查询中的参数，请定义方法参数，如前面的示例中所示。除此之外，基础设施还可以识别某些特定类型，如、和，以动态地将分页、排序和限制应用于您的查询。以下示例演示了这些功能：PageableSortLimitspring-doc.cn

在 query 方法中使用、和PageableSliceSortLimit

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);

API 接受，并期望将非值传递给方法。如果您不想应用任何排序或分页，请使用、和。SortPageableLimitnullSort.unsorted()Pageable.unpaged()Limit.unlimited()

第一种方法允许您将实例传递给 query 方法，以动态地将分页添加到静态定义的查询中。 A 知道可用的元素和页面的总数。它通过触发 count 查询来计算总数。由于这可能很昂贵（取决于使用的存储），因此您可以改为返回 . A 只知道 next 是否可用，这在遍历较大的结果集时可能就足够了。org.springframework.data.domain.PageablePageSliceSliceSlicespring-doc.cn

排序选项也通过实例进行处理。如果只需要排序，请向方法中添加参数。如您所见，返回 a 也是可能的。在这种情况下，不会创建构建实际实例所需的其他元数据（这反过来意味着不会发出本来必要的其他 count 查询）。相反，它将查询限制为仅查找给定的实体范围。Pageableorg.springframework.data.domain.SortListPagespring-doc.cn

要了解整个查询获得多少页，您必须触发额外的 count 查询。默认情况下，此查询派生自您实际触发的查询。

特殊参数在查询方法中只能使用一次。
上面描述的一些特殊参数是互斥的。请考虑以下无效参数组合列表。spring-doc.cn

参数例原因

Pageable和Sortspring-doc.cn

findBy…(Pageable page, Sort sort)spring-doc.cn

Pageable已经定义了Sortspring-doc.cn

Pageable和Limitspring-doc.cn

findBy…(Pageable page, Limit limit)spring-doc.cn

Pageable已经定义了一个限制。spring-doc.cn

用于限制结果的关键字可以与 while 一起用于定义结果的总数最大值，而 Pageable 参数可能会减少此数量。TopPageableTopspring-doc.cn

哪种方法合适？

Spring Data 抽象提供的值可能最好地由下表中概述的可能的查询方法返回类型来显示。下表显示了您可以从查询方法返回的类型spring-doc.cn

表 1.使用大型查询结果
方法	提取的数据量	查询结构	约束
`List<T>`spring-doc.cn	所有结果。spring-doc.cn	单个查询。spring-doc.cn	查询结果可能会耗尽所有内存。获取所有数据可能非常耗时。spring-doc.cn
`Streamable<T>`spring-doc.cn	所有结果。spring-doc.cn	单个查询。spring-doc.cn	查询结果可能会耗尽所有内存。获取所有数据可能非常耗时。spring-doc.cn
`Stream<T>`spring-doc.cn	分块（逐个或批量）取决于消耗量。`Stream`spring-doc.cn	通常使用游标的单个查询。spring-doc.cn	使用后必须关闭流，以避免资源泄漏。spring-doc.cn
`Flux<T>`spring-doc.cn	分块（逐个或批量）取决于消耗量。`Flux`spring-doc.cn	通常使用游标的单个查询。spring-doc.cn	Store 模块必须提供响应式基础设施。spring-doc.cn
`Slice<T>`spring-doc.cn	`Pageable.getPageSize() + 1`在`Pageable.getOffset()`spring-doc.cn	从应用限制开始获取数据的一对多查询。`Pageable.getOffset()`spring-doc.cn	A 只能导航到下一个。`SliceSlice`spring-doc.cn `Slice`提供是否有更多数据要获取的详细信息。spring-doc.cn 当偏移量太大时，基于偏移量的查询会变得效率低下，因为数据库仍然必须具体化完整结果。spring-doc.cn `Window`提供是否有更多数据要获取的详细信息。spring-doc.cn 当偏移量太大时，基于偏移量的查询会变得效率低下，因为数据库仍然必须具体化完整结果。spring-doc.cn
`Page<T>`spring-doc.cn	`Pageable.getPageSize()`在`Pageable.getOffset()`spring-doc.cn	从应用限制开始的一对多查询。此外，可能需要 query 来确定元素总数。`Pageable.getOffset()COUNT(…)`spring-doc.cn	通常，需要的查询成本很高。`COUNT(…)`spring-doc.cn 当偏移量太大时，基于偏移量的查询会变得效率低下，因为数据库仍然必须具体化完整结果。spring-doc.cn

分页和排序

您可以使用属性名称定义简单的排序表达式。您可以连接表达式以将多个条件收集到一个表达式中。spring-doc.cn

定义排序表达式

Sort sort = Sort.by("firstname").ascending()
  .and(Sort.by("lastname").descending());

要以更类型安全的方法来定义排序表达式，请从要为其定义排序表达式的类型开始，并使用方法引用来定义要排序的属性。spring-doc.cn

使用类型安全 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 等工具时可能会干扰本机映像编译。

如果你的 store 实现支持 Querydsl，你也可以使用生成的元模型类型来定义排序表达式：spring-doc.cn

使用 Querydsl API 定义排序表达式

QSort sort = QSort.by(QPerson.firstname.asc())
  .and(QSort.by(QPerson.lastname.desc()));

限制查询结果

除了分页之外，还可以使用专用参数限制结果大小。您还可以使用 or 关键字来限制查询方法的结果，这些关键字可以互换使用，但不能与参数混合使用。您可以将可选数值附加到或以指定要返回的最大结果大小。如果省略该数字，则假定结果大小为 1。以下示例显示如何限制查询大小：LimitFirstTopLimitTopFirstspring-doc.cn

使用和限制查询的结果大小TopFirst

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);

限制表达式还支持支持不同查询的数据存储的关键字。此外，对于将结果集限制为一个实例的查询，支持使用关键字将结果包装到中。DistinctOptionalspring-doc.cn

如果将分页或切片应用于限制查询分页（以及可用页数的计算），则会在有限结果中应用该分页或切片。spring-doc.cn

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