跳到主要内容

仓库查询关键词

DeepSeek V3 中英对照 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）。