在上篇文章springboot(二)：web綜合開發(fā)中簡單介紹了一下spring data jpa的基礎(chǔ)性使用层亿，這篇文章將更加全面的介紹spring data jpa 常見用法以及注意事項旅急。

使用spring data jpa 開發(fā)時，發(fā)現(xiàn)國內(nèi)對spring boot jpa全面介紹的文章比較少案例也比較零碎，因此寫文章總結(jié)一下锁荔。本人也正在翻譯Spring Data JPA 參考指南,有興趣的同學(xué)歡迎聯(lián)系我，一起加入翻譯中！

spring data jpa介紹

首先了解JPA是什么敷硅？

JPA(Java Persistence API)是Sun官方提出的Java持久化規(guī)范。它為Java開發(fā)人員提供了一種對象/關(guān)聯(lián)映射工具來管理Java應(yīng)用中的關(guān)系數(shù)據(jù)愉阎。他的出現(xiàn)主要是為了簡化現(xiàn)有的持久化開發(fā)工作和整合ORM技術(shù)绞蹦，結(jié)束現(xiàn)在Hibernate，TopLink榜旦，JDO等ORM框架各自為營的局面幽七。值得注意的是，JPA是在充分吸收了現(xiàn)有Hibernate章办，TopLink锉走，JDO等ORM框架的基礎(chǔ)上發(fā)展而來的，具有易于使用藕届，伸縮性強等優(yōu)點挪蹭。從目前的開發(fā)社區(qū)的反應(yīng)上看，JPA受到了極大的支持和贊揚休偶，其中就包括了Spring與EJB3.0的開發(fā)團隊梁厉。

注意：JPA是一套規(guī)范，不是一套產(chǎn)品踏兜，那么像Hibernate词顾，TopLink，JDO他們是一套產(chǎn)品碱妆，如果說這些產(chǎn)品實現(xiàn)了這個JPA規(guī)范肉盹，那么我們就可以叫他們?yōu)镴PA的實現(xiàn)產(chǎn)品。

spring data jpa

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

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

基本查詢

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

預(yù)先生成方法

spring data jpa 默認預(yù)先生成了一些基本的CURD的方法面睛，例如：增絮蒿、刪、改等等

1.繼承JpaRepository

public interface UserRepository extends JpaRepository<User, Long> {
}

2.使用默認方法

@Test
public void testBaseQuery() throws Exception {
    User user=new User();
    userRepository.findAll();
    userRepository.findOne(1l);
    userRepository.save(user);
    userRepository.delete(user);
    userRepository.count();
    userRepository.exists(1l);
    // ...
}

就不解釋了根據(jù)方法名就看出意思來

自定義簡單查詢

自定義的簡單查詢就是根據(jù)方法名來自動生成SQL侮穿，主要的語法是findXXBy,readAXXBy,queryXXBy,countXXBy, getXXBy后面跟屬性名稱：

User findByUserName(String userName);

也使用一些加一些關(guān)鍵字And歌径、 Or

User findByUserNameOrEmail(String username, String email);

修改、刪除亲茅、統(tǒng)計也是類似語法

Long deleteById(Long id);
Long countByUserName(String userName)

基本上SQL體系中的關(guān)鍵詞都可以使用回铛，例如：LIKE、IgnoreCase克锣、 OrderBy茵肃。

List<User> findByEmailLike(String email);
User findByUserNameIgnoreCase(String userName);
List<User> findByUserNameOrderByEmailDesc(String email);

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

復(fù)雜查詢

在實際的開發(fā)中我們需要用到分頁袭祟、刪選验残、連表等查詢的時候就需要特殊的方法或者自定義SQL

分頁查詢

分頁查詢在實際使用中非常普遍了，spring data jpa已經(jīng)幫我們實現(xiàn)了分頁的功能巾乳，在查詢的方法中您没，需要傳入?yún)?shù)Pageable ,當查詢中有多個參數(shù)的時候Pageable建議做為最后一個參數(shù)傳入

Page<User> findALL(Pageable pageable);
Page<User> findByUserName(String userName,Pageable pageable);

Pageable是spring封裝的分頁實現(xiàn)類，使用的時候需要傳入頁數(shù)胆绊、每頁條數(shù)和排序規(guī)則氨鹏。

@Test
public void testPageQuery() throws Exception {
    int page=1,size=10;
    Sort sort = new Sort(Direction.DESC, "id");
    Pageable pageable = new PageRequest(page, size, sort);
    userRepository.findALL(pageable);
    userRepository.findByUserName("testName", pageable);
}

限制查詢

有時候我們只需要查詢前N個元素，或者支取前一個實體压状。

ser findFirstByOrderByLastnameAsc();
User findTopByOrderByAgeDesc();
Page<User> queryFirst10ByLastname(String lastname, Pageable pageable);
List<User> findFirst10ByLastname(String lastname, Sort sort);
List<User> findTop10ByLastname(String lastname, Pageable pageable);

自定義SQL查詢

其實Spring data 覺大部分的SQL都可以根據(jù)方法名定義的方式來實現(xiàn)仆抵，但是由于某些原因我們想使用自定義的SQL來查詢，spring data也是完美支持的种冬；在SQL的查詢方法上面使用@Query注解镣丑，如涉及到刪除和修改在需要加上@Modifying.也可以根據(jù)需要添加 @Transactional 對事物的支持，查詢超時的設(shè)置等

@Modifying
@Query("update User u set u.userName = ?1 where c.id = ?2")
int modifyByIdAndUserId(String  userName, Long id);
    
@Transactional
@Modifying
@Query("delete from User where id = ?1")
void deleteByUserId(Long id);
  
@Transactional(timeout = 10)
@Query("select u from User u where u.emailAddress = ?1")
    User findByEmailAddress(String emailAddress);

多表查詢

多表查詢在spring data jpa中有兩種實現(xiàn)方式娱两，第一種是利用hibernate的級聯(lián)查詢來實現(xiàn)莺匠，第二種是創(chuàng)建一個結(jié)果集的接口來接收連表查詢后的結(jié)果，這里主要第二種方式十兢。

首先需要定義一個結(jié)果集的接口類趣竣。

public interface HotelSummary {
    City getCity();
    String getName();
    Double getAverageRating();
    default Integer getAverageRatingRounded() {
        return getAverageRating() == null ? null : (int) Math.round(getAverageRating());
    }
}

查詢的方法返回類型設(shè)置為新創(chuàng)建的接口

@Query("select h.city as city, h.name as name, avg(r.rating) as averageRating "
        - "from Hotel h left outer join h.reviews r where h.city = ?1 group by h")
Page<HotelSummary> findByCity(City city, Pageable pageable);

@Query("select h.name as name, avg(r.rating) as averageRating "
        - "from Hotel h left outer join h.reviews r  group by h")
Page<HotelSummary> findByCity(Pageable pageable);

使用

Page<HotelSummary> hotels = this.hotelRepository.findByCity(new PageRequest(0, 10, Direction.ASC, "name"));
for(HotelSummary summay:hotels){
        System.out.println("Name" +summay.getName());
    }

在運行中Spring會給接口（HotelSummary）自動生產(chǎn)一個代理類來接收返回的結(jié)果，代碼匯總使用getXX的形式來獲取

多數(shù)據(jù)源的支持

同源數(shù)據(jù)庫的多源支持

日常項目中因為使用的分布式開發(fā)模式纪挎，不同的服務(wù)有不同的數(shù)據(jù)源期贫，常常需要在一個項目中使用多個數(shù)據(jù)源跟匆，因此需要配置sping data jpa對多數(shù)據(jù)源的使用异袄，一般分一下為三步：

• 1 配置多數(shù)據(jù)源
• 2 不同源的實體類放入不同包路徑
• 3 聲明不同的包路徑下使用不同的數(shù)據(jù)源、事務(wù)支持

這里有一篇文章寫的很清楚：Spring Boot多數(shù)據(jù)源配置與使用

異構(gòu)數(shù)據(jù)庫多源支持

比如我們的項目中玛臂，即需要對mysql的支持烤蜕，也需要對mongodb的查詢等封孙。

實體類聲明@Entity關(guān)系型數(shù)據(jù)庫支持類型、聲明@Document為mongodb支持類型讽营，不同的數(shù)據(jù)源使用不同的實體就可以了

interface PersonRepository extends Repository<Person, Long> {
 …
}

@Entity
public class Person {
  …
}

interface UserRepository extends Repository<User, Long> {
 …
}

@Document
public class User {
  …
}

但是虎忌，如果User用戶既使用mysql也使用mongodb呢，也可以做混合使用

interface JpaPersonRepository extends Repository<Person, Long> {
 …
}

interface MongoDBPersonRepository extends Repository<Person, Long> {
 …
}

@Entity
@Document
public class Person {
  …
}

也可以通過對不同的包路徑進行聲明橱鹏，比如A包路徑下使用mysql,B包路徑下使用mongoDB

@EnableJpaRepositories(basePackages = "com.neo.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.neo.repositories.mongo")
interface Configuration { }

其它

使用枚舉

使用枚舉的時候膜蠢，我們希望數(shù)據(jù)庫中存儲的是枚舉對應(yīng)的String類型，而不是枚舉的索引值莉兰，需要在屬性上面添加@Enumerated(EnumType.STRING)注解挑围。

@Enumerated(EnumType.STRING) 
@Column(nullable = true)
private UserType type;

不需要和數(shù)據(jù)庫映射的屬性

正常情況下我們在實體類上加入注解@Entity，就會讓實體類和表相關(guān)連如果其中某個屬性我們不需要和數(shù)據(jù)庫來關(guān)聯(lián)只是在展示的時候做計算糖荒，只需要加上@Transient屬性既可杉辙。

@Transient
private String  userName;

源碼案例

這里有一個開源項目幾乎使用了這里介紹的所有標簽和布局，大家可以參考： cloudfavorites

參考

• Spring Data JPA - Reference Documentation
• Spring Data JPA——參考文檔 中文版

往期回顧

• Spring Boot系列(四)：thymeleaf使用詳解
• Spring Boot系列(三)：Spring Boot中Redis的使用
• Spring Boot系列(二)：web綜合開發(fā)
• Spring Boot系列(一)：Spring Boot 入門篇

作者：純潔的微笑
出處：www.ityouknow.com
版權(quán)所有捶朵，歡迎保留原文鏈接進行轉(zhuǎn)載：)