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 類型）：

1. 先判斷 userAddressZip （根據 POJO 規范，首字母變為小寫，下同）是否為 AccountInfo 的一個屬性，如果是，則表示根據該屬性進行查詢；如果沒有該屬性，繼續第二步；
2. 從右往左截取第一個大寫字母開頭的字符串（此處為 Zip），然后檢查剩下的字符串是否為 AccountInfo 的一個屬性，如果是，則表示根據該屬性進行查詢；如果沒有該屬性，則重復第二步，繼續從右往左截取；最后假設 user 為 AccountInfo 的一個屬性；
3. 接着處理剩下部分（ 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、排序

List<Cus> findBySexOrderByName(String sex); //名稱正序（正序時，推薦此方式，簡單）
List<Cus> findBySexOrderByNameAsc(String sex); //名稱正序（效果同上）
List<Cus> findBySexOrderByNameDesc(String sex); //名稱倒序

 

  3、結果限制

/**
     * 根據父ID，得到排序號最大的bo。
     * 用於預計算新資源的排序號。
     */
Resource findFirstByFather_idOrderByOrderNumDesc(Long fatherId);

User findFirstByOrderByLastnameAsc();

User findTopByOrderByAgeDesc();

Page<User> queryFirst10ByLastname(String lastname, Pageable pageable);

Slice<User> findTop3ByLastname(String lastname, Pageable pageable);

List<User> findFirst10ByLastname(String lastname, Sort sort);

List<User> findTop10ByLastname(String lastname, Pageable pageable);  

 

4、計數

Long countByLastname(String lastname);

 

5、刪除

void deleteByProject_Id(Long id);
void deleteByProject_Cus_id(Long id);