Spring Data Jpa框架最佳實踐示例
前言
Spring Data Jpa框架的目標是顯著減少實現各種持久性存儲的數據訪問層所需的樣板代碼量。
Spring Data Jpa存儲庫抽象中的中央接口是Repository。它需要領域實體類以及領域實體ID類型作為類型參數來進行管理。該接口主要用作標記接口，以捕獲要使用的類型並幫助您發現擴展該接口的接口。
CrudRepository、JpaRepository是更具體的數據操作抽象，一般我們在項目中使用的時候定義我們的領域接口然後繼承CrudRepository或JpaRepository即可實現實現基礎的CURD方法瞭，但是這種用法有局限性，不能處理超復雜的查詢，而且稍微復雜的查詢代碼寫起來也不是很優雅，所以下面看看怎麼最優雅的解決這個問題。
擴展接口用法
/**
* @author: kl @kailing.pub
* @date: 2019/11/11
*/
@Repository
public interface SendLogRepository extends JpaRepository {
/**
* 派生的通過解析方法名稱的查詢
* @param templateName
* @return
*/
ListfindSendLogByTemplateName(String templateName);
/**
* HQL
* @param templateName
* @return
*/
@Query(value ="select SendLog from SendLog s where s.templateName = :templateName")
ListfindByTempLateName(String templateName);
/**
* 原生sql
* @param templateName
* @return
*/
@Query(value ="select s.* from sms_sendlog s where s.templateName = :templateName",nativeQuery = true)
ListfindByTempLateNameNative(String templateName);
}
優點：
- 1、這種擴展接口的方式是最常見的用法，繼承JpaRepository接口後，立馬擁有基礎的CURD功能
- 2、還可以通過特定的方法名做解析查詢，這個可以算spring Data Jpa的最特殊的特性瞭。而且主流的IDE對這種使用方式都有比較好的自動化支持，在輸入要解析的方法名時會給出提示。
- 3、可以非常方便的以註解的形式支持HQL和原生SQL
缺陷：
- 1、復雜的分頁查詢支持不好
缺陷就一條，這種擴展接口的方式要實現復雜的分頁查詢，有兩種方式,而且這兩種方式代碼寫起來都不怎麼優雅，而且會把大量的條件拼接邏輯寫在調用查詢的service層。
- 第一種、實例查詢(Example Query)方式:
public void testExampleQuery() {
SendLog log = new SendLog();
log.setTemplateName("kl");
/*
* 註意：withMatcher方法的propertyPath參數值填寫領域對象的字段值，而不是實際的表字段
*/
ExampleMatcher matcher = ExampleMatcher.matching()
.withMatcher("templateName", match -> match.contains());
Example example = Example.of(log, matcher);
Pageable pageable = PageRequest.of(0, 10);
Page logPage = repository.findAll(example, pageable);
}
上面代碼實現的語義是模糊查詢templateName等於"kl"的記錄並分頁，乍一看這個代碼還過得去哈，其實當查詢的條件多一點，這種代碼就會變得又臭又長，而且隻支持基礎的字符串類型的字段查詢，如果查詢條件有時間篩選的話就不支持瞭，在復雜點多表關聯的話就更GG瞭，所以這種方式不合格直接上黑名單瞭。
- 第二種、繼承JpaSpecificationExecutor方式：
JPA 2引入瞭一個標準API，您可以使用它來以編程方式構建查詢。Spring Data JPA提供瞭使用JPA標準API定義此類規范的API。這種方式首先需要繼承JpaSpecificationExecutor接口，下面我們用這種方式實現和上面相同語義的查詢：
public void testJpaSpecificationQuery() {
String templateName = "kk";
Specification specification = (Specification) (root, query, criteriaBuilder) -> {
Predicate predicate = criteriaBuilder.like(root.get("templateName"),templateName);
query.where(predicate);
return predicate;
};
Pageable pageable = PageRequest.of(0, 2);
Page logPage = sendLogRepository.findAll(specification, pageable);
}
這種方式顯然更對味口瞭吧，而且也支持復雜的查詢條件拼接，比如日期等。唯一的缺憾是領域對象的屬性字符串需要手寫瞭，而且接口隻會提供findAll(@Nullable Specificationspec, Pageable pageable)方法，各種復雜查詢邏輯拼接都要寫在service層。對於架構分層思想流行瞭這麼多年外加強迫癥的人來說實在是不能忍，如果單獨封裝一個Dao類編寫復雜的查詢又顯的有點多餘和臃腫
SPRING DATA JPA最佳實踐
在詳細介紹最佳實踐前，先思考和瞭解一個東西，Spring Data Jpa是怎麼做到繼承一個接口就能實現各種復雜查詢的呢？這裡其實是一個典型的代理模式的應用，隻要繼承瞭最底層的Repository接口，在應用啟動時就會幫你生成一個代理實例，而真正的目標類才是最終執行查詢的類，這個類就是:SimpleJpaRepository,它實現瞭JpaRepository、JpaSpecificationExecutor的所有接口，所以隻要基於SimpleJpaRepository定制Repository基類，就能擁有繼承接口一樣的查詢功能，而且可以在實現類裡編寫復雜的查詢方法瞭。
一、繼承SIMPLEJPAREPOSITORY實現類
/**
* @author: kl @kailing.pub
* @date: 2019/11/8
*/
public abstract class BaseJpaRepository extends SimpleJpaRepository {
public EntityManager em;
BaseJpaRepository(ClassdomainClass, EntityManager em) {
super(domainClass, em);
this.em = em;
}
}
構造一個SimpleJpaRepository實例，隻需要一個領域對象的類型，和EntityManager 實例即可，EntityManager在Spring的上下文中已經有瞭，會自動註入。領域對象類型在具體的實現類中註入即可。如：
/**
* @author: kl @kailing.pub
* @date: 2019/11/11
*/
@Repository
public class SendLogJpaRepository extends BaseJpaRepository {
public SendLogJpaRepository(EntityManager em) {
super(SendLog.class, em);
}
/**
* 原生查詢
* @param templateName
* @return
*/
public SendLog findByTemplateName(String templateName){
String sql = "select * from send_log where templateName = :templateName";
Query query =em.createNativeQuery(sql);
query.setParameter("templateName",templateName);
return (SendLog) query.getSingleResult();
}
/**
* hql查詢
* @param templateName
* @return
*/
public SendLog findByTemplateNameNative(String templateName){
String hql = "from SendLog where templateName = :templateName";
TypedQueryquery =em.createQuery(hql,SendLog.class);
query.setParameter("templateName",templateName);
return query.getSingleResult();
}
/**
* JPASpecification 實現復雜分頁查詢
* @param logDto
* @param pageable
* @return
*/
public PagefindAll(SendLogDto logDto,Pageable pageable) {
Specification specification = (Specification) (root, query, criteriaBuilder) -> {
Predicate predicate = criteriaBuilder.conjunction();
if(!StringUtils.isEmpty(logDto.getTemplateName())){
predicate.getExpressions().add( criteriaBuilder.like(root.get("templateName"),logDto.getTemplateName()));
}
if(logDto.getStartTime() !=null){
predicate.getExpressions().add(criteriaBuilder.greaterThanOrEqualTo(root.get("createTime").as(Timestamp.class),logDto.getStartTime()));
}
query.where(predicate);
return predicate;
};
return findAll(specification, pageable);
}
}
通過繼承BaseJpaRepository，使SendLogJpaRepository擁有瞭JpaRepository、JpaSpecificationExecutor接口中定義的所有方法功能。而且基於抽象基類中EntityManager實例，也可以非常方便的編寫HQL和原生SQL查詢等。最賞心悅目的是不僅擁有瞭最基本的CURD等功能，而且超復雜的分頁查詢也不分傢瞭。隻是JpaSpecification查詢方式還不是特別出彩，下面繼續最佳實踐
二、集成QUERYDSL結構化查詢
Querydsl是一個框架，可通過其流暢的API來構造靜態類型的類似SQL的查詢。這是Spring Data Jpa文檔中對QueryDsl的描述。Spring Data Jpa對QueryDsl的擴展支持的比較好，基本可以無縫集成使用。Querydsl定義瞭一套和JpaSpecification類似的接口，使用方式上也類似，由於QueryDsl多瞭一個maven插件，可以在編譯期間生成領域對象操作實體，所以在拼接復雜的查詢條件時相比較JpaSpecification顯的更靈活好用，特別在關聯到多表查詢的時候。下面看下怎麼集成：
1、快速集成
因為之前有寫過最簡單的QueryDsl集成方式，所以這裡就不在贅述瞭，具體參見《Querydsl結構化查詢之jpa》,
2、豐富BaseJpaRepository基類
/**
* @author: kl @kailing.pub
* @date: 2019/11/8
*/
public abstract class BaseJpaRepository extends SimpleJpaRepository {
public EntityManager em;
protected final QuerydslJpaPredicateExecutorjpaPredicateExecutor;
BaseJpaRepository(ClassdomainClass, EntityManager em) {
super(domainClass, em);
this.em = em;
this.jpaPredicateExecutor = new QuerydslJpaPredicateExecutor<>(JpaEntityInformationSupport.getEntityInformation(domainClass, em), em, SimpleEntityPathResolver.INSTANCE, getRepositoryMethodMetadata());
}
}
在BaseJpaRepository基類中新增瞭QuerydslJpaPredicateExecutor實例，它是Spring Data Jpa基於QueryDsl的一個實現。用來執行QueryDsl的Predicate相關查詢。集成QueryDsl後，復雜分頁查詢的畫風就變的更加清爽瞭，如：
/**
* QSendLog實體是QueryDsl插件自動生成的，插件會自動掃描加瞭@Entity的實體，生成一個用於查詢的EntityPath類
*/
private final static QSendLog sendLog = QSendLog.sendLog;
public PagefindAll(SendLogDto logDto, Pageable pageable) {
BooleanExpression expression = sendLog.isNotNull();
if (logDto.getStartTime() != null) {
expression = expression.and(sendLog.createTime.gt(logDto.getStartTime()));
}
if (!StringUtils.isEmpty(logDto.getTemplateName())) {
expression = expression.and(sendLog.templateName.like("%"+logDto.getTemplateName()+"%"));
}
return jpaPredicateExecutor.findAll(expression, pageable);
}
到目前為止，實現相同的復雜分頁查詢，代碼已經非常的清爽和優雅瞭，在復雜的查詢在這種模式下也變的非常的清晰。但是，這還不是十分完美的。還有兩個問題需要解決下：
- QuerydslJpaPredicateExecutor實現的方法不支持分頁查詢同時又有字段排序。下面是它的接口定義，可以看到，要麼分頁查詢一步到位但是沒有排序，要麼排序查詢返回List列表自己封裝分頁。
public interface QuerydslPredicateExecutor{
OptionalfindOne(Predicate predicate);
IterablefindAll(Predicate predicate);
IterablefindAll(Predicate predicate, Sort sort);
IterablefindAll(Predicate predicate, OrderSpecifier... orders);
IterablefindAll(OrderSpecifier... orders);
PagefindAll(Predicate predicate, Pageable pageable);
long count(Predicate predicate);
boolean exists(Predicate predicate);
}
- 復雜的多表關聯查詢QuerydslJpaPredicateExecutor不支持
3、最終的BaseJpaRepository形態
Spring Data Jpa對QuerDsl的支持畢竟有限，但是QueryDsl是有這種功能的，像上面的場景就需要特別處理瞭。最終改造的BaseJpaRepository如下：
/**
* @author: kl @kailing.pub
* @date: 2019/11/8
*/
public abstract class BaseJpaRepository extends SimpleJpaRepository {
protected final JPAQueryFactory jpaQueryFactory;
protected final QuerydslJpaPredicateExecutorjpaPredicateExecutor;
protected final EntityManager em;
private final EntityPathpath;
protected final Querydsl querydsl;
BaseJpaRepository(ClassdomainClass, EntityManager em) {
super(domainClass, em);
this.em = em;
this.jpaPredicateExecutor = new QuerydslJpaPredicateExecutor<>(JpaEntityInformationSupport.getEntityInformation(domainClass, em), em, SimpleEntityPathResolver.INSTANCE, getRepositoryMethodMetadata());
this.jpaQueryFactory = new JPAQueryFactory(em);
this.path = SimpleEntityPathResolver.INSTANCE.createPath(domainClass);
this.querydsl = new Querydsl(em, new PathBuilder(path.getType(), path.getMetadata()));
}
protected PagefindAll(Predicate predicate, Pageable pageable, OrderSpecifier... orders) {
final JPAQuery countQuery = jpaQueryFactory.selectFrom(path);
countQuery.where(predicate);
JPQLQueryquery = querydsl.applyPagination(pageable, countQuery);
query.orderBy(orders);
return PageableExecutionUtils.getPage(query.fetch(), pageable, countQuery::fetchCount);
}
}
新增瞭findAll(Predicate predicate, Pageable pageable, OrderSpecifier… orders)方法，用於支持復雜分頁查詢的同時又有字段排序的查詢場景。其次的改動是引入瞭JPAQueryFactory實例，用於多表關聯的復雜查詢。使用方式如下：
/**
* QSendLog實體是QueryDsl插件自動生成的，插件會自動掃描加瞭@Entity的實體，生成一個用於查詢的EntityPath類
*/
private final static QSendLog qSendLog = QSendLog.sendLog;
private final static QTemplate qTemplate = QTemplate.template;
public PagefindAll(SendLogDto logDto, Template template, Pageable pageable) {
JPAQuery countQuery = jpaQueryFactory.selectFrom(qSendLog).leftJoin(qTemplate);
countQuery.where(qSendLog.templateCode.eq(qTemplate.code));
if(!StringUtils.isEmpty(template.getName())){
countQuery.where(qTemplate.name.eq(template.getName()));
}
JPQLQuery query = querydsl.applyPagination(pageable, countQuery);
return PageableExecutionUtils.getPage(query.fetch(), pageable, countQuery::fetchCount);
}
三、集成P6SPY打印執行的SQL
上面的功能以及十分完美瞭，但是談到最佳實踐似乎少瞭一個打印SQL的功能。在使用Jpa的結構化語義構建復雜查詢時，經常會因為各種原因導致查詢的結果集不是自己想要的，但是又沒法排查，因為不知道最終執行的sql是怎麼樣的。Spring Data Jpa也有打印sql的功能，但是比較雞肋，它打印的是沒有替換查詢參數的sql，沒法直接復制執行。所以這裡推薦一個工具p6spy，p6spy是一個打印最終執行sql的工具，而且可以記錄sql的執行耗時。使用起來也比較方便，簡單三步集成：
1、引入依賴
<dependency>
<groupId>p6spy</groupId>
<artifactId>p6spy</artifactId>
<version>${p6spy.version}</version>
</dependency>
2、修改數據源鏈接字符串
jdbc:mysql://127.0.0.1:3306 改成 jdbc:p6spy:mysql://127.0.0.1:3306
3、添加配置spy.propertis配置
appender=com.p6spy.engine.spy.appender.Slf4JLogger logMessageFormat=com.p6spy.engine.spy.appender.CustomLineFormat customLogMessageFormat = executionTime:%(executionTime)| sql:%(sqlSingleLine)
這個是最簡化的自定義打印的配置，更多配置可參考：https://p6spy.readthedocs.io/en/latest/configandusage.html
結語
最後的BaseJpaRepository功能上基本滿足瞭所有的查詢需求，又做瞭基礎查詢和復雜查詢的不分離，不至於把大量的復雜查詢拼接邏輯寫到service層，或者是新建的復雜查詢類裡。徹底解決瞭文首提出的那些問題。基於QueryDsl的復雜查詢代碼邏輯清晰，結構優雅，極力推薦使用。最後，在安利下p6spy，一個非常實用的打印sql的工具，可以幫助排查分析JPA最終生成執行的sql語句,其打印的sql語句可以直接復制到mysql管理工具中執行的。
以上就是Spring Data Jpa框架最佳實踐示例的詳細內容，更多關於Spring Data Jpa框架的資料請關註WalkonNet其它相關文章！
推薦閱讀：
- Spring Data JPA中 in 條件參數的傳遞方式
- jpa EntityManager 復雜查詢實例
- 全面解析JPA 倉庫repository中的findAll()方法
- spring data jpa如何使用自定義repository實現類
- spring-data-jpa使用自定義repository來實現原生sql