1. 程式人生 > >Spring Data JPA 簡單查詢--方法定義規則(詳解)

Spring Data JPA 簡單查詢--方法定義規則(詳解)

一、常用規則速查

1   And    並且
2   Or      或
3   Is,Equals    等於
4   Between      兩者之間
5   LessThan      小於
6   LessThanEqual     小於等於
7   GreaterThan     大於
8   GreaterThanEqual   大於等於
9   After    之後(時間) >
10  Before    之前(時間) <
11  IsNull        等於Null
12  IsNotNull,NotNull   不等於Null
13  Like    模糊查詢。查詢件中需要自己加 %
14  NotLike     不在模糊範圍內。查詢件中需要自己加 %
15  StartingWith  以某開頭
16  EndingWith    以某結束
17  Containing   包含某
18  OrderBy  排序
19  Not    不等於
20  In     某範圍內
21  NotIn    某範圍外
22  True    真
23  False    假
24  IgnoreCase  忽略大小寫

二、Spring Data 解析方法名--規則說明

1、規則描述

按照Spring data 定義的規則,查詢方法以find|read|get開頭(比如 find、findBy、read、readBy、get、getBy),涉及條件查詢時,條件的屬性用條件關鍵字連線,要注意的是:條件屬性首字母需大寫。框架在進行方法名解析時,會先把方法名多餘的字首擷取掉,然後對剩下部分進行解析。

如果方法的最後一個引數是 Sort 或者 Pageable 型別,也會提取相關的資訊,以便按規則進行排序或者分頁查詢。

2、舉例說明

比如 findByUserAddressZip()。框架在解析該方法時,首先剔除 findBy,然後對剩下的屬性進行解析,詳細規則如下(此處假設該方法針對的域物件為 AccountInfo 型別):

先判斷 userAddressZip (根據 POJO 規範,首字母變為小寫,下同)是否為 AccountInfo 的一個屬性,如果是,則表示根據該屬性進行查詢;如果沒有該屬性,繼續第二步;

從右往左擷取第一個大寫字母開頭的字串(此處為 Zip),然後檢查剩下的字串是否為 AccountInfo 的一個屬性,如果是,則表示根據該屬性進行查詢;如果沒有該屬性,則重複第二步,繼續從右往左擷取;最後假設 user 為 AccountInfo 的一個屬性;

接著處理剩下部分( AddressZip ),先判斷 user 所對應的型別是否有 addressZip 屬性,如果有,則表示該方法最終是根據 "AccountInfo.user.addressZip" 的取值進行查詢;否則繼續按照步驟 2 的規則從右往左擷取,最終表示根據 "AccountInfo.user.address.zip" 的值進行查詢。

可能會存在一種特殊情況,比如 AccountInfo 包含一個 user 的屬性,也有一個 userAddress 屬性,此時會存在混淆。讀者可以明確在屬性之間加上 "_" 以顯式表達意圖,比如 "findByUser_AddressZip()" 或者 "findByUserAddress_Zip()"。(強烈建議:無論是否存在混淆,都要在不同類層級之間加上"_" ,增加程式碼可讀性)

三、一些情況

1、當查詢條件為null時。

舉例說明如下:

實體定義:對於一個客戶實體Cus,包含有name和sex,均是String型別。

查詢方法定義:List<Cus> findByNameAndSex(String name,String sex);

使用時:dao.findByNameAndSex(null, "男");

後臺生成sql片斷:where (cus0_.name is null) and cus0_.sex=?

結論:當查詢時傳值是null時,資料庫中只有該欄位是null的記錄才符合條件,並不是說忽略這個條件。也就是說,這種查詢方式,只適合於明確查詢條件必須傳的業務,對於動態查詢(條件多少是動態的,例如一般的查詢列表,由終端使用者使用時決定輸入那些查詢條件),這種簡單查詢是不能滿足要求的。

2、排序

?
1 2 3 List<Cus> findBySexOrderByName(String sex); //名稱正序(正序時,推薦此方式,簡單) List<Cus> findBySexOrderByNameAsc(String sex); //名稱正序(效果同上) List<Cus> findBySexOrderByNameDesc(String sex); //名稱倒序