對(duì)于不是使用sPRing管理的項(xiàng)目,我們就自己創(chuàng)建對(duì)象使用:大概的思路就是①創(chuàng)建dao接口②實(shí)現(xiàn)該接口,并且編寫邏輯:
Dao:
public interface StudentDao {public List<Student> findAll();}
因?yàn)槭菧y(cè)試,所以我們就只定義了一個(gè)查詢所有記錄的方法,下面是實(shí)現(xiàn):
public class StudentDaoImpl implements StudentDao{@Override@SuppressWarnings("unchecked")public List<Student> findAll() {JPAConnection jc=new JPAConnection("jpa-1");EntityManager em=jc.getEntityManager();String sql="select s from Student s";Query query=em.createQuery(sql);List<Student> students=query.getResultList();if(students==null){students=Lists.newArrayList();}jc.destory();return students;} }
,因?yàn)閯?chuàng)建EntityManager會(huì)重復(fù)很多的代碼:所以我就將這些東西給抽出來了
public class JPAConnection {private EntityManagerFactory entityManagerFactory;private EntityManager entityManager;private EntityTransaction entityTransaction;public JPAConnection(){}public JPAConnection(String unitName) {this.entityManagerFactory=Persistence.createEntityManagerFactory(unitName);this.entityManager=entityManagerFactory.createEntityManager();this.entityTransaction=entityManager.getTransaction();entityTransaction.begin();}/**Getter And Setter**/public void destory(){if(this.entityTransaction.isActive()){this.entityTransaction.commit();}if(this.entityManager.isOpen()){this.entityManager.close();}if(this.entityManagerFactory.isOpen()){this.entityManagerFactory.close();}}}
上面雖然是簡(jiǎn)單的實(shí)現(xiàn)了查詢的功能,但是對(duì)于真正實(shí)際的項(xiàng)目還是遠(yuǎn)遠(yuǎn)不夠的,對(duì)于真是項(xiàng)目中,還要考慮事務(wù)等等,這里的代碼只是簡(jiǎn)單的給個(gè)jpa實(shí)現(xiàn)的思路。
Spring管理的項(xiàng)目:
對(duì)于上面的代碼,覺得最多余的就是創(chuàng)建EntityManager這部分了,所以當(dāng)然會(huì)使用spring的特性減少這些創(chuàng)建的代碼了,同時(shí)操作事務(wù)也變得很簡(jiǎn)單了,只要添加一些注解就可以了:
下面是spring的配置文件:
<context:component-scan base-package="com.hotusm.common"/><tx:annotation-driven transaction-manager="transactionManager"/><bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager"><property name="entityManagerFactory" ref="entityManager"/></bean><bean id="entityManager" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean"/>
之后代碼就變成這樣了:
@Repository("userDao")public class UserDaoImpl implements UserDao{@PersistenceContextprivate EntityManager em;@Transactional@Override@SuppressWarnings("unchecked")public List<User> findAll() {String sql="select o from User o";Query query=em.createQuery(sql);List<User> users=query.getResultList();if(users==null){users=Lists.newArrayList();}return users;}}
是不是超級(jí)爽快?,如果是web項(xiàng)目,在使用的時(shí)候,在service中直接注入進(jìn)去就可以直接使用,同時(shí)使用注解@Transactional即可進(jìn)行事務(wù)操作了。
下面總結(jié)一下使用 Spring Data JPA 進(jìn)行持久層開發(fā)大致需要的三個(gè)步驟:
1.聲明持久層的接口,該接口繼承 Repository,Repository 是一個(gè)標(biāo)記型接口,它不包含任何方法,當(dāng)然如果有需要,Spring Data 也提供了若干 Repository 子接口,其中定義了一些常用的增刪改查,以及分頁相關(guān)的方法。
2.在接口中聲明需要的業(yè)務(wù)方法。Spring Data 將根據(jù)給定的策略(具體策略稍后講解)來為其生成實(shí)現(xiàn)代碼。
3.在 Spring 配置文件中增加一行聲明,讓 Spring 為聲明的接口創(chuàng)建代理對(duì)象。配置了 <jpa:repositories> 后,Spring 初始化容器時(shí)將會(huì)掃描 base-package 指定的包目錄及其子目錄,為繼承 Repository 或其子接口的接口創(chuàng)建代理對(duì)象,并將代理對(duì)象注冊(cè)為 Spring Bean,業(yè)務(wù)層便可以通過 Spring 自動(dòng)封裝的特性來直接使用該對(duì)象。
此外,<jpa:repository> 還提供了一些屬性和子標(biāo)簽,便于做更細(xì)粒度的控制。可以在 <jpa:repository> 內(nèi)部使用 <context:include-filter>、<context:exclude-filter> 來過濾掉一些不希望被掃描到的接口。具體的使用方法見 Spring參考文檔。
應(yīng)該繼承哪個(gè)接口?
前面提到,持久層接口繼承 Repository 并不是唯一選擇。Repository 接口是 Spring Data 的一個(gè)核心接口,它不提供任何方法,開發(fā)者需要在自己定義的接口中聲明需要的方法。與繼承 Repository 等價(jià)的一種方式,就是在持久層接口上使用 @RepositoryDefinition 注解,并為其指定 domainClass 和 idClass 屬性。如下兩種方式是完全等價(jià)的:
清單 15. 兩種等價(jià)的繼承接口方式示例
public interface UserDao extends Repository<AccountInfo, Long> { …… }@RepositoryDefinition(domainClass = AccountInfo.class, idClass = Long.class) public interface UserDao { …… }
如果持久層接口較多,且每一個(gè)接口都需要聲明相似的增刪改查方法,直接繼承 Repository 就顯得有些啰嗦,這時(shí)可以繼承 CrudRepository,它會(huì)自動(dòng)為域?qū)ο髣?chuàng)建增刪改查方法,供業(yè)務(wù)層直接使用。開發(fā)者只是多寫了 "Crud" 四個(gè)字母,即刻便為域?qū)ο筇峁┝碎_箱即用的十個(gè)增刪改查方法。
但是,使用 CrudRepository 也有副作用,它可能暴露了你不希望暴露給業(yè)務(wù)層的方法。比如某些接口你只希望提供增加的操作而不希望提供刪除的方法。針對(duì)這種情況,開發(fā)者只能退回到 Repository 接口,然后到 CrudRepository 中把希望保留的方法聲明復(fù)制到自定義的接口中即可。
分頁查詢和排序是持久層常用的功能,Spring Data 為此提供了 PagingAndSortingRepository 接口,它繼承自 CrudRepository 接口,在 CrudRepository 基礎(chǔ)上新增了兩個(gè)與分頁有關(guān)的方法。但是,我們很少會(huì)將自定義的持久層接口直接繼承自 PagingAndSortingRepository,而是在繼承 Repository 或 CrudRepository 的基礎(chǔ)上,在自己聲明的方法參數(shù)列表最后增加一個(gè) Pageable 或 Sort 類型的參數(shù),用于指定分頁或排序信息即可,這比直接使用 PagingAndSortingRepository 提供了更大的靈活性。
JpaRepository 是繼承自 PagingAndSortingRepository 的針對(duì) JPA 技術(shù)提供的接口,它在父接口的基礎(chǔ)上,提供了其他一些方法,比如 flush(),saveAndFlush(),deleteInBatch() 等。如果有這樣的需求,則可以繼承該接口。
上述四個(gè)接口,開發(fā)者到底該如何選擇?其實(shí)依據(jù)很簡(jiǎn)單,根據(jù)具體的業(yè)務(wù)需求,選擇其中之一。筆者建議在通常情況下優(yōu)先選擇 Repository 接口。因?yàn)?Repository 接口已經(jīng)能滿足日常需求,其他接口能做到的在 Repository 中也能做到,彼此之間并不存在功能強(qiáng)弱的問題。只是 Repository 需要顯示聲明需要的方法,而其他則可能已經(jīng)提供了相關(guān)的方法,不需要再顯式聲明,但如果對(duì) Spring Data JPA 不熟悉,別人在檢視代碼或者接手相關(guān)代碼時(shí)會(huì)有疑惑,他們不明白為什么明明在持久層接口中聲明了三個(gè)方法,而在業(yè)務(wù)層使用該接口時(shí),卻發(fā)現(xiàn)有七八個(gè)方法可用,從這個(gè)角度而言,應(yīng)該優(yōu)先考慮使用 Repository 接口。
前面提到,Spring Data JPA 在后臺(tái)為持久層接口創(chuàng)建代理對(duì)象時(shí),會(huì)解析方法名字,并實(shí)現(xiàn)相應(yīng)的功能。除了通過方法名字以外,它還可以通過如下兩種方式指定查詢語句:
Spring Data JPA 可以訪問 JPA 命名查詢語句。開發(fā)者只需要在定義命名查詢語句時(shí),為其指定一個(gè)符合給定格式的名字,Spring Data JPA 便會(huì)在創(chuàng)建代理對(duì)象時(shí),使用該命名查詢語句來實(shí)現(xiàn)其功能。
開發(fā)者還可以直接在聲明的方法上面使用 @Query 注解,并提供一個(gè)查詢語句作為參數(shù),Spring Data JPA 在創(chuàng)建代理對(duì)象時(shí),便以提供的查詢語句來實(shí)現(xiàn)其功能。
下面我們分別講述三種創(chuàng)建查詢的方式。
通過解析方法名創(chuàng)建查詢
通過前面的例子,讀者基本上對(duì)解析方法名創(chuàng)建查詢的方式有了一個(gè)大致的了解,這也是 Spring Data JPA 吸引開發(fā)者的一個(gè)很重要的因素。該功能其實(shí)并非 Spring Data JPA 首創(chuàng),而是源自一個(gè)開源的 JPA 框架 Hades,該框架的作者 Oliver Gierke 本身又是 Spring Data JPA 項(xiàng)目的 Leader,所以把 Hades 的優(yōu)勢(shì)引入到 Spring Data JPA 也就是順理成章的了。
框架在進(jìn)行方法名解析時(shí),會(huì)先把方法名多余的前綴截取掉,比如 find、findBy、read、readBy、get、getBy,然后對(duì)剩下部分進(jìn)行解析。并且如果方法的最后一個(gè)參數(shù)是 Sort 或者 Pageable 類型,也會(huì)提取相關(guān)的信息,以便按規(guī)則進(jìn)行排序或者分頁查詢。
在創(chuàng)建查詢時(shí),我們通過在方法名中使用屬性名稱來表達(dá),比如 findByUserAddressZip ()。框架在解析該方法時(shí),首先剔除 findBy,然后對(duì)剩下的屬性進(jìn)行解析,詳細(xì)規(guī)則如下(此處假設(shè)該方法針對(duì)的域?qū)ο鬄?AccountInfo 類型):
先判斷 userAddressZip (根據(jù) POJO 規(guī)范,首字母變?yōu)樾懀峦┦欠駷?AccountInfo 的一個(gè)屬性,如果是,則表示根據(jù)該屬性進(jìn)行查詢;如果沒有該屬性,繼續(xù)第二步;
從右往左截取第一個(gè)大寫字母開頭的字符串(此處為 Zip),然后檢查剩下的字符串是否為 AccountInfo 的一個(gè)屬性,如果是,則表示根據(jù)該屬性進(jìn)行查詢;如果沒有該屬性,則重復(fù)第二步,繼續(xù)從右往左截取;最后假設(shè) user 為 AccountInfo 的一個(gè)屬性;
接著處理剩下部分( AddressZip ),先判斷 user 所對(duì)應(yīng)的類型是否有 addressZip 屬性,如果有,則表示該方法最終是根據(jù) "AccountInfo.user.addressZip" 的取值進(jìn)行查詢;否則繼續(xù)按照步驟 2 的規(guī)則從右往左截取,最終表示根據(jù) "AccountInfo.user.address.zip" 的值進(jìn)行查詢。
可能會(huì)存在一種特殊情況,比如 AccountInfo 包含一個(gè) user 的屬性,也有一個(gè) userAddress 屬性,此時(shí)會(huì)存在混淆。讀者可以明確在屬性之間加上 "_" 以顯式表達(dá)意圖,比如 "findByUser_AddressZip()" 或者 "findByUserAddress_Zip()"。
在查詢時(shí),通常需要同時(shí)根據(jù)多個(gè)屬性進(jìn)行查詢,且查詢的條件也格式各樣(大于某個(gè)值、在某個(gè)范圍等等),Spring Data JPA 為此提供了一些表達(dá)條件查詢的關(guān)鍵字,大致如下:
And --- 等價(jià)于 SQL 中的 and 關(guān)鍵字,比如 findByUsernameAndPassWord(String user, Striang pwd);
Or --- 等價(jià)于 SQL 中的 or 關(guān)鍵字,比如 findByUsernameOrAddress(String user, String addr);
Between --- 等價(jià)于 SQL 中的 between 關(guān)鍵字,比如 findBySalaryBetween(int max, int min);
LessThan --- 等價(jià)于 SQL 中的 "<",比如 findBySalaryLessThan(int max);
GreaterThan --- 等價(jià)于 SQL 中的">",比如 findBySalaryGreaterThan(int min);
IsNull --- 等價(jià)于 SQL 中的 "is null",比如 findByUsernameIsNull();
IsNotNull --- 等價(jià)于 SQL 中的 "is not null",比如 findByUsernameIsNotNull();
NotNull --- 與 IsNotNull 等價(jià);
Like --- 等價(jià)于 SQL 中的 "like",比如 findByUsernameLike(String user);
NotLike --- 等價(jià)于 SQL 中的 "not like",比如 findByUsernameNotLike(String user);
OrderBy --- 等價(jià)于 SQL 中的 "order by",比如 findByUsernameOrderBySalaryAsc(String user);
Not --- 等價(jià)于 SQL 中的 "! =",比如 findByUsernameNot(String user);
In --- 等價(jià)于 SQL 中的 "in",比如 findByUsernameIn(Collection<String> userList) ,方法的參數(shù)可以是 Collection 類型,也可以是數(shù)組或者不定長(zhǎng)參數(shù);
NotIn --- 等價(jià)于 SQL 中的 "not in",比如 findByUsernameNotIn(Collection<String> userList) ,方法的參數(shù)可以是 Collection 類型,也可以是數(shù)組或者不定長(zhǎng)參數(shù);
使用 @Query 創(chuàng)建查詢
@Query 注解的使用非常簡(jiǎn)單,只需在聲明的方法上面標(biāo)注該注解,同時(shí)提供一個(gè) JP QL 查詢語句即可,如下所示:
清單 16. 使用 @Query 提供自定義查詢語句示例
public interface UserDao extends Repository<AccountInfo, Long> {@Query("select a from AccountInfo a where a.accountId = ?1") public AccountInfo findByAccountId(Long accountId);@Query("select a from AccountInfo a where a.balance > ?1") public Page<AccountInfo> findByBalanceGreaterThan( Integer balance,Pageable pageable); }
很多開發(fā)者在創(chuàng)建 JP QL 時(shí)喜歡使用命名參數(shù)來代替位置編號(hào),@Query 也對(duì)此提供了支持。JP QL 語句中通過": 變量"的格式來指定參數(shù),同時(shí)在方法的參數(shù)前面使用 @Param 將方法參數(shù)與 JP QL 中的命名參數(shù)對(duì)應(yīng),示例如下:
清單 17. @Query 支持命名參數(shù)示例
public interface UserDao extends Repository<AccountInfo, Long> {public AccountInfo save(AccountInfo accountInfo);@Query("from AccountInfo a where a.accountId = :id") public AccountInfo findByAccountId(@Param("id")Long accountId);@Query("from AccountInfo a where a.balance > :balance") public Page<AccountInfo> findByBalanceGreaterThan( @Param("balance")Integer balance,Pageable pageable); }
此外,開發(fā)者也可以通過使用 @Query 來執(zhí)行一個(gè)更新操作,為此,我們需要在使用 @Query 的同時(shí),用 @Modifying 來將該操作標(biāo)識(shí)為修改查詢,這樣框架最終會(huì)生成一個(gè)更新的操作,而非查詢。如下所示:
清單 18. 使用 @Modifying 將查詢標(biāo)識(shí)為修改查詢
@Modifying @Query("update AccountInfo a set a.salary = ?1 where a.salary < ?2") public int increaseSalary(int after, int before);
通過調(diào)用 JPA 命名查詢語句創(chuàng)建查詢
命名查詢是 JPA 提供的一種將查詢語句從方法體中獨(dú)立出來,以供多個(gè)方法共用的功能。Spring Data JPA 對(duì)命名查詢也提供了很好的支持。用戶只需要按照 JPA 規(guī)范在 orm.xml 文件或者在代碼中使用 @NamedQuery(或 @NamedNativeQuery)定義好查詢語句,唯一要做的就是為該語句命名時(shí),需要滿足”DomainClass.methodName()”的命名規(guī)則。假設(shè)定義了如下接口:
清單 19. 使用 JPA 命名查詢時(shí),聲明接口及方法時(shí)不需要什么特殊處理
public interface UserDao extends Repository<AccountInfo, Long> {...... public List<AccountInfo> findTop5(); }
如果希望為 findTop5() 創(chuàng)建命名查詢,并與之關(guān)聯(lián),我們只需要在適當(dāng)?shù)奈恢枚x命名查詢語句,并將其命名為 "AccountInfo.findTop5",框架在創(chuàng)建代理類的過程中,解析到該方法時(shí),優(yōu)先查找名為 "AccountInfo.findTop5" 的命名查詢定義,如果沒有找到,則嘗試解析方法名,根據(jù)方法名字創(chuàng)建查詢。
創(chuàng)建查詢的順序
Spring Data JPA 在為接口創(chuàng)建代理對(duì)象時(shí),如果發(fā)現(xiàn)同時(shí)存在多種上述情況可用,它該優(yōu)先采用哪種策略呢?為此,<jpa:repositories> 提供了 query-lookup-strategy 屬性,用以指定查找的順序。它有如下三個(gè)取值:
create --- 通過解析方法名字來創(chuàng)建查詢。即使有符合的命名查詢,或者方法通過 @Query 指定的查詢語句,都將會(huì)被忽略。
create-if-not-found --- 如果方法通過 @Query 指定了查詢語句,則使用該語句實(shí)現(xiàn)查詢;如果沒有,則查找是否定義了符合條件的命名查詢,如果找到,則使用該命名查詢;如果兩者都沒有找到,則通過解析方法名字來創(chuàng)建查詢。這是 query-lookup-strategy 屬性的默認(rèn)值。
use-declared-query --- 如果方法通過 @Query 指定了查詢語句,則使用該語句實(shí)現(xiàn)查詢;如果沒有,則查找是否定義了符合條件的命名查詢,如果找到,則使用該命名查詢;如果兩者都沒有找到,則拋出異常。
Spring Data JPA 對(duì)事務(wù)的支持
默認(rèn)情況下,Spring Data JPA 實(shí)現(xiàn)的方法都是使用事務(wù)的。針對(duì)查詢類型的方法,其等價(jià)于 @Transactional(readOnly=true);增刪改類型的方法,等價(jià)于 @Transactional。可以看出,除了將查詢的方法設(shè)為只讀事務(wù)外,其他事務(wù)屬性均采用默認(rèn)值。
如果用戶覺得有必要,可以在接口方法上使用 @Transactional 顯式指定事務(wù)屬性,該值覆蓋 Spring Data JPA 提供的默認(rèn)值。同時(shí),開發(fā)者也可以在業(yè)務(wù)層方法上使用 @Transactional 指定事務(wù)屬性,這主要針對(duì)一個(gè)業(yè)務(wù)層方法多次調(diào)用持久層方法的情況。持久層的事務(wù)會(huì)根據(jù)設(shè)置的事務(wù)傳播行為來決定是掛起業(yè)務(wù)層事務(wù)還是加入業(yè)務(wù)層的事務(wù)。具體 @Transactional 的使用,請(qǐng)參考 Spring的參考文檔。
為接口中的部分方法提供自定義實(shí)現(xiàn)
有些時(shí)候,開發(fā)者可能需要在某些方法中做一些特殊的處理,此時(shí)自動(dòng)生成的代理對(duì)象不能完全滿足要求。為了享受 Spring Data JPA 帶給我們的便利,同時(shí)又能夠?yàn)椴糠址椒ㄌ峁┳远x實(shí)現(xiàn),我們可以采用如下的方法:
將需要開發(fā)者手動(dòng)實(shí)現(xiàn)的方法從持久層接口(假設(shè)為 AccountDao )中抽取出來,獨(dú)立成一個(gè)新的接口(假設(shè)為 AccountDaoPlus ),并讓 AccountDao 繼承 AccountDaoPlus;
為 AccountDaoPlus 提供自定義實(shí)現(xiàn)(假設(shè)為 AccountDaoPlusImpl );
將 AccountDaoPlusImpl 配置為 Spring Bean;
在 <jpa:repositories> 中按清單 19 的方式進(jìn)行配置。
清單 20. 指定自定義實(shí)現(xiàn)類
<jpa:repositories base-package="footmark.springdata.jpa.dao"> <jpa:repository id="accountDao" repository-impl-ref=" accountDaoPlus " /> </jpa:repositories><bean id="accountDaoPlus" class="......."/>
此外,<jpa:repositories > 提供了一個(gè) repository-impl-postfix 屬性,用以指定實(shí)現(xiàn)類的后綴。假設(shè)做了如下配置:
清單 21. 設(shè)置自動(dòng)查找時(shí)默認(rèn)的自定義實(shí)現(xiàn)類命名規(guī)則
<jpa:repositories base-package="footmark.springdata.jpa.dao"
repository-impl-postfix="Impl"/>
則在框架掃描到 AccountDao 接口時(shí),它將嘗試在相同的包目錄下查找 AccountDaoImpl.java,如果找到,便將其中的實(shí)現(xiàn)方法作為最終生成的代理類中相應(yīng)方法的實(shí)現(xiàn)。
新聞熱點(diǎn)
疑難解答
圖片精選
網(wǎng)友關(guān)注