查询方法 (Query Methods) | Spring Data R2DBC3.3.1中文文档|Spring官方文档|SpringBoot 教程|Spring中文网

通常在存储库上触发的大多数数据访问操作都会导致对数据库运行查询。定义这样的查询是在存储库接口上声明方法的问题，如以下示例所示：

例 1.具有查询方法的 PersonRepository

interface ReactivePersonRepository extends ReactiveSortingRepository<Person, Long> {

  Flux<Person> findByFirstname(String firstname);                                   (1)

  Flux<Person> findByFirstname(Publisher<String> firstname);                        (2)

  Flux<Person> findByFirstnameOrderByLastname(String firstname, Pageable pageable); (3)

  Mono<Person> findByFirstnameAndLastname(String firstname, String lastname);       (4)

  Mono<Person> findFirstByLastname(String lastname);                                (5)

  @Query("SELECT * FROM person WHERE lastname = :lastname")
  Flux<Person> findByLastname(String lastname);                                     (6)

  @Query("SELECT firstname, lastname FROM person WHERE lastname = $1")
  Mono<Person> findFirstByLastname(String lastname);                                (7)
}

1	该方法显示对具有给定 . 通过分析可与和连接的约束的方法名称来派生查询。因此，方法名称将生成 .`firstnameAndOrSELECT … FROM person WHERE firstname = :firstname`
2	该方法显示对所有具有给定的人的查询，一旦给定发出。`firstnamefirstnamePublisher`
3	用于将偏移量和排序参数传递到数据库。`Pageable`
4	查找给定条件的单个实体。它以非唯一结果完成。`IncorrectResultSizeDataAccessException`
5	除非 <4>，否则即使查询生成更多结果行，也始终发出第一个实体。
6	该方法显示对具有给定姓氏的所有人员的查询。`findByLastname`
7	对仅投影和列的单个实体的查询。带批注的查询使用本机绑定标记，在此示例中，这些标记是 Postgres 绑定标记。`Personfirstnamelastname`

请注意，批注中使用的 select 语句的列必须与 for 相应属性生成的名称匹配。如果 select 语句不包含匹配列，则不会设置该属性。如果持久性构造函数需要该属性，则提供 null 或（对于基元类型）默认值。@QueryNamingStrategy

下表显示了查询方法支持的关键字：

表 1.查询方法支持的关键字
关键词	样本	合乎逻辑的结果
`After`	`findByBirthdateAfter(Date date)`	`birthdate > date`
`GreaterThan`	`findByAgeGreaterThan(int age)`	`age > age`
`GreaterThanEqual`	`findByAgeGreaterThanEqual(int age)`	`age >= age`
`Before`	`findByBirthdateBefore(Date date)`	`birthdate < date`
`LessThan`	`findByAgeLessThan(int age)`	`age < age`
`LessThanEqual`	`findByAgeLessThanEqual(int age)`	`age <= age`
`Between`	`findByAgeBetween(int from, int to)`	`age BETWEEN from AND to`
`NotBetween`	`findByAgeNotBetween(int from, int to)`	`age NOT BETWEEN from AND to`
`In`	`findByAgeIn(Collection<Integer> ages)`	`age IN (age1, age2, ageN)`
`NotIn`	`findByAgeNotIn(Collection ages)`	`age NOT IN (age1, age2, ageN)`
`IsNotNull`,`NotNull`	`findByFirstnameNotNull()`	`firstname IS NOT NULL`
`IsNull`,`Null`	`findByFirstnameNull()`	`firstname IS NULL`
`Like`, ,`StartingWithEndingWith`	`findByFirstnameLike(String name)`	`firstname LIKE name`
`NotLike`,`IsNotLike`	`findByFirstnameNotLike(String name)`	`firstname NOT LIKE name`
`Containing`在字符串上	`findByFirstnameContaining(String name)`	`firstname LIKE '%' + name +'%'`
`NotContaining`在字符串上	`findByFirstnameNotContaining(String name)`	`firstname NOT LIKE '%' + name +'%'`
`(No keyword)`	`findByFirstname(String name)`	`firstname = name`
`Not`	`findByFirstnameNot(String name)`	`firstname != name`
`IsTrue`,`True`	`findByActiveIsTrue()`	`active IS TRUE`
`IsFalse`,`False`	`findByActiveIsFalse()`	`active IS FALSE`

1	该方法显示对具有给定 . 通过分析可与和连接的约束的方法名称来派生查询。因此，方法名称将生成 .`firstnameAndOrSELECT … FROM person WHERE firstname = :firstname`
2	该方法显示对所有具有给定的人的查询，一旦给定发出。`firstnamefirstnamePublisher`
3	用于将偏移量和排序参数传递到数据库。`Pageable`
4	查找给定条件的单个实体。它以非唯一结果完成。`IncorrectResultSizeDataAccessException`
5	除非 <4>，否则即使查询生成更多结果行，也始终发出第一个实体。
6	该方法显示对具有给定姓氏的所有人员的查询。`findByLastname`
7	对仅投影和列的单个实体的查询。带批注的查询使用本机绑定标记，在此示例中，这些标记是 Postgres 绑定标记。`Personfirstnamelastname`

表 1.查询方法支持的关键字
关键词	样本	合乎逻辑的结果
`After`	`findByBirthdateAfter(Date date)`	`birthdate > date`
`GreaterThan`	`findByAgeGreaterThan(int age)`	`age > age`
`GreaterThanEqual`	`findByAgeGreaterThanEqual(int age)`	`age >= age`
`Before`	`findByBirthdateBefore(Date date)`	`birthdate < date`
`LessThan`	`findByAgeLessThan(int age)`	`age < age`
`LessThanEqual`	`findByAgeLessThanEqual(int age)`	`age <= age`
`Between`	`findByAgeBetween(int from, int to)`	`age BETWEEN from AND to`
`NotBetween`	`findByAgeNotBetween(int from, int to)`	`age NOT BETWEEN from AND to`
`In`	`findByAgeIn(Collection<Integer> ages)`	`age IN (age1, age2, ageN)`
`NotIn`	`findByAgeNotIn(Collection ages)`	`age NOT IN (age1, age2, ageN)`
`IsNotNull`,`NotNull`	`findByFirstnameNotNull()`	`firstname IS NOT NULL`
`IsNull`,`Null`	`findByFirstnameNull()`	`firstname IS NULL`
`Like`, ,`StartingWithEndingWith`	`findByFirstnameLike(String name)`	`firstname LIKE name`
`NotLike`,`IsNotLike`	`findByFirstnameNotLike(String name)`	`firstname NOT LIKE name`
`Containing`在字符串上	`findByFirstnameContaining(String name)`	`firstname LIKE '%' + name +'%'`
`NotContaining`在字符串上	`findByFirstnameNotContaining(String name)`	`firstname NOT LIKE '%' + name +'%'`
`(No keyword)`	`findByFirstname(String name)`	`firstname = name`
`Not`	`findByFirstnameNot(String name)`	`firstname != name`
`IsTrue`,`True`	`findByActiveIsTrue()`	`active IS TRUE`
`IsFalse`,`False`	`findByActiveIsFalse()`	`active IS FALSE`

修改查询

前面的部分介绍如何声明查询以访问给定实体或实体集合。使用上表中的关键字可以与删除匹配行的派生查询结合使用，也可以用于创建派生查询。delete…Byremove…By

例 2. 查询Delete…By

interface ReactivePersonRepository extends ReactiveSortingRepository<Person, String> {

  Mono<Integer> deleteByLastname(String lastname);            (1)

  Mono<Void> deletePersonByLastname(String lastname);         (2)

  Mono<Boolean> deletePersonByLastname(String lastname);      (3)
}

1	使用 return type of 返回受影响的行数。`Mono<Integer>`
2	仅使用报告行是否已成功删除，而不发出结果值。`Void`
3	使用报告是否至少删除了一行。`Boolean`

由于此方法对于全面的自定义功能是可行的，因此可以通过使用批注查询方法来修改只需要参数绑定的查询，如以下示例所示：@Modifying

@Modifying
@Query("UPDATE person SET firstname = :firstname where lastname = :lastname")
Mono<Integer> setFixedFirstnameFor(String firstname, String lastname);

修改查询的结果可以是：

Void（或 Kotlin ）放弃更新计数并等待完成。Unit
Integer或发出受影响行计数的其他数值类型。
Boolean以发出是否至少更新了一行。

注释仅与注释结合使用。派生的自定义方法不需要此批注。@Modifying@Query

修改查询是直接针对数据库执行的。不会调用任何事件或回调。因此，如果具有审核批注的字段未在批注查询中更新，则这些字段也不会更新。

或者，您可以使用 Spring 数据存储库的自定义实现中描述的功能添加自定义修改行为。

1	使用 return type of 返回受影响的行数。`Mono<Integer>`
2	仅使用报告行是否已成功删除，而不发出结果值。`Void`
3	使用报告是否至少删除了一行。`Boolean`

用`@Query`

下面的示例演示如何使用声明查询方法：@Query

使用 @Query 声明查询方法

interface UserRepository extends ReactiveCrudRepository<User, Long> {

  @Query("select firstName, lastName from User u where u.emailAddress = :email")
  Flux<User> findByEmailAddress(@Param("email") String email);
}

请注意，基于字符串的查询不支持分页，也不接受、，并且作为查询参数，对于这些查询，需要重写查询。如果要应用限制，请使用 SQL 表达此意图，并自行将相应的参数绑定到查询。SortPageRequestLimit

Spring 完全支持 Java 8 基于编译器标志的参数名称发现。通过在生成中使用此标志作为调试信息的替代方法，可以省略命名参数的批注。-parameters@Param

使用 SpEL 表达式进行查询

查询字符串定义可以与 SpEL 表达式一起使用，以在运行时创建动态查询。 SpEL 表达式可以提供谓词值，这些值在运行查询之前进行计算。

表达式通过包含所有参数的数组公开方法参数。以下查询用于声明（等效于参数绑定）的谓词值：[0]lastname:lastname

@Query("SELECT * FROM person WHERE lastname = :#{[0]}")
Flux<Person> findByQueryWithExpression(String lastname);

查询字符串中的 SpEL 是增强查询的有效方法。但是，他们也可以接受各种不需要的论点。应确保在将字符串传递给查询之前对其进行清理，以避免对查询进行不必要的更改。

表达式支持可通过查询 SPI 进行扩展：。查询 SPI 可以提供属性和函数，并可以自定义根对象。在生成查询时，在 SpEL 评估时从应用程序上下文中检索扩展。org.springframework.data.spel.spi.EvaluationContextExtension

将 SpEL 表达式与纯参数结合使用时，请使用命名参数表示法而不是本机绑定标记，以确保正确的绑定顺序。

Spring 完全支持 Java 8 基于编译器标志的参数名称发现。通过在生成中使用此标志作为调试信息的替代方法，可以省略命名参数的批注。-parameters@Param

将 SpEL 表达式与纯参数结合使用时，请使用命名参数表示法而不是本机绑定标记，以确保正确的绑定顺序。

修改查询

用@Query

使用 SpEL 表达式进行查询

用`@Query`