对于最新的稳定版本,请使用 Spring Data Commons 3.4.0spring-doc.cn

存储库查询关键字

支持的查询方法主题关键字

下表列出了 Spring Data 存储库查询派生机制通常支持的用于表示谓词的 subject 关键字。 有关支持的关键词的确切列表,请参阅特定于商店的文档,因为此处列出的某些关键词在特定商店中可能不受支持。spring-doc.cn

表 1.查询主题关键字
关键词 描述

find…By, , , , ,read…Byget…Byquery…Bysearch…Bystream…Byspring-doc.cn

常规查询方法,通常返回存储库类型、子类型或结果包装器(如 ,或任何其他特定于存储区的结果包装器)。可用作 ,或与其他关键字结合使用。CollectionStreamablePageGeoResultsfindBy…findMyDomainTypeBy…spring-doc.cn

exists…Byspring-doc.cn

Exists 投影,通常返回结果。booleanspring-doc.cn

count…Byspring-doc.cn

Count 投影返回数值结果。spring-doc.cn

delete…By,remove…Byspring-doc.cn

Delete 查询方法返回 no result () 或 delete count。voidspring-doc.cn

…First<number>…,…Top<number>…spring-doc.cn

将查询结果限制为第一个结果。此关键字可以出现在主题 (和其他关键字) 和 之间的任何位置。<number>findbyspring-doc.cn

…Distinct…spring-doc.cn

使用非重复查询仅返回唯一结果。请查阅特定于商店的文档,了解该功能是否受支持。此关键字可以出现在主题 (和其他关键字) 和 之间的任何位置。findbyspring-doc.cn

保留方法

下表列出了使用预定义功能(如 中所定义)的保留方法。 这些方法是在存储库代理的后备(特定于存储的)实现上直接调用的。 另请参见“定义查询方法”。CrudRepositoryspring-doc.cn

表 2.保留方法

deleteAllById(Iterable<ID> identifiers)spring-doc.cn

deleteById(ID identifier)spring-doc.cn

existsById(ID identifier)spring-doc.cn

findAllById(Iterable<ID> identifiers)spring-doc.cn

findById(ID identifier)spring-doc.cn

支持的查询方法谓词关键字和修饰符

下表列出了 Spring Data 存储库查询派生机制通常支持的谓词关键字。 但是,有关支持的关键词的确切列表,请参阅特定于商店的文档,因为此处列出的某些关键词在特定商店中可能不受支持。spring-doc.cn

表 3.查询谓词关键字
逻辑关键字 关键字表达式

ANDspring-doc.cn

Andspring-doc.cn

ORspring-doc.cn

Orspring-doc.cn

AFTERspring-doc.cn

After,IsAfterspring-doc.cn

BEFOREspring-doc.cn

Before,IsBeforespring-doc.cn

CONTAININGspring-doc.cn

Containing, ,IsContainingContainsspring-doc.cn

BETWEENspring-doc.cn

Between,IsBetweenspring-doc.cn

ENDING_WITHspring-doc.cn

EndingWith, ,IsEndingWithEndsWithspring-doc.cn

EXISTSspring-doc.cn

Existsspring-doc.cn

FALSEspring-doc.cn

False,IsFalsespring-doc.cn

GREATER_THANspring-doc.cn

GreaterThan,IsGreaterThanspring-doc.cn

GREATER_THAN_EQUALSspring-doc.cn

GreaterThanEqual,IsGreaterThanEqualspring-doc.cn

INspring-doc.cn

In,IsInspring-doc.cn

ISspring-doc.cn

Is, , (或无关键字)Equalsspring-doc.cn

IS_EMPTYspring-doc.cn

IsEmpty,Emptyspring-doc.cn

IS_NOT_EMPTYspring-doc.cn

IsNotEmpty,NotEmptyspring-doc.cn

IS_NOT_NULLspring-doc.cn

NotNull,IsNotNullspring-doc.cn

IS_NULLspring-doc.cn

Null,IsNullspring-doc.cn

LESS_THANspring-doc.cn

LessThan,IsLessThanspring-doc.cn

LESS_THAN_EQUALspring-doc.cn

LessThanEqual,IsLessThanEqualspring-doc.cn

LIKEspring-doc.cn

Like,IsLikespring-doc.cn

NEARspring-doc.cn

Near,IsNearspring-doc.cn

NOTspring-doc.cn

Not,IsNotspring-doc.cn

NOT_INspring-doc.cn

NotIn,IsNotInspring-doc.cn

NOT_LIKEspring-doc.cn

NotLike,IsNotLikespring-doc.cn

REGEXspring-doc.cn

Regex, ,MatchesRegexMatchesspring-doc.cn

STARTING_WITHspring-doc.cn

StartingWith, ,IsStartingWithStartsWithspring-doc.cn

TRUEspring-doc.cn

True,IsTruespring-doc.cn

WITHINspring-doc.cn

Within,IsWithinspring-doc.cn

除了 filter 谓词之外,还支持以下修饰符列表:spring-doc.cn

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

IgnoreCase,IgnoringCasespring-doc.cn

与 predicate 关键字一起使用,用于不区分大小写的比较。spring-doc.cn

AllIgnoreCase,AllIgnoringCasespring-doc.cn

对所有合适的属性忽略大小写。在查询方法谓词中的某个位置使用。spring-doc.cn

OrderBy…spring-doc.cn

指定静态排序顺序,后跟属性 path 和 direction (例如 )。OrderByFirstnameAscLastnameDescspring-doc.cn