http://www.ibm.com/developerworks/cn/opensource/os-cn-spring-jpa/index.html?ca=drs-spring
從一個(gè)簡(jiǎn)單的 JPA 示例開(kāi)始 本文主要講述 Spring Data JPA,但是為了不至于給 JPA 和 Spring 的初學(xué)者造成較大的學(xué)習(xí)曲線,我們首先從 JPA 開(kāi)始,簡(jiǎn)單介紹一個(gè) JPA 示例;接著重構(gòu)該示例,并引入 Spring 框架,這兩部分不會(huì)涉及過(guò)多的篇幅,如果希望能夠深入學(xué)習(xí) Spring 和 JPA,可以根據(jù)本文最后提供的參考資料進(jìn)一步學(xué)習(xí)。
自 JPA 伴隨 Java EE 5 發(fā)布以來(lái),受到了各大廠商及開(kāi)源社區(qū)的追捧,各種商用的和開(kāi)源的 JPA 框架如雨后春筍般出現(xiàn),為開(kāi)發(fā)者提供了豐富的選擇。它一改之前 EJB 2.x 中實(shí)體 Bean 笨重且難以使用的形象,充分吸收了在開(kāi)源社區(qū)已經(jīng)相對(duì)成熟的 ORM 思想。另外,它并不依賴于 EJB 容器,可以作為一個(gè)獨(dú)立的持久層技術(shù)而存在。目前比較成熟的 JPA 框架主要包括 Jboss 的 Hibernate EntityManager、Oracle 捐獻(xiàn)給 Eclipse 社區(qū)的 EclipseLink、Apache 的 OpenJPA 等。
本文的示例代碼基于 Hibernate EntityManager 開(kāi)發(fā),但是讀者幾乎不用修改任何代碼,便可以非常容易地切換到其他 JPA 框架,因?yàn)榇a中使用到的都是 JPA 規(guī)范提供的接口 / 類,并沒(méi)有使用到框架本身的私有特性。示例主要涉及七個(gè)文件,但是很清晰:業(yè)務(wù)層包含一個(gè)接口和一個(gè)實(shí)現(xiàn);持久層包含一個(gè)接口、一個(gè)實(shí)現(xiàn)、一個(gè)實(shí)體類;另 外加上一個(gè) JPA 配置文件和一個(gè)測(cè)試類。相關(guān)類 / 接口代碼如下:
清單 1. 實(shí)體類 AccountInfo.java @Entity @Table(name = "t_accountinfo") public class AccountInfo implements Serializable { private Long accountId; private Integer balance; // 此處省略 getter 和 setter 方法。 } |
清單 2. 業(yè)務(wù)層接口 UserService.java public interface UserService { public AccountInfo createNewAccount(String user, String pwd, Integer init); } |
清單 3. 業(yè)務(wù)層的實(shí)現(xiàn)類 UserServiceImpl.java public class UserServiceImpl implements UserService { private UserDao userDao = new UserDaoImpl(); public AccountInfo createNewAccount(String user, String pwd, Integer init){ // 封裝域?qū)ο? AccountInfo accountInfo = new AccountInfo(); UserInfo userInfo = new UserInfo(); userInfo.setUsername(username); userInfo.setPassword(password); accountInfo.setBalance(initBalance); accountInfo.setUserInfo(userInfo); // 調(diào)用持久層,完成數(shù)據(jù)的保存 return userDao.save(accountInfo); } } |
清單 4. 持久層接口 public interface UserDao { public AccountInfo save(AccountInfo accountInfo); } |
清單 5. 持久層的實(shí)現(xiàn)類 public class UserDaoImpl implements UserDao { public AccountInfo save(AccountInfo accountInfo) { EntityManagerFactory emf = Persistence.createEntityManagerFactory("SimplePU"); EntityManager em = emf.createEntityManager(); em.getTransaction().begin(); em.persist(accountInfo); em.getTransaction().commit(); emf.close(); return accountInfo; } } |
清單 6. JPA 標(biāo)準(zhǔn)配置文件 persistence.xml <?xml version="1.0" encoding="UTF-8"?> <persistence xmlns="http://java.sun.com/xml/ns/persistence" version="2.0"> <persistence-unit name="SimplePU" transaction-type="RESOURCE_LOCAL"> <provider>org.hibernate.ejb.HibernatePersistence</provider> <class>footmark.springdata.jpa.domain.UserInfo</class> <class>footmark.springdata.jpa.domain.AccountInfo</class> <properties> <property name="hibernate.connection.driver_class" value="com.mysql.jdbc.Driver"/> <property name="hibernate.connection.url" value="jdbc:mysql://10.40.74.197:3306/zhangjp"/> <property name="hibernate.connection.username" value="root"/> <property name="hibernate.connection.password" value="root"/> <property name="hibernate.dialect" value="org.hibernate.dialect.MySQL5Dialect"/> <property name="hibernate.show_sql" value="true"/> <property name="hibernate.format_sql" value="true"/> <property name="hibernate.use_sql_comments" value="false"/> <property name="hibernate.hbm2ddl.auto" value="update"/> </properties> </persistence-unit> </persistence> |
清單 7. 本文使用如下的 main 方法進(jìn)行開(kāi)發(fā)者測(cè)試 public class SimpleSpringJpaDemo { public static void main(String[] args) { new UserServiceImpl().createNewAccount("ZhangJianPing", "123456", 1); } } |
回頁(yè)首
簡(jiǎn)述 Spring 框架對(duì) JPA 的支持
接下來(lái)我們引入 Spring,以展示 Spring 框架對(duì) JPA 的支持。業(yè)務(wù)層接口 UserService 保持不變,UserServiceImpl 中增加了三個(gè)注解,以讓 Spring 完成依賴注入,因此不再需要使用 new 操作符創(chuàng)建 UserDaoImpl 對(duì)象了。同時(shí)我們還使用了 Spring 的聲明式事務(wù):
清單 8. 配置為 Spring Bean 的業(yè)務(wù)層實(shí)現(xiàn) @Service("userService") public class UserServiceImpl implements UserService { @Autowired private UserDao userDao; @Transactional public AccountInfo createNewAccount( String name, String pwd, Integer init) { …… } } |
對(duì)于持久層,UserDao 接口也不需要修改,只需修改 UserDaoImpl 實(shí)現(xiàn),修改后的代碼如下:
清單 9. 配置為 Spring Bean 的持久層實(shí)現(xiàn) @Repository("userDao") public class UserDaoImpl implements UserDao { @PersistenceContext private EntityManager em; @Transactional public Long save(AccountInfo accountInfo) { em.persist(accountInfo); return accountInfo.getAccountId(); } } |
清單 10. Spring 配置文件 <?xml version="1.0" encoding="UTF-8"?> <beans...> <context:component-scan base-package="footmark.springdata.jpa"/> <tx:annotation-driven transaction-manager="transactionManager"/> <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager"> <property name="entityManagerFactory" ref="entityManagerFactory"/> </bean> <bean id="entityManagerFactory" class= "org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean"> </bean> </beans> |
清單 11. 改造后的基于 Spring 的開(kāi)發(fā)者測(cè)試代碼 public class SimpleSpringJpaDemo{ public static void main(String[] args){ ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext("spring-demo-cfg.xml"); UserDao userDao = ctx.getBean("userDao", UserDao.class); userDao.createNewAccount("ZhangJianPing", "123456", 1); } } |
通過(guò)對(duì)比重構(gòu)前后的代碼,可以發(fā)現(xiàn) Spring 對(duì) JPA 的簡(jiǎn)化已經(jīng)非常出色了,我們可以大致總結(jié)一下 Spring 框架對(duì) JPA 提供的支持主要體現(xiàn)在如下幾個(gè)方面:
- 首先,它使得 JPA 配置變得更加靈活。JPA 規(guī)范要求,配置文件必須命名為 persistence.xml,并存在于類路徑下的 META-INF 目錄中。該文件通常包含了初始化 JPA 引擎所需的全部信息。Spring 提供的 LocalContainerEntityManagerFactoryBean 提供了非常靈活的配置,persistence.xml 中的信息都可以在此以屬性注入的方式提供。
- 其次,Spring 實(shí)現(xiàn)了部分在 EJB 容器環(huán)境下才具有的功能,比如對(duì) @PersistenceContext、@PersistenceUnit 的容器注入支持。
- 第三,也是最具意義的,Spring 將 EntityManager 的創(chuàng)建與銷毀、事務(wù)管理等代碼抽取出來(lái),并由其統(tǒng)一管理,開(kāi)發(fā)者不需要關(guān)心這些,如前面的代碼所示,業(yè)務(wù)方法中只剩下操作領(lǐng)域?qū)ο蟮拇a,事務(wù)管理和 EntityManager 創(chuàng)建、銷毀的代碼都不再需要開(kāi)發(fā)者關(guān)心了。
回頁(yè)首
更進(jìn)一步:Spring Data JPA 讓一切近乎完美
通過(guò)前面的分析可以看出,Spring 對(duì) JPA 的支持已經(jīng)非常強(qiáng)大,開(kāi)發(fā)者只需關(guān)心核心業(yè)務(wù)邏輯的實(shí)現(xiàn)代碼,無(wú)需過(guò)多關(guān)注 EntityManager 的創(chuàng)建、事務(wù)處理等 JPA 相關(guān)的處理,這基本上也是作為一個(gè)開(kāi)發(fā)框架而言所能做到的極限了。然而,Spring 開(kāi)發(fā)小組并沒(méi)有止步,他們?cè)俳釉賲枺谧罱瞥隽?Spring Data JPA 框架,主要針對(duì)的就是 Spring 唯一沒(méi)有簡(jiǎn)化到的業(yè)務(wù)邏輯代碼,至此,開(kāi)發(fā)者連僅剩的實(shí)現(xiàn)持久層業(yè)務(wù)邏輯的工作都省了,唯一要做的,就只是聲明持久層的接口,其他都交給 Spring Data JPA 來(lái)幫你完成!
至此,讀者可能會(huì)存在一個(gè)疑問(wèn),框架怎么可能代替開(kāi)發(fā)者實(shí)現(xiàn)業(yè)務(wù)邏輯呢?畢竟,每一個(gè)應(yīng)用的持久層業(yè)務(wù)甚至領(lǐng)域?qū)ο蠖疾槐M相同,框架是怎么做 到的呢?其實(shí)這背后的思想并不復(fù)雜,比如,當(dāng)你看到 UserDao.findUserById() 這樣一個(gè)方法聲明,大致應(yīng)該能判斷出這是根據(jù)給定條件的 ID 查詢出滿足條件的 User 對(duì)象。Spring Data JPA 做的便是規(guī)范方法的名字,根據(jù)符合規(guī)范的名字來(lái)確定方法需要實(shí)現(xiàn)什么樣的邏輯。
接下來(lái)我們針對(duì)前面的例子進(jìn)行改造,讓 Spring Data JPA 來(lái)幫助我們完成業(yè)務(wù)邏輯。在著手寫(xiě)代碼之前,開(kāi)發(fā)者需要先 下載Spring Data JPA 的發(fā)布包(需要同時(shí)下載 Spring Data Commons 和 Spring Data JPA 兩個(gè)發(fā)布包,Commons 是 Spring Data 的公共基礎(chǔ)包),并把相關(guān)的依賴 JAR 文件加入到 CLASSPATH 中。
首先,讓持久層接口 UserDao 繼承 Repository 接口。該接口使用了泛型,需要為其提供兩個(gè)類型:第一個(gè)為該接口處理的域?qū)ο箢愋停诙€(gè)為該域?qū)ο蟮闹麈I類型。修改后的 UserDao 如下:
清單 12. Spring Data JPA 風(fēng)格的持久層接口 public interface UserDao extends Repository<AccountInfo, Long> { public AccountInfo save(AccountInfo accountInfo); } |
然后刪除 UserDaoImpl 類,因?yàn)槲覀兦懊嬲f(shuō)過(guò),框架會(huì)為我們完成業(yè)務(wù)邏輯。最后,我們需要在 Spring 配置文件中增加如下配置,以使 Spring 識(shí)別出需要為其實(shí)現(xiàn)的持久層接口:
清單 13. 在 Spring 配置文件中啟用掃描并自動(dòng)創(chuàng)建代理的功能 <-- 需要在 <beans> 標(biāo)簽中增加對(duì) jpa 命名空間的引用 --> <jpa:repositories base-package="footmark.springdata.jpa.dao" entity-manager-factory-ref="entityManagerFactory" transaction-manager-ref="transactionManager"/> |
至此便大功告成了!執(zhí)行一下測(cè)試代碼,然后看一下數(shù)據(jù)庫(kù),新的數(shù)據(jù)已經(jīng)如我們預(yù)期的添加到表中了。如果要再增加新的持久層業(yè)務(wù),比如希望查詢出給 ID 的 AccountInfo 對(duì)象,該怎么辦呢?很簡(jiǎn)單,在 UserDao 接口中增加一行代碼即可:
清單 14. 修改后的持久層接口,增加一個(gè)方法聲明 public interface UserDao extends Repository<AccountInfo, Long> { public AccountInfo save(AccountInfo accountInfo); // 你需要做的,僅僅是新增如下一行方法聲明 public AccountInfo findByAccountId(Long accountId); } |
下面總結(jié)一下使用 Spring Data JPA 進(jìn)行持久層開(kāi)發(fā)大致需要的三個(gè)步驟:
- 聲明持久層的接口,該接口繼承 Repository,Repository 是一個(gè)標(biāo)記型接口,它不包含任何方法,當(dāng)然如果有需要,Spring Data 也提供了若干 Repository 子接口,其中定義了一些常用的增刪改查,以及分頁(yè)相關(guān)的方法。
- 在接口中聲明需要的業(yè)務(wù)方法。Spring Data 將根據(jù)給定的策略(具體策略稍后講解)來(lái)為其生成實(shí)現(xiàn)代碼。
- 在 Spring 配置文件中增加一行聲明,讓 Spring 為聲明的接口創(chuàng)建代理對(duì)象。配置了 <jpa:repositories> 后,Spring 初始化容器時(shí)將會(huì)掃描 base-package 指定的包目錄及其子目錄,為繼承 Repository 或其子接口的接口創(chuàng)建代理對(duì)象,并將代理對(duì)象注冊(cè)為 Spring Bean,業(yè)務(wù)層便可以通過(guò) Spring 自動(dòng)封裝的特性來(lái)直接使用該對(duì)象。
此外,<jpa:repository> 還提供了一些屬性和子標(biāo)簽,便于做更細(xì)粒度的控制。可以在 <jpa:repository> 內(nèi)部使用 <context:include-filter>、<context:exclude-filter> 來(lái)過(guò)濾掉一些不希望被掃描到的接口。具體的使用方法見(jiàn) Spring參考文檔。
應(yīng)該繼承哪個(gè)接口?
前面提到,持久層接口繼承 Repository 并不是唯一選擇。Repository 接口是 Spring Data 的一個(gè)核心接口,它不提供任何方法,開(kāi)發(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ù)層直接使用。開(kāi)發(fā)者只是多寫(xiě)了 "Crud" 四個(gè)字母,即刻便為域?qū)ο筇峁┝碎_(kāi)箱即用的十個(gè)增刪改查方法。
但是,使用 CrudRepository 也有副作用,它可能暴露了你不希望暴露給業(yè)務(wù)層的方法。比如某些接口你只希望提供增加的操作而不希望提供刪除的方法。針對(duì)這種情況,開(kāi)發(fā)者只能退回到 Repository 接口,然后到 CrudRepository 中把希望保留的方法聲明復(fù)制到自定義的接口中即可。
分頁(yè)查詢和排序是持久層常用的功能,Spring Data 為此提供了 PagingAndSortingRepository 接口,它繼承自 CrudRepository 接口,在 CrudRepository 基礎(chǔ)上新增了兩個(gè)與分頁(yè)有關(guān)的方法。但是,我們很少會(huì)將自定義的持久層接口直接繼承自 PagingAndSortingRepository,而是在繼承 Repository 或 CrudRepository 的基礎(chǔ)上,在自己聲明的方法參數(shù)列表最后增加一個(gè) Pageable 或 Sort 類型的參數(shù),用于指定分頁(yè)或排序信息即可,這比直接使用 PagingAndSortingRepository 提供了更大的靈活性。
JpaRepository 是繼承自 PagingAndSortingRepository 的針對(duì) JPA 技術(shù)提供的接口,它在父接口的基礎(chǔ)上,提供了其他一些方法,比如 flush(),saveAndFlush(),deleteInBatch() 等。如果有這樣的需求,則可以繼承該接口。
上述四個(gè)接口,開(kāi)發(fā)者到底該如何選擇?其實(shí)依據(jù)很簡(jiǎn)單,根據(jù)具體的業(yè)務(wù)需求,選擇其中之一。筆者建議在通常情況下優(yōu)先選擇 Repository 接口。因?yàn)?Repository 接口已經(jīng)能滿足日常需求,其他接口能做到的在 Repository 中也能做到,彼此之間并不存在功能強(qiáng)弱的問(wèn)題。只是 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)的功能。除了通過(guò)方法名字以外,它還可以通過(guò)如下兩種方式指定查詢語(yǔ)句:
- Spring Data JPA 可以訪問(wèn) JPA 命名查詢語(yǔ)句。開(kāi)發(fā)者只需要在定義命名查詢語(yǔ)句時(shí),為其指定一個(gè)符合給定格式的名字,Spring Data JPA 便會(huì)在創(chuàng)建代理對(duì)象時(shí),使用該命名查詢語(yǔ)句來(lái)實(shí)現(xiàn)其功能。
- 開(kāi)發(fā)者還可以直接在聲明的方法上面使用 @Query 注解,并提供一個(gè)查詢語(yǔ)句作為參數(shù),Spring Data JPA 在創(chuàng)建代理對(duì)象時(shí),便以提供的查詢語(yǔ)句來(lái)實(shí)現(xiàn)其功能。
下面我們分別講述三種創(chuàng)建查詢的方式。
通過(guò)解析方法名創(chuàng)建查詢
通過(guò)前面的例子,讀者基本上對(duì)解析方法名創(chuàng)建查詢的方式有了一個(gè)大致的了解,這也是 Spring Data JPA 吸引開(kāi)發(fā)者的一個(gè)很重要的因素。該功能其實(shí)并非 Spring Data JPA 首創(chuàng),而是源自一個(gè)開(kāi)源的 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)行排序或者分頁(yè)查詢。
在創(chuàng)建查詢時(shí),我們通過(guò)在方法名中使用屬性名稱來(lái)表達(dá),比如 findByUserAddressZip ()。框架在解析該方法時(shí),首先剔除 findBy,然后對(duì)剩下的屬性進(jìn)行解析,詳細(xì)規(guī)則如下(此處假設(shè)該方法針對(duì)的域?qū)ο鬄?AccountInfo 類型):
- 先判斷 userAddressZip (根據(jù) POJO 規(guī)范,首字母變?yōu)樾?xiě),下同)是否為 AccountInfo 的一個(gè)屬性,如果是,則表示根據(jù)該屬性進(jìn)行查詢;如果沒(méi)有該屬性,繼續(xù)第二步;
- 從右往左截取第一個(gè)大寫(xiě)字母開(kāi)頭的字符串(此處為 Zip),然后檢查剩下的字符串是否為 AccountInfo 的一個(gè)屬性,如果是,則表示根據(jù)該屬性進(jìn)行查詢;如果沒(méi)有該屬性,則重復(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 查詢語(yǔ)句即可,如下所示:
清單 16. 使用 @Query 提供自定義查詢語(yǔ)句示例 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); } |
很多開(kāi)發(fā)者在創(chuàng)建 JP QL 時(shí)喜歡使用命名參數(shù)來(lái)代替位置編號(hào),@Query 也對(duì)此提供了支持。JP QL 語(yǔ)句中通過(guò)": 變量"的格式來(lái)指定參數(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); } |
此外,開(kāi)發(fā)者也可以通過(guò)使用 @Query 來(lái)執(zhí)行一個(gè)更新操作,為此,我們需要在使用 @Query 的同時(shí),用 @Modifying 來(lái)將該操作標(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); |
通過(guò)調(diào)用 JPA 命名查詢語(yǔ)句創(chuàng)建查詢
命名查詢是 JPA 提供的一種將查詢語(yǔ)句從方法體中獨(dú)立出來(lái),以供多個(gè)方法共用的功能。Spring Data JPA 對(duì)命名查詢也提供了很好的支持。用戶只需要按照 JPA 規(guī)范在 orm.xml 文件或者在代碼中使用 @NamedQuery(或 @NamedNativeQuery)定義好查詢語(yǔ)句,唯一要做的就是為該語(yǔ)句命名時(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命名查詢語(yǔ)句,并將其命名為 "AccountInfo.findTop5",框架在創(chuàng)建代理類的過(guò)程中,解析到該方法時(shí),優(yōu)先查找名為 "AccountInfo.findTop5" 的命名查詢定義,如果沒(méi)有找到,則嘗試解析方法名,根據(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 --- 通過(guò)解析方法名字來(lái)創(chuàng)建查詢。即使有符合的命名查詢,或者方法通過(guò) @Query 指定的查詢語(yǔ)句,都將會(huì)被忽略。
- create-if-not-found --- 如果方法通過(guò) @Query 指定了查詢語(yǔ)句,則使用該語(yǔ)句實(shí)現(xiàn)查詢;如果沒(méi)有,則查找是否定義了符合條件的命名查詢,如果找到,則使用該命名查詢;如果兩者都沒(méi)有找到,則通過(guò)解析方 法名字來(lái)創(chuàng)建查詢。這是 query-lookup-strategy 屬性的默認(rèn)值。
- use-declared-query --- 如果方法通過(guò) @Query 指定了查詢語(yǔ)句,則使用該語(yǔ)句實(shí)現(xiàn)查詢;如果沒(méi)有,則查找是否定義了符合條件的命名查詢,如果找到,則使用該命名查詢;如果兩者都沒(méi)有找到,則拋出異常。
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)值。
如果用戶覺(jué)得有必要,可以在接口方法上使用 @Transactional 顯式指定事務(wù)屬性,該值覆蓋 Spring Data JPA 提供的默認(rèn)值。同時(shí),開(kāi)發(fā)者也可以在業(yè)務(wù)層方法上使用 @Transactional 指定事務(wù)屬性,這主要針對(duì)一個(gè)業(yè)務(wù)層方法多次調(diào)用持久層方法的情況。持久層的事務(wù)會(huì)根據(jù)設(shè)置的事務(wù)傳播行為來(lái)決定是掛起業(yè)務(wù)層事務(wù)還是加入業(yè)務(wù)層的事務(wù)。 具體 @Transactional 的使用,請(qǐng)參考 Spring的參考文檔。
為接口中的部分方法提供自定義實(shí)現(xiàn)
有些時(shí)候,開(kāi)發(fā)者可能需要在某些方法中做一些特殊的處理,此時(shí)自動(dòng)生成的代理對(duì)象不能完全滿足要求。為了享受 Spring Data JPA 帶給我們的便利,同時(shí)又能夠?yàn)椴糠址椒ㄌ峁┳远x實(shí)現(xiàn),我們可以采用如下的方法:
- 將需要開(kāi)發(fā)者手動(dòng)實(shí)現(xiàn)的方法從持久層接口(假設(shè)為 AccountDao )中抽取出來(lái),獨(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)。
回頁(yè)首
結(jié)束語(yǔ)
本文主要介紹了 Spring Data JPA 的使用,以及它與 Spring 框架的無(wú)縫集成。Spring Data JPA 其實(shí)并不依賴于 Spring 框架,有興趣的讀者可以參考本文最后的"參考資源"進(jìn)一步學(xué)習(xí)。
回頁(yè)首
下載
描述 | 名字 | 大小 | 下載方法 |
---|
樣例代碼 | sample-code.rar | 5KB | HTTP |
關(guān)于下載方法的信息
參考資料
學(xué)習(xí)
討論
關(guān)于作者
張 建平,長(zhǎng)期從事于基于 Java 的項(xiàng)目開(kāi)發(fā)與管理工作,在 Java SE/Java EE 領(lǐng)域積累了豐富的知識(shí)和經(jīng)驗(yàn)。尤其對(duì) SpringSource 框架集 ( Spring Framework,Spring Security,Spring Roo 等 ) 有深入研究,擅長(zhǎng)基于以 Spring 和 Hibernate 為中心的輕量級(jí)框架進(jìn)行項(xiàng)目開(kāi)發(fā);并對(duì) Java EE 規(guī)范集有深入研究。如有興趣,可以加 MSN:yerlluo@hotmail.com 與他聯(lián)系。
為本文評(píng)分