跳到主要内容

仓库查询关键词

Doubao 中英对照 Repository query keywords

受支持的查询方法主题关键词​

下表列出了 Spring Data 仓库查询派生机制普遍支持的、用于表达谓词的主题关键词。有关受支持关键词的确切列表，请查阅特定存储的文档，因为此处列出的某些关键词在特定存储中可能不受支持。

表 1. 查询主题关键词

关键词描述
find…By, read…By, get…By, query…By, search…By, stream…By通用查询方法，通常返回仓库类型、Collection 或 Streamable 子类型，或结果包装器（如 Page、GeoResults 或任何其他特定存储的结果包装器）。可用作 findBy…、findMyDomainTypeBy…，或与其他关键词组合使用。
exists…By存在性投影，通常返回 boolean 结果。
count…By计数投影，返回数值结果。
delete…By, remove…By删除查询方法，不返回结果（void）或返回删除条数。
…First<number>…, …Top<number>…将查询结果限制为前 <number> 条结果。该关键词可出现在主题中 find（及其他关键词）与 by 之间的任意位置。
…Distinct…使用 distinct 查询仅返回唯一结果。是否支持该功能请查阅特定存储的文档。该关键词可出现在主题中 find（及其他关键词）与 by 之间的任意位置。

保留方法​

下表列出使用预定义功能（定义于 CrudRepository 中）的保留方法。这些方法直接在仓库代理的底层（特定存储）实现上调用。另请参阅「定义查询方法」。

表 2. 保留方法

deleteAllById(Iterable<ID> identifiers)
deleteById(ID identifier)
existsById(ID identifier)
findAllById(Iterable<ID> identifiers)
findById(ID identifier)

受支持的查询方法谓词关键词与修饰符​

下表列出了 Spring Data 仓库查询派生机制普遍支持的谓词关键词。但是，有关受支持关键词的确切列表，请查阅特定存储的文档，因为此处列出的某些关键词在特定存储中可能不受支持。

表 3. 查询谓词关键词

逻辑关键词关键词表达式
ANDAnd
OROr
AFTERAfter, IsAfter
BEFOREBefore, IsBefore
CONTAININGContaining, IsContaining, Contains
BETWEENBetween, IsBetween
ENDING_WITHEndingWith, IsEndingWith, EndsWith
EXISTSExists
FALSEFalse, IsFalse
GREATER_THANGreaterThan, IsGreaterThan
GREATER_THAN_EQUALSGreaterThanEqual, IsGreaterThanEqual
INIn, IsIn
ISIs, Equals,（或无关键词）
IS_EMPTYIsEmpty, Empty
IS_NOT_EMPTYIsNotEmpty, NotEmpty
IS_NOT_NULLNotNull, IsNotNull
IS_NULLNull, IsNull
LESS_THANLessThan, IsLessThan
LESS_THAN_EQUALLessThanEqual, IsLessThanEqual
LIKELike, IsLike
NEARNear, IsNear
NOTNot, IsNot
NOT_INNotIn, IsNotIn
NOT_LIKENotLike, IsNotLike
REGEXRegex, MatchesRegex, Matches
STARTING_WITHStartingWith, IsStartingWith, StartsWith
TRUETrue, IsTrue
WITHINWithin, IsWithin

除过滤谓词外，还支持以下修饰符列表：

表 4. 查询谓词修饰符关键词

关键词描述
IgnoreCase, IgnoringCase与谓词关键词一起使用，用于不区分大小写的比较。
AllIgnoreCase, AllIgnoringCase对所有适用属性忽略大小写。用于查询方法谓词中的某处。
OrderBy…指定静态排序顺序，后接属性路径和方向（例如 OrderByFirstnameAscLastnameDesc）。