上一篇Spring JavaConfig中配置數(shù)據(jù)源使用了JPA,這里就介紹一下Spring data jpa的常用方法.

spring data jpa介紹

什么是JPA

JPA(Java Persistence API)是Sun官方提出的Java持久化規(guī)范。它為Java開發(fā)人員提供了一種對象/關(guān)聯(lián)映射工具來管理Java應(yīng)用中的關(guān)系數(shù)據(jù)。

Spring Data JPA 是 Spring 基于 ORM 框架、JPA 規(guī)范的基礎(chǔ)上封裝的一套JPA應(yīng)用框架，可使開發(fā)者用極簡的代碼即可實(shí)現(xiàn)對數(shù)據(jù)的訪問和操作。它提供了包括增刪改查等在內(nèi)的常用功能，且易于擴(kuò)展！學(xué)習(xí)并使用 Spring Data JPA 可以極大提高開發(fā)效率！

spring data jpa讓我們解脫了DAO層的操作，基本上所有CRUD都可以依賴于它來實(shí)現(xiàn)

簡單查詢

基本查詢也分為兩種，一種是spring data默認(rèn)已經(jīng)實(shí)現(xiàn)，一種是根據(jù)查詢的方法來自動解析成SQL。

spring data jpa 默認(rèn)預(yù)先生成了一些基本的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);

具體的關(guān)鍵字，使用方法和生產(chǎn)成SQL如下表所示

分頁查詢

Page<Item> findALL(Pageable pageable);

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

自定義SQL查詢

在SQL的查詢方法上面使用@Query注解，如涉及到刪除和修改在需要加上@Modifying.也可以根據(jù)需要添加 @Transactional 對事物的支持

//自定分頁查詢 一條查詢數(shù)據(jù),一條查詢數(shù)據(jù)量
@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);

命名查詢

在實(shí)體類上使用@NameQueries注解

在自己實(shí)現(xiàn)的DAO的Repository接口里面定義一個(gè)同名的方法

然后就可以使用了，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實(shí)體類里@NamedQuery寫對應(yīng)的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是怎么通過這些規(guī)范來進(jìn)行組裝成查詢語句呢?

Spring Data JPA框架在進(jìn)行方法名解析時(shí)，會先把方法名多余的前綴截取掉，比如 find、findBy、read、readBy、get、getBy，然后對剩下部分進(jìn)行解析。

假如創(chuàng)建如下的查詢：findByUserDepUuid()，框架在解析該方法時(shí)，首先剔除 findBy，然后對剩下的屬性進(jìn)行解析

1. 先判斷 userDepUuid （根據(jù) POJO 規(guī)范，首字母變?yōu)樾懀┦欠駷椴樵儗?shí)體的一個(gè)屬性，如果是，則表示根據(jù)該屬性進(jìn)行查詢；如果沒有該屬性，繼續(xù)第二步；
2. 從右往左截取第一個(gè)大寫字母開頭的字符串此處為Uuid），然后檢查剩下的字符串是否為查詢實(shí)體的一個(gè)屬性，如果是，則表示根據(jù)該屬性進(jìn)行查詢；如果沒有該屬性，則重復(fù)第二步，繼續(xù)從右往左截取；最后假設(shè)user為查詢實(shí)體的一個(gè)屬性；
3. 接著處理剩下部分（DepUuid），先判斷 user 所對應(yīng)的類型是否有depUuid屬性，如果有，則表示該方法最終是根據(jù) Doc.user.depUuid 的取值進(jìn)行查詢；否則繼續(xù)按照步驟 2 的規(guī)則從右往左截取，最終表示根據(jù) Doc.user.dep.uuid 的值進(jìn)行查詢。
4. 可能會存在一種特殊情況，比如 Doc包含一個(gè) user 的屬性，也有一個(gè) userDep 屬性，此時(shí)會存在混淆。可以明確在屬性之間加上 "_" 以顯式表達(dá)意圖，比如 findByUser_DepUuid() 或者 findByUserDep_uuid()

原文鏈接:Spring Data JPA 的使用 | 火堯