查询方法

您通常在存储库上触发的多数数据访问操作都会导致对数据库运行查询。定义此类查询是通过在存储库接口上声明一个方法来实现的，如下面的示例所示。

示例 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	该方法展示了对所有具有给定 `firstname` 的人的查询。查询是通过解析方法名称以查找可以与 `And` 和 `Or` 连接的约束来推导的。因此，方法名称会生成一个查询表达式 `SELECT … FROM person WHERE firstname = :firstname`。
2	该方法展示了对所有具有给定 `firstname` 的人的查询，前提是 `firstname` 由给定的 `Publisher` 发出。
3	使用 `Pageable` 将偏移量和排序参数传递给数据库。
4	查找给定条件下的单个实体。如果结果不唯一，则以 `IncorrectResultSizeDataAccessException` 结束。
5	除非 <4>，否则即使查询产生多个结果行，也会始终发出第一个实体。
6	`findByLastname` 方法展示了对所有具有给定姓氏的人的查询。
7	对单个 `Person` 实体的查询，仅投影 `firstname` 和 `lastname` 列。注释的查询使用原生绑定标记，在本例中为 Postgres 绑定标记。

请注意，在 @Query 注解中使用的 select 语句的列必须与 NamingStrategy 为相应属性生成的名称匹配。如果 select 语句不包含匹配的列，则该属性不会被设置。如果该属性是持久化构造函数所需的，则提供 null 或（对于基本类型）默认值。

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

表 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`, `StartingWith`, `EndingWith`	`findByFirstnameLike(String name)`	`firstname LIKE name`
`NotLike`, `IsNotLike`	`findByFirstnameNotLike(String name)`	`firstname NOT LIKE name`
`Containing` on String	`findByFirstnameContaining(String name)`	`firstname LIKE '%' + name +'%'`
`NotContaining` on String	`findByFirstnameNotContaining(String name)`	`firstname NOT LIKE '%' + name +'%'`
`(无关键字)`	`findByFirstname(String name)`	`firstname = name`
`Not`	`findByFirstnameNot(String name)`	`firstname != name`
`IsTrue`, `True`	`findByActiveIsTrue()`	`active IS TRUE`
`IsFalse`, `False`	`findByActiveIsFalse()`	`active IS FALSE`

修改查询

前面的部分描述了如何声明查询以访问给定的实体或实体集合。可以使用前面表格中的关键字与delete…By或remove…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	使用`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 Data Repositories 的自定义实现中描述的功能来添加自定义修改行为。

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

请注意，基于字符串的查询不支持分页，也不接受Sort、PageRequest和Limit作为查询参数，因为对于这些查询，需要重写查询。如果您想应用限制，请使用 SQL 表达此意图，并将适当的参数绑定到查询本身。

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

带有 SpEL 表达式的查询

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

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

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

查询字符串中的 SpEL 可以是增强查询的强大方法。但是，它们也可以接受各种不必要的参数。您应该确保在将字符串传递给查询之前对其进行清理，以避免对查询进行不必要的更改。

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

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

查询方法

修改查询

使用@Query

带有 SpEL 表达式的查询

使用`@Query`