对于最新的稳定版本,请使用 Spring Data Commons 3.3.1

对于最新的稳定版本,请使用 Spring Data Commons 3.3.1

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

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

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

find…By, , , , ,read…Byget…Byquery…Bysearch…Bystream…By

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

exists…By

存在投影,通常返回结果。boolean

count…By

计数投影返回数值结果。

delete…By,remove…By

删除查询方法不返回结果 () 或删除计数。void

…First<number>…,…Top<number>…

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

…Distinct…

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

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

find…By, , , , ,read…Byget…Byquery…Bysearch…Bystream…By

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

exists…By

存在投影,通常返回结果。boolean

count…By

计数投影返回数值结果。

delete…By,remove…By

删除查询方法不返回结果 () 或删除计数。void

…First<number>…,…Top<number>…

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

…Distinct…

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

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

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

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

AND

And

OR

Or

AFTER

After,IsAfter

BEFORE

Before,IsBefore

CONTAINING

Containing, ,IsContainingContains

BETWEEN

Between,IsBetween

ENDING_WITH

EndingWith, ,IsEndingWithEndsWith

EXISTS

Exists

FALSE

False,IsFalse

GREATER_THAN

GreaterThan,IsGreaterThan

GREATER_THAN_EQUALS

GreaterThanEqual,IsGreaterThanEqual

IN

In,IsIn

IS

Is、 、 (或无关键字)Equals

IS_EMPTY

IsEmpty,Empty

IS_NOT_EMPTY

IsNotEmpty,NotEmpty

IS_NOT_NULL

NotNull,IsNotNull

IS_NULL

Null,IsNull

LESS_THAN

LessThan,IsLessThan

LESS_THAN_EQUAL

LessThanEqual,IsLessThanEqual

LIKE

Like,IsLike

NEAR

Near,IsNear

NOT

Not,IsNot

NOT_IN

NotIn,IsNotIn

NOT_LIKE

NotLike,IsNotLike

REGEX

Regex, ,MatchesRegexMatches

STARTING_WITH

StartingWith, ,IsStartingWithStartsWith

TRUE

True,IsTrue

WITHIN

Within,IsWithin

除了筛选器谓词之外,还支持以下修饰符列表:

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

IgnoreCase,IgnoringCase

与谓词关键字一起使用,进行不区分大小写的比较。

AllIgnoreCase,AllIgnoringCase

忽略所有合适属性的大小写。在查询方法谓词中的某处使用。

OrderBy…

指定静态排序顺序,后跟属性路径和方向(例如)。OrderByFirstnameAscLastnameDesc

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

AND

And

OR

Or

AFTER

After,IsAfter

BEFORE

Before,IsBefore

CONTAINING

Containing, ,IsContainingContains

BETWEEN

Between,IsBetween

ENDING_WITH

EndingWith, ,IsEndingWithEndsWith

EXISTS

Exists

FALSE

False,IsFalse

GREATER_THAN

GreaterThan,IsGreaterThan

GREATER_THAN_EQUALS

GreaterThanEqual,IsGreaterThanEqual

IN

In,IsIn

IS

Is、 、 (或无关键字)Equals

IS_EMPTY

IsEmpty,Empty

IS_NOT_EMPTY

IsNotEmpty,NotEmpty

IS_NOT_NULL

NotNull,IsNotNull

IS_NULL

Null,IsNull

LESS_THAN

LessThan,IsLessThan

LESS_THAN_EQUAL

LessThanEqual,IsLessThanEqual

LIKE

Like,IsLike

NEAR

Near,IsNear

NOT

Not,IsNot

NOT_IN

NotIn,IsNotIn

NOT_LIKE

NotLike,IsNotLike

REGEX

Regex, ,MatchesRegexMatches

STARTING_WITH

StartingWith, ,IsStartingWithStartsWith

TRUE

True,IsTrue

WITHIN

Within,IsWithin

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

IgnoreCase,IgnoringCase

与谓词关键字一起使用,进行不区分大小写的比较。

AllIgnoreCase,AllIgnoringCase

忽略所有合适属性的大小写。在查询方法谓词中的某处使用。

OrderBy…

指定静态排序顺序,后跟属性路径和方向(例如)。OrderByFirstnameAscLastnameDesc