跳到主要内容
版本:4.1.1

仓库查询关键字

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…使用去重查询,仅返回唯一结果。请参阅特定于存储的文档了解是否支持该功能。该关键字可以出现在主语中 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)。