spring data學習筆記一

目錄

Spring Data 概述

Spring Data Jpa HelloWorld 

 Repository 接口

 SpringData 方法定義規範

查詢方法解析流程 

 使用 @Query 註解

@Modifying 註解和事務 

 CrudRepository 接口

PagingAndSortingRepository接口

JpaRepository接口 

 JpaSpecificationExecutor接口

爲某一個 Repository 上添加自定義方法

 爲所有的 Repository 都添加自實現的方法


 

  • Spring Data 概述

Spring Data : Spring 的一個子項。用於簡化數據庫訪問,支持NoSQL 關係數據存儲其主要目標是使數據庫的訪問變得方便快捷。  

SpringData 目所支持 NoSQL 存儲MongoDB(文檔數據庫)Neo4j(圖形數據庫)Redis(鍵/值存儲)Hbase(列族數據庫)

SpringData 項目所支持的關係數據存儲技術JDBC,JPA

JPA Spring Data : 力於減少數據訪問(DAO) 開發. 開發者唯一要做的,就只是聲明持久層的接口,其他都交給 Spring Data JPA 來幫你完成

  • Spring Data Jpa HelloWorld 

使用 Spring Data JPA 進行持久層開發需個步驟:

Spring 整合 JPA

Spring 配置文件中配置 Spring DataSpring 爲聲明的接口創建代理對象。配置了 <jpa:repositories> 後,Spring 初始化容器時將會掃描 base-package  指定的包目錄及其子目錄,爲繼承 Repository 或其子接口的接口創建代理對象,並將代理對象註冊爲 Spring Bean,業務層便可以通過 Spring 自動封裝的特性來直接使用該對象

聲明持久層的接口,該接口繼承  RepositoryRepository 是一個標記型接口,它不包含任何方法,如必要Spring Data 可實現 Repository 其他子接口,其中定義了一些常用的增刪改查,以及分頁相關的方法。

在接口中聲明需要的方Spring Data 將根據給定的策略(具體策略稍後講解)來爲其生成實現代碼。

  •  Repository 接口

Repository 接口是 Spring Data 的一個核心接口,它不提供任何方法,開發者需要在自己定義的接口中聲明需要的方法 

    public interface Repository<T, ID extends Serializable> { } 

Spring Data可以讓我們只定義接口,只要遵循 Spring Data的規範,就無需寫實現類。 

繼承 Repository 等價的一種方式,就是在持久層接口上使用 @RepositoryDefinition 註解,併爲其指定 domainClass idClass 屬性。如下兩種方式是完全等價的

基礎的 Repository 提供了最基本的數據訪問功能,其幾個子接口則擴展了一些功能。它們的繼承關係如下: 

Repository: 僅僅是一個標識,表明任何繼承它的均爲倉庫接口

CrudRepository繼承 Repository,實現了一CRUD 相關的方法 

PagingAndSortingRepository繼承 CrudRepository,實現了一組分頁排序相關的方法 

JpaRepository繼承 PagingAndSortingRepository,實現一JPA 規範相關的方法 

自定義的 XxxxRepository 需要繼承 JpaRepository,這樣的 XxxxRepository 接口就具備了通用的數據訪問控制層的能力。

JpaSpecificationExecutor屬於Repository體系,實現一JPA Criteria 詢相關的方法 

  •  SpringData 方法定義規範

簡單條件查詢: 查詢某一個實體類或者集合 

按照 Spring Data 的規範查詢方法find | read | get 開頭, 
涉及條件查詢時,條件的屬性用條件關鍵字連接,要注意的是:條件屬性以首字母大寫 

例如:定義一Entity 實體類 
class User{ 
  private String firstName
  private String lastName
} 
使用And條件連接時,應這樣寫: 
findByLastNameAndFirstName(String lastName,String firstName); 
條件的屬性名稱與個數要與參數的位置與個數一一對應

直接在接口中定義查詢方法,如果是符合規範的,可以不用寫實現,目前支持的關鍵字寫法如下: 

 

 

  • 查詢方法解析流程 

假如創建如下的查詢:findByUserDepUuid(),框架在解析該方法時,首先剔除 findBy,然後對剩下的屬性進行解析,假設查詢實體爲Doc

判斷 userDepUuid (根據 POJO 規範,首字母變爲小寫)是否爲查詢實體的一個屬性,如果是,則表示根據該屬性進行查詢;如果沒有該屬性,繼續第二步;

右往左截取第一個大寫字母開頭的字符串(此處Uuid)然後檢查剩下的字符串是否爲查詢實體的一個屬性,如果是,則表示根據該屬性進行查詢;如果沒有該屬性,則重複第二步,繼續從右往左截取;最後假設 user 查詢實體的一個屬性;

接着處理剩下部分(DepUuid),先判斷 user 所對應的類型是否有depUuid屬性,如果有,則表示該方法最終是根據 “ Doc.user.depUuid的取值進行查詢;否則繼續按照步驟 2 的規則從右往左截取,最終表示根據 “Doc.user.dep.uuid的值進行查詢。

可能會存在一種特殊情況,比如 Doc包含一個 user 的屬性,也有一個 userDep 屬性,此時會存在混淆。可以明確在屬性之間加上 "_" 以顯式表達意圖,比如 "findByUser_DepUuid()" 或者 "findByUserDep_uuid()"

特殊的參數: 還可以直接在方法的參數上加入分頁或排序的參數,比如:

Page<UserModel> findByName(String name, Pageable pageable);

List<UserModel> findByName(String name, Sort sort);

  •  使用 @Query 註解

這種查詢可以聲明Repository 方法中,擺脫像命名查詢那樣的約束,將查詢直接在相應的接口方法中聲明,結構更爲清晰,這Spring data 特有實現。

索引參數如下所示,索引值從1開始,查詢中 ”?X個數需要與方法定義的參數個數相一致,並且順序也要一致 

命名參數(推薦使用這種方式):可以定義好參數名,賦值時採用@Param("參數名"),而不用管順序。

如果@Query 中有 LIKE 關鍵字後面的參數需要前面或者後面%,這樣在傳遞參數值的時候就可以不%

還可以使用@Query來指定本地查詢,只要設置nativeQuerytrue

  • @Modifying 註解和事務 

@Query @Modifying annotation一起聲明,可定義個性化更新操作,例如只涉及某些字段更新時最爲常用

注意:

           –方法的返回值應該int,表示更新語句所影響的行數

           –調用的地方必須加事務,沒有事務不能正常執行

Spring Data 提供了默認的事務處理方式,即所有的查詢均聲明爲只讀事務

對於自定義的方法,如需改變 Spring Data 提供的事務默認方式,可以在方法上註解 @Transactional 聲明

進行多Repository 操作時,也應該使它們在同一個事務中處理,按照分層架構的思想,這部分屬於業務邏輯層,因此,需要Service 實現對多Repository 調用,並在相應的方法上聲明事務

  •  CrudRepository 接口

CrudRepository 接口提供了最基本的對實體類的添刪改查操作 

T save(T entity);//保存單個實體 

Iterable<T> save(Iterable<? extends T> entities);//保存集合       

T findOne(ID id);//根據id查找實體        

boolean exists(ID id);//根據id判斷實體是否存在        

Iterable<T> findAll();//查詢所有實體,不用或慎用       

long count();//查詢實體數量        

void delete(ID id);//根據Id刪除實體        

void delete(T entity);//刪除一個實體 

void delete(Iterable<? extends T> entities);//刪除一個實體的集合        

void deleteAll();//刪除所有實體,不用或慎用

  • PagingAndSortingRepository接口

 

接口提供了分頁與排序功能

Iterable<T> findAll(Sort sort); //排序

Page<T> findAll(Pageable pageable); //分頁查詢(含排序功能)

  • JpaRepository接口 

該接口提供了JPA的相關功能

List<T> findAll(); //查找所有實體

List<T> findAll(Sort sort); //排序、查找所有實體

List<T> save(Iterable<? extends T> entities);//保存集合

void flush();//執行緩存與數據庫同步

T saveAndFlush(T entity);//強制執行持久化

void deleteInBatch(Iterable<T> entities);//刪除一個實體集合

  •  JpaSpecificationExecutor接口

不屬於Repository體系,實現一組 JPA Criteria 查詢相關的方法 

Specification:封裝  JPA Criteria 查詢條件。通常使用匿名內部類的方式來創建該接口的對象  

  • 爲某一個 Repository 上添加定義方法

步驟:

定義一個接口: 聲明要添加的, 並自實現的方法

提供該接口的實現類: 類名需在要聲明的 Repository 後添加 Impl, 並實現方法

聲明 Repository 接口, 並繼承 1) 聲明的接口

使用.

注意: 默認情況下, Spring Data 會在 base-package 中查找 "接口名Impl" 作爲實現類. 可以通過 repository-impl-postfix 聲明後綴.

  •  爲所有的 Repository 都添加自實現的方

步驟:

聲明一個接口, 在該接口中聲明需要自定義的方法, 且該接口需要繼承 Spring Data Repository.

提供 1) 所聲明的接口的實現類. 繼承 SimpleJpaRepository, 並提供方法的實現

定義 JpaRepositoryFactoryBean 的實現類, 使其生成 1) 定義的接口實現類的對象

修改 <jpa:repositories /> 節點的 factory-class 屬性指向 3) 的全類名

注意: 全局的擴展實現類不要用 Imp 作爲後綴名, 或爲全局擴展接口添加 @NoRepositoryBean 註解告知  Spring Data: Spring Data 不把其作爲 Repository

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章