關於Spring data JPA

時間 2019-11-19

標籤關於 spring data jpa 欄目 Spring 简体版

原文原文鏈接

spring data jpajava

JPA(Java Persistence API)是Sun官方提出的Java持久化規範。它爲Java開發人員提供了一種對象/關聯映射工具來管理Java應用中的關係數據。他的出現主要是爲了簡化現有的持久化開發工做和整合ORM技術，結束如今Hibernate，TopLink，JDO等ORM框架各自爲營的局面。值得注意的是，JPA是在充分吸取了現有Hibernate，TopLink，JDO等ORM框架的基礎上發展而來的，具備易於使用，伸縮性強等優勢。從目前的開發社區的反應上看，JPA受到了極大的支持和讚賞，其中就包括了Spring與EJB3.0的開發團隊。
注意:JPA是一套規範，不是一套產品，那麼像Hibernate,TopLink,JDO他們是一套產品，若是說這些產品實現了這個JPA規範，那麼咱們就能夠叫他們爲JPA的實現產品。
spring data jpa
Spring Data JPA 是 Spring 基於 ORM 框架、JPA 規範的基礎上封裝的一套JPA應用框架，可以使開發者用極簡的代碼便可實現對數據的訪問和操做。它提供了包括增刪改查等在內的經常使用功能，且易於擴展！學習並使用 Spring Data JPA 能夠極大提升開發效率！
spring data jpa讓咱們解脫了DAO層的操做，基本上全部CRUD均可以依賴於它來實現mysql

關於spring data jpa查詢spring

基本查詢sql

基本查詢也分爲兩種，一種是spring data默認已經實現，一種是根據查詢的方法來自動解析成SQL。數據庫

預先生成方法json

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

1 繼承JpaRepositorysession

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

2 使用默認方法app

@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);
    // ...
}

就不解釋了根據方法名就看出意思來框架

自定義簡單查詢

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

User findByUserName(String userName);

也使用一些加一些關鍵字And、 Or

User findByUserNameOrEmail(String username, String email);

修改、刪除、統計也是相似語法

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

基本上SQL體系中的關鍵詞均可以使用，例如：LIKE、 IgnoreCase、 OrderBy。

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

具體的關鍵字，使用方法和生產成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(Collectionage)	… 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)

解析方法名--規則說明

一、規則描述

按照Spring data 定義的規則，查詢方法以find|read|get開頭（好比 find、findBy、read、readBy、get、getBy），涉及條件查詢時，條件的屬性用條件關鍵字鏈接，要注意的是：條件屬性首字母需大寫。框架在進行方法名解析時，會先把方法名多餘的前綴截取掉，而後對剩下部分進行解析。
若是方法的最後一個參數是 Sort 或者 Pageable 類型，也會提取相關的信息，以便按規則進行排序或者分頁查詢。
二、舉例說明
好比 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()"。（強烈建議：不管是否存在混淆，都要在不一樣類層級之間加上"_" ，增長代碼可讀性）

分頁查詢

分頁查詢在實際使用中很是廣泛了，spring data jpa已經幫咱們實現了分頁的功能，在查詢的方法中，須要傳入參數Pageable

,當查詢中有多個參數的時候Pageable建議作爲最後一個參數傳入

Page<User> findALL(Pageable pageable);   

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

Pageable 是spring封裝的分頁實現類，使用的時候須要傳入頁數、每頁條數和排序規則

@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);

}

自定義SQL查詢

其實Spring data 覺大部分的SQL均可以根據方法名定義的方式來實現，可是因爲某些緣由咱們想使用自定義的SQL來查詢，spring data也是完美支持的；在SQL的查詢方法上面使用@Query註解，如涉及到刪除和修改在須要加上@Modifying.也能夠根據須要添加 @Transactional 對事物的支持，查詢超時的設置等

@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中有兩種實現方式，第一種是利用hibernate的級聯查詢來實現，第二種是建立一個結果集的接口來接收連表查詢後的結果，這裏主要第二種方式。

首先須要定義一個結果集的接口類。

public interface HotelSummary { 

    City getCity(); 

    String getName(); 

    Double getAverageRating(); 

    default Integer getAverageRatingRounded() {

        return getAverageRating() == null ? null : (int) Math.round(getAverageRating());

    } 

}

查詢的方法返回類型設置爲新建立的接口

@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）自動生產一個代理類來接收返回的結果，代碼彙總使用getXX的形式來獲取

使用流程

建立工程並添加相關依賴

在Spring Boot中使用JPA，咱們在建立工程的時候須要選擇JPA依賴，以下：

這裏寫圖片描述

其餘的步驟和咱們建立一個普通的Spring Boot項目是同樣的，若是小夥伴不瞭解如何建立一個Spring Boot項目能夠參考這篇文章初識Spring Boot框架。

項目建立成功以後，我這裏是使用MySql作演示，所以還須要添加MySql驅動，在pom.xml文件中添加以下依賴：

 <dependency>

            <groupId>mysql</groupId>

            <artifactId>mysql-connector-java</artifactId>

            <version>5.1.40</version>

 </dependency>

配置基本屬性

接下來須要咱們在application.properties中配置數據源和jpa的基本的相關屬性，以下：

spring.datasource.driver-class-name=com.mysql.jdbc.Driver

spring.datasource.url=jdbc:mysql://localhost:3306/jpatest

spring.datasource.username=root

spring.datasource.password=123456
 

spring.jpa.hibernate.ddl-auto=update

spring.jpa.show-sql=true

spring.jackson.serialization.indent_output=true

關於這裏的配置我說以下幾點：

1.第一行表示驅動的名稱，這個和具體的數據庫驅動有關，視狀況而定，我這裏使用了MySql數據庫，因此驅動名爲com.mysql.jdbc.Driver

2.第二行表示數據庫鏈接地址，固然也是視狀況而定

3.第三四行表示數據庫鏈接的用戶名和密碼

4.第五行則配置了實體類維護數據庫表結構的具體行爲，update表示當實體類的屬性發生變化時，表結構跟着更新，這裏咱們也能夠取值create，這個create表示啓動的時候刪除上一次生成的表，並根據實體類從新生成表，這個時候以前表中的數據就會被清空；還能夠取值create-drop，這個表示啓動時根據實體類生成表，可是當sessionFactory關閉的時候表會被刪除；validate表示啓動時驗證明體類和數據表是否一致；none表示啥都不作。

5.第六行表示hibernate在操做的時候在控制檯打印真實的sql語句

6.第七行表示格式化輸出的json字符串

定義映射實體類

接下來，定義相應的實體類，在Project啓動時，系統會根據實體類建立相應的數據表，個人實體類以下：

@Entity

@NamedQuery(name = "Person.withNameAndAddressNamedQuery",

        query = "select p from Person p where p.name=?1 and p.address=?2")

public class Person {
    @Id
    @GeneratedValue
    private Long id;
    private String name;
    private Integer age;
    private String address; 

    public Person() {

    }
    public Person(Long id, String name, Integer age, String address) {

        this.id = id;
        this.name = name;
        this.age = age;
        this.address = address;

    } 

    public Long getId() {

        return id;

    } 
    public void setId(Long id) {

        this.id = id;

    }

    public String getName() {

        return name;

    } 

    public void setName(String name) {

        this.name = name;

    } 

    public Integer getAge() {

        return age;

    } 

    public void setAge(Integer age) {

        this.age = age;

    } 

    public String getAddress() {

        return address;

    } 

    public void setAddress(String address) {

        this.address = address;

    }

}

首先在實體類上咱們使用了@Entity註解，這個表示這是一個和數據庫表映射的實體類，在屬性id上咱們添加了@Id註解，表示該字段是一個id，@GeneratedValue註解則表示該字段自增。@NamedQuery註解表示一個NamedQuery查詢，這裏一個名稱表明一個查詢語句，咱們一會能夠在控制器中直接調用@NamedQuery中的withNameAndAddressNamedQuery方法，該方法表明的查詢語句是select p from Person p where p.name=?1 and p.address=?2。

定義數據訪問接口

OK，作好上面幾個步驟以後，接下來咱們就能夠定義數據訪問接口了，咱們的數據訪問接口須要繼承JpaRepository類，我在數據訪問接口中一共定義了四個方法，以下：

public interface PersonRepository extends JpaRepository<Person, Long> {

    List<Person> findByAddress(String name); 

    Person findByNameAndAddress(String name, String address); 

    @Query("select p from Person p where p.name=:name and p.address=:address")

    Person withNameAndAddressQuery(@Param("name") String name, @Param("address") String address); 

    Person withNameAndAddressNamedQuery(String name, String address); 

}

關於這個數據訪問接口，我說以下幾點：

1.當咱們繼承JpaRepository接口後，咱們就自動具有了以下數據訪問方法：

List<T> findAll();

List<T> findAll(Sort var1);

List<T> findAll(Iterable<ID> var1);

<S extends T> List<S> save(Iterable<S> var1);

void flush();

<S extends T> S saveAndFlush(S var1);

void deleteInBatch(Iterable<T> var1);

void deleteAllInBatch();

T getOne(ID var1);

<S extends T> List<S> findAll(Example<S> var1);

<S extends T> List<S> findAll(Example<S> var1, Sort var2);

2.咱們能夠在接口中定義查詢方法，能夠按照屬性名來查詢，可是方法的命名方式是固定的，好比第一個方法和第二個方法，第一個方法表示根據一個屬性查詢，第二個方法表示根據多個屬性查詢，findBy、And等能夠算做是這裏的查詢關鍵字了，若是寫做其餘名稱則系統不能識別，相似的關鍵字還有Like、Or、Is、Equals、Between等，而這裏的findBy關鍵字又能夠被find、read、readBy、query、queryBy、get、getBy等來代替。

3.在查詢的過程當中咱們也能夠限制查詢結果，這裏使用的關鍵字是top、first等，好比查詢前10條數據咱們能夠寫做：

List<Person> findFirst10ByName(String name);

4.使用NamedQuery來查詢，就是咱們直接在實體類上使用@NamedQuery註解來定義查詢方法和方法名，一個名稱對應一個查詢語句，具體能夠參考咱們上文的實體類

5.咱們也能夠向第三個方法那樣添加@Query註解，當我調用這個方法的時候使用這個註解中的sql語句進行查詢，方法的參數則是註解中的佔位符的值。

編寫測試Controller

數據訪問接口都有了，接下來就是一個Controller了，咱們寫一個簡單的Controller，用來測試一下上文中的數據訪問接口是否正確，以下：

@RestController

public class DataController {

    @Autowired

    PersonRepository personRepository; 

    @RequestMapping("/save")

    public Person save(String name,String address,Integer age) {

        Person person = personRepository.save(new Person(null, name, age, address));

        return person;

    } 

    @RequestMapping("/q1")

    public List<Person> q1(String address) {

        List<Person> people = personRepository.findByAddress(address);

        return people;

    } 

    @RequestMapping("/q2")

    public Person q2(String name, String address) {

        Person people = personRepository.findByNameAndAddress(name, address);

        return people;

    } 

    @RequestMapping("/q3")

    public Person q3(String name, String address) {

        Person person = personRepository.withNameAndAddressQuery(name, address);

        return person;

    } 

    @RequestMapping("/q4")

    public Person q4(String name, String address) {

        Person person = personRepository.withNameAndAddressNamedQuery(name, address);

        return person;

    }

    @RequestMapping("/sort")

    public List<Person> sort() {

        List<Person> people = personRepository.findAll(new Sort(Sort.Direction.ASC, "age"));

        return people;

    }

    @RequestMapping("/page")

    public Page<Person> page(int page,int size){

        Page<Person> all = personRepository.findAll(new PageRequest(page, size));

        return all;

    }

    @RequestMapping("/all")

    public List<Person> all(){

        return personRepository.findAll();

    }

}