Spring Data JPA 的使用

火堯發表於2019-03-02
Spring

上一篇Spring JavaConfig中配置資料來源使用了JPA,這裡就介紹一下Spring data jpa的常用方法.

spring data jpa介紹

什麼是JPA

JPA(Java Persistence API)是Sun官方提出的Java持久化規範。它為Java開發人員提供了一種物件/關聯對映工具來管理Java應用中的關係資料。

Spring Data JPA 是 Spring 基於 ORM 框架、JPA 規範的基礎上封裝的一套JPA應用框架，可使開發者用極簡的程式碼即可實現對資料的訪問和操作。它提供了包括增刪改查等在內的常用功能，且易於擴充套件！學習並使用 Spring Data JPA 可以極大提高開發效率！

spring data jpa讓我們解脫了DAO層的操作，基本上所有CRUD都可以依賴於它來實現

簡單查詢

基本查詢也分為兩種，一種是spring data預設已經實現，一種是根據查詢的方法來自動解析成SQL。

spring data jpa 預設預先生成了一些基本的CURD的方法，例如：增、刪、改等等

public interface ItemRepository extends JpaRepository<Item, Integer>, JpaSpecificationExecutor<Item> {
//空的，可以什麼都不用寫
}複製程式碼
@Test
public void test1() throws Exception {
    Item item = new Item();
    itemRepository.save(item);
    List<Item> itemList = itemRepository.findAll();
    Item one = itemRepository.findOne(1);
    itemRepository.delete(item);
    long count = itemRepository.count();
}複製程式碼

自定義簡單查詢

Item findByItemName(String itemName);

List<Item> findByItemNameLike(String itemName);

Long deleteByItemId(Integer id);

List<Item> findByItemNameLikeOrderByItemNameDesc(String itemName);複製程式碼

具體的關鍵字，使用方法和生產成SQL如下表所示

Keyword Sample JPQL snippet
And findByLastnameAndFirstname … where x.lastname = ?1 and x.firstname = ?2
Or findByLastnameOrFirstname … where x.lastname = ?1 or x.firstname = ?2
Is,Equals findByFirstnameIs,findByFirstnameEquals … where x.firstname = ?1
Between findByStartDateBetween … where x.startDate between ?1 and ?2
LessThan findByAgeLessThan … where x.age < ?1
LessThanEqual findByAgeLessThanEqual … where x.age ⇐ ?1
GreaterThan findByAgeGreaterThan … where x.age > ?1
GreaterThanEqual findByAgeGreaterThanEqual … where x.age >= ?1
After findByStartDateAfter … where x.startDate > ?1
Before findByStartDateBefore … where x.startDate < ?1
IsNull findByAgeIsNull … where x.age is null
IsNotNull,NotNull findByAge(Is)NotNull … where x.age not null
Like findByFirstnameLike … where x.firstname like ?1
NotLike findByFirstnameNotLike … where x.firstname not like ?1
StartingWith findByFirstnameStartingWith … where x.firstname like ?1 (parameter bound with appended %)
EndingWith findByFirstnameEndingWith … where x.firstname like ?1 (parameter bound with prepended %)
Containing findByFirstnameContaining … where x.firstname like ?1 (parameter bound wrapped in %)
OrderBy findByAgeOrderByLastnameDesc … where x.age = ?1 order by x.lastname desc
Not findByLastnameNot … where x.lastname <> ?1
In findByAgeIn(Collection ages) … where x.age in ?1
NotIn findByAgeNotIn(Collection age) … where x.age not in ?1
TRUE findByActiveTrue() … where x.active = true
FALSE findByActiveFalse() … where x.active = false
IgnoreCase findByFirstnameIgnoreCase … where UPPER(x.firstame) = UPPER(?1)

分頁查詢

Page<Item> findALL(Pageable pageable);複製程式碼
@Test
public void test1() throws Exception {
    int page=1,size=10;
    Sort sort = new Sort(Sort.Direction.DESC, "id");//根據id降序排序
    Pageable pageable = new PageRequest(page, size, sort);
    Page<Item> pageResult = itemRepository.findALL(pageable);
    List<Item> itemList = pageResult.getContent();
}複製程式碼

自定義SQL查詢

在SQL的查詢方法上面使用@Query註解，如涉及到刪除和修改在需要加上@Modifying.也可以根據需要新增 @Transactional 對事物的支援

//自定分頁查詢 一條查詢資料,一條查詢資料量
@Query(value = "select i from Item i",
        countQuery = "select count(i.itemId) from Item i")
Page<Item> findall(Pageable pageable);

//nativeQuery = true 本地查詢  就是使用原生SQL查詢
@Query(value = "select * from item  where item_id = ?1", nativeQuery = true)
Item findAllItemById(int id);

@Transactional
@Modifying
@Query("delete from Item i where i.itemId = :itemId")
void deleteInBulkByItemId(@Param(value = "itemId") Integer itemId);

//#{#entityName}就是指定的@Entity,這裡就是Item
 @Query("select i from #{#entityName} i where i.itemId = ?1")
 Item findById(Integer id);複製程式碼

命名查詢

在實體類上使用@NameQueries註解

在自己實現的DAO的Repository介面裡面定義一個同名的方法

然後就可以使用了，Spring會先找是否有同名的NamedQuery，如果有，那麼就不會按照介面定義的方法來解析。

//命名查詢
@NamedQueries({
        @NamedQuery(name = "Item.findItemByitemPrice",
                query = "select i from Item i where i.itemPrice between ?1 and ?2"),
        @NamedQuery(name = "Item.findItemByitemStock",
                query = "select i from Item i where i.itemStock between ?1 and ?2"),
})
@Entity
@Data
public class Item implements Serializable {
    @Id
    @GeneratedValue
    @Column(name = "item_id")
    private int itemId;
    private String itemName;
    private Integer itemPrice;
    private Integer itemStock;
 }複製程式碼
/**
 * 這裡是在domain實體類裡@NamedQuery寫對應的HQL
 * @NamedQuery(name = "Item.findItemByitemPrice",
               baseQuery = "select i from Item i where i.itemPrice between ?1 and ?2"),
 * @param price1
 * @param price2
 * @return
 */
List<Item> findItemByitemPrice(Integer price1, Integer price2);
List<Item> findItemByitemStock(Integer stock1, Integer stock2);複製程式碼

那麼spring data jpa是怎麼通過這些規範來進行組裝成查詢語句呢?

Spring Data JPA框架在進行方法名解析時，會先把方法名多餘的字首擷取掉，比如 find、findBy、read、readBy、get、getBy，然後對剩下部分進行解析。

假如建立如下的查詢：findByUserDepUuid()，框架在解析該方法時，首先剔除 findBy，然後對剩下的屬性進行解析
  1. 先判斷 userDepUuid （根據 POJO 規範，首字母變為小寫）是否為查詢實體的一個屬性，如果是，則表示根據該屬性進行查詢；如果沒有該屬性，繼續第二步；
  2. 從右往左擷取第一個大寫字母開頭的字串此處為Uuid），然後檢查剩下的字串是否為查詢實體的一個屬性，如果是，則表示根據該屬性進行查詢；如果沒有該屬性，則重複第二步，繼續從右往左擷取；最後假設user為查詢實體的一個屬性；
  3. 接著處理剩下部分（DepUuid），先判斷 user 所對應的型別是否有depUuid屬性，如果有，則表示該方法最終是根據 Doc.user.depUuid 的取值進行查詢；否則繼續按照步驟 2 的規則從右往左擷取，最終表示根據 Doc.user.dep.uuid 的值進行查詢。
  4. 可能會存在一種特殊情況，比如 Doc包含一個 user 的屬性，也有一個 userDep 屬性，此時會存在混淆。可以明確在屬性之間加上 “_” 以顯式表達意圖，比如 findByUser_DepUuid() 或者 findByUserDep_uuid()

原文連結:Spring Data JPA 的使用 | 火堯

相關文章