spring data jpa 深入淺出

wjw_595 2014-06-04

展開全文

Spring Data是什么

Spring Data是一個(gè)用于簡化數(shù)據(jù)庫訪問,，并支持云服務(wù)的開源框架,。其主要目標(biāo)是使得對(duì)數(shù)據(jù)的訪問變得方便快捷，并支持map-reduce框架和云計(jì)算數(shù)據(jù)服務(wù),。 Spring Data 包含多個(gè)子項(xiàng)目：

Commons - 提供共享的基礎(chǔ)框架,，適合各個(gè)子項(xiàng)目使用，支持跨數(shù)據(jù)庫持久化

JPA - 簡化創(chuàng)建 JPA 數(shù)據(jù)訪問層和跨存儲(chǔ)的持久層功能

Hadoop - 基于 Spring 的 Hadoop 作業(yè)配置和一個(gè) POJO 編程模型的 MapReduce 作業(yè)

Key-Value - 集成了 Redis 和 Riak ,，提供多個(gè)常用場景下的簡單封裝

Document - 集成文檔數(shù)據(jù)庫：CouchDB 和 MongoDB 并提供基本的配置映射和資料庫支持

Graph - 集成 Neo4j 提供強(qiáng)大的基于 POJO 的編程模型

Graph Roo AddOn - Roo support for Neo4j

JDBC Extensions - 支持 Oracle RAD,、高級(jí)隊(duì)列和高級(jí)數(shù)據(jù)類型

Mapping - 基于 Grails 的提供對(duì)象映射框架，支持不同的數(shù)據(jù)庫

Examples - 示例程序,、文檔和圖數(shù)據(jù)庫

Guidance - 高級(jí)文檔

Spring Data JPA是什么

由Spring提供的一個(gè)用于簡化JPA開發(fā)的框架

nSpring Data JPA能干什么

可以極大的簡化JPA的寫法,，可以在幾乎不用寫實(shí)現(xiàn)的情況下，實(shí)現(xiàn)對(duì)數(shù)據(jù)的訪問和操作,。除了CRUD外,，還包括如分頁、排序等一些常用的功能,。

Spring Data JPA有什么

主要來看看Spring Data JPA提供的接口,，也是Spring Data JPA的核心概念：

1：Repository：最頂層的接口，是一個(gè)空的接口,，目的是為了統(tǒng)一所有Repository的類型,，且能讓組件掃描的時(shí)候自動(dòng)識(shí)別。

2：CrudRepository ：是Repository的子接口,，提供CRUD的功能

3：PagingAndSortingRepository：是CrudRepository的子接口，添加分頁和排序的功能

4：JpaRepository：是PagingAndSortingRepository的子接口,，增加了一些實(shí)用的功能,，比如：批量操作等。

5：JpaSpecificationExecutor：用來做負(fù)責(zé)查詢的接口

6：Specification：是Spring Data JPA提供的一個(gè)查詢規(guī)范,，要做復(fù)雜的查詢,，只需圍繞這個(gè)規(guī)范來設(shè)置查詢條件即可

HelloWorld

n環(huán)境構(gòu)建

在Eclipse里面構(gòu)建一個(gè)普通的Java工程,，主要就是要加入一堆的jar包。

1：首先去官網(wǎng)下載Spring Data Common 和 Spring Data JPA的包,，把里面dist的jar包加入到工程中,，這里是spring-data-commons-1.5.0.RELEASE.jar和spring-data-jpa-1.3.2.RELEASE.jar

2：把Spring3.2.3的jar包添加到工程中

3：JPA的實(shí)現(xiàn)選用的是Hibernate4.2.0，總共還需要額外加入如下的jar：

antlr-2.7.7.jar,、aopalliance-1.0.jar,、asm-3.2.jar、aspectjrt-1.7.1.jar,、aspectjweaver-1.7.1.jar,、commons-beanutils-1.8.3.jar、commons-codec-1.7.jar,、commons-collections-3.2.1.jar,、commons-dbcp-1.4.jar、commons-fileupload-1.2.2.jar,、commons-io-2.4.jar,、commons-lang3-3.1.jar、commons-logging-1.1.1.jar,、commons-pool-1.6.jar,、dom4j-1.6.1.jar、hibernate-commons-annotations-4.0.1.Final.jar,、hibernate-core-4.2.0.Final.jar,、hibernate-entitymanager-4.2.0.Final.jar、hibernate-jpa-2.0-api-1.0.1.Final.jar,、javassist-3.15.0-GA.jar,、jboss-logging-3.1.0.GA.jar、jboss-transaction-api_1.1_spec-1.0.0.Final.jar,、mysql-connector-java-5.1.9.jar,、slf4j-api-1.7.3.jar

n實(shí)體對(duì)象，就是以前的實(shí)現(xiàn)方式

@Entity

@Table(name="tbl_user")

public class UserModel {

@Id

private Integer uuid;

private String name;

private Integer age;

//省略getter/setter

}

nDAO的接口

public interface UserRepository extends JpaRepository<UserModel, Integer>{

//空的,，可以什么都不用寫

}

無需提供實(shí)現(xiàn),，Spring Data JPA會(huì)為我們搞定一切

n寫個(gè)邏輯層的Service，其實(shí)就相當(dāng)于DAO的客戶端,，用來測試

@Service

@Transactional

public class Client {

@Autowired

private UserRepository ur;

public void testAdd(UserModel um){ ur.save(um); }

public static void main(String[] args) {

ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml");

Client c = (Client)ctx.getBean("client");

UserModel um = new UserModel();

um.setAge(1);

um.setName("張三");

um.setUuid(1);

c.testAdd(um);

} }

n同樣需要在Spring的配置文件中配置,，基本跟使用注解的配置類似：

<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www./schema/beans"

xmlns:xsi="http://www./2001/XMLSchema-instance"

xmlns:context="http://www./schema/context"

xmlns:aop="http://www./schema/aop"

xmlns:tx="http://www./schema/tx"

xmlns:jpa="http://www./schema/data/jpa"

xsi:schemaLocation="http://www./schema/beans http://www./schema/beans/spring-beans-3.0.xsd

http://www./schema/context http://www./schema/context/spring-context-3.0.xsd

http://www./schema/aop http://www./schema/aop/spring-aop-3.0.xsd

http://www./schema/tx http://www./schema/tx/spring-tx-3.0.xsd

http://www./schema/data/jpa http://www./schema/data/jpa/spring-jpa.xsd

<context:component-scan base-package="cn.javass">

<context:exclude-filter type="annotation“ expression="org.springframework.stereotype.Controller"/>

</context:component-scan>

<aop:aspectj-autoproxy proxy-target-class="true"/>

<tx:annotation-driven transaction-manager="transactionManager" proxy-target-class="true"/>

<jpa:repositories

base-package="cn.javass"

repository-impl-postfix="Impl"

entity-manager-factory-ref="entityManagerFactory"

transaction-manager-ref="transactionManager">

</jpa:repositories>

<bean id="entityManagerFactory"

class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">

</property>

</bean>

</property>

</property>

<map>

</map>

</property>

</bean>

</bean>

<property name="driverClassName"><value>org.gjt.mm.mysql.Driver</value></property>

<property name="url"><value>jdbc:mysql://localhost:3306/cc?useUnicode=true&characterEncoding=UTF-8</value></property>

</bean>

</beans>

配置完成后，可以去運(yùn)行Client測試一下了,，當(dāng)然數(shù)據(jù)庫和表需要先準(zhǔn)備好

也可以在<jpa:repositories>下面添加filter,，形如：

<context:exclude-filter type="regex" expression=".*SomeRepository" />

</repositories>

第二章：JpaRepository基本功能

JpaRepository的基本功能示范

具體的看代碼演示

其中：Pageable接口的實(shí)現(xiàn)類是PageRequest，Page接口的實(shí)現(xiàn)類是PageImpl。

示例如下：

Page<UserModel> p = ur.findAll(new PageRequest(0,2,new Sort(new Order(Direction. DESC,"uuid"))));

System. out.println("list="+p.getContent());

第三章：JpaRepository的查詢

直接在接口中定義查詢方法,，如果是符合規(guī)范的,，可以不用寫實(shí)現(xiàn)，目前支持的關(guān)鍵字寫法如下：

Spring Data JPA框架在進(jìn)行方法名解析時(shí),，會(huì)先把方法名多余的前綴截取掉,，比如 find、findBy,、read,、readBy、get,、getBy,，然后對(duì)剩下部分進(jìn)行解析。

假如創(chuàng)建如下的查詢：findByUserDepUuid(),，框架在解析該方法時(shí),，首先剔除 findBy，然后對(duì)剩下的屬性進(jìn)行解析,，假設(shè)查詢實(shí)體為Doc

1：先判斷 userDepUuid （根據(jù) POJO 規(guī)范,，首字母變?yōu)樾懀┦欠駷椴樵儗?shí)體的一個(gè)屬性，如果是,，則表示根據(jù)該屬性進(jìn)行查詢,；如果沒有該屬性，繼續(xù)第二步,；

2：從右往左截取第一個(gè)大寫字母開頭的字符串此處為Uuid）,，然后檢查剩下的字符串是否為查詢實(shí)體的一個(gè)屬性，如果是,，則表示根據(jù)該屬性進(jìn)行查詢,；如果沒有該屬性，則重復(fù)第二步,，繼續(xù)從右往左截?。蛔詈蠹僭O(shè)user為查詢實(shí)體的一個(gè)屬性,；

3：接著處理剩下部分（DepUuid）,，先判斷 user 所對(duì)應(yīng)的類型是否有depUuid屬性，如果有,，則表示該方法最終是根據(jù) “ Doc.user.depUuid” 的取值進(jìn)行查詢,；否則繼續(xù)按照步驟 2 的規(guī)則從右往左截取，最終表示根據(jù) “Doc.user.dep.uuid” 的值進(jìn)行查詢,。

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

特殊的參數(shù)：還可以直接在方法的參數(shù)上加入分頁或排序的參數(shù),，比如：

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

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

也可以使用JPA的NamedQueries，方法如下：

1：在實(shí)體類上使用@NamedQuery,，示例如下：

@NamedQuery(name = "UserModel.findByAge",query = "select o from UserModel o where o.age >= ?1")

2：在自己實(shí)現(xiàn)的DAO的Repository接口里面定義一個(gè)同名的方法,，示例如下：

public List<UserModel> findByAge(int age);

3：然后就可以使用了，Spring會(huì)先找是否有同名的NamedQuery,，如果有,，那么就不會(huì)按照接口定義的方法來解析。

使用@Query

可以在自定義的查詢方法上使用@Query來指定該方法要執(zhí)行的查詢語句,，比如：

@Query("select o from UserModel o where o.uuid=?1")

public List<UserModel> findByUuidOrAge(int uuid);

注意：

1：方法的參數(shù)個(gè)數(shù)必須和@Query里面需要的參數(shù)個(gè)數(shù)一致

2：如果是like,，后面的參數(shù)需要前面或者后面加“%”，比如下面都對(duì)：

@Query("select o from UserModel o where o.name like ?1%")

public List<UserModel> findByUuidOrAge(String name);

@Query("select o from UserModel o where o.name like %?1")

public List<UserModel> findByUuidOrAge(String name);

@Query("select o from UserModel o where o.name like %?1%")

public List<UserModel> findByUuidOrAge(String name);

當(dāng)然,，這樣在傳遞參數(shù)值的時(shí)候就可以不加‘%’了,，當(dāng)然加了也不會(huì)錯(cuò)

n還可以使用@Query來指定本地查詢，只要設(shè)置nativeQuery為true,，比如：

@Query(value="select * from tbl_user where name like %?1" ,nativeQuery=true)

public List<UserModel> findByUuidOrAge(String name);

注意：當(dāng)前版本的本地查詢不支持翻頁和動(dòng)態(tài)的排序

使用命名化參數(shù),，使用@Param即可，比如：

@Query(value="select o from UserModel o where o.name like %:nn")

public List<UserModel> findByUuidOrAge(@Param("nn") String name);

同樣支持更新類的Query語句,，添加@Modifying即可,，比如：

@Modifying

@Query(value="update UserModel o set o.name=:newName where o.name like %:nn")

public int findByUuidOrAge(@Param("nn") String name,@Param("newName") String newName);

注意：

1：方法的返回值應(yīng)該是int，表示更新語句所影響的行數(shù)

2：在調(diào)用的地方必須加事務(wù),，沒有事務(wù)不能正常執(zhí)行

JpaRepository的查詢功能

創(chuàng)建查詢的順序

Spring Data JPA 在為接口創(chuàng)建代理對(duì)象時(shí),，如果發(fā)現(xiàn)同時(shí)存在多種上述情況可用，它該優(yōu)先采用哪種策略呢,？

<jpa:repositories> 提供了 query-lookup-strategy 屬性,，用以指定查找的順序。它有如下三個(gè)取值：

1：create-if-not-found：如果方法通過@Query指定了查詢語句,，則使用該語句實(shí)現(xiàn)查詢,；如果沒有，則查找是否定義了符合條件的命名查詢,，如果找到,，則使用該命名查詢；如果兩者都沒有找到,，則通過解析方法名字來創(chuàng)建查詢,。這是 query-lookup-strategy 屬性的默認(rèn)值

2：create：通過解析方法名字來創(chuàng)建查詢。即使有符合的命名查詢，或者方法通過 @Query指定的查詢語句,，都將會(huì)被忽略

3：use-declared-query：如果方法通過@Query指定了查詢語句,，則使用該語句實(shí)現(xiàn)查詢；如果沒有,，則查找是否定義了符合條件的命名查詢,，如果找到，則使用該命名查詢,；如果兩者都沒有找到,，則拋出異常

第四章：客戶化擴(kuò)展JpaRepository

如果你不想暴露那么多的方法，可以自己訂制自己的Repository,，還可以在自己的Repository里面添加自己使用的公共方法

當(dāng)然更靈活的是自己寫一個(gè)實(shí)現(xiàn)類,，來實(shí)現(xiàn)自己需要的方法

1：寫一個(gè)與接口同名的類，加上后綴為Impl,，這個(gè)在前面xml里面配置過,，可以自動(dòng)被掃描到。這個(gè)類不需要實(shí)現(xiàn)任何接口,。

2：在接口中加入自己需要的方法,，比如：

public Page<Object[]> getByCondition(UserQueryModel u);

3：在實(shí)現(xiàn)類中，去實(shí)現(xiàn)這個(gè)方法就好了,，會(huì)被自動(dòng)找到

java代碼：

public class UserRepositoryImpl {
@PersistenceContext
private EntityManager em;
public Page<Object[]> getByCondition(UserQueryModel u){
String hql = "select o.uuid,o.name from UserModel o where 1=1 and o.uuid=:uuid";
Query q = em.createQuery(hql);
q.setParameter("uuid", u.getUuid());
q.setFirstResult(0);
q.setMaxResults(1);
Page<Object[]> page = new PageImpl<Object[]>(q.getResultList(),new PageRequest(0,1),3);
return page;
}}

第五章：Specifications查詢

Spring Data JPA支持JPA2.0的Criteria查詢,，相應(yīng)的接口是JpaSpecificationExecutor。

Criteria 查詢：是一種類型安全和更面向?qū)ο蟮牟樵?

這個(gè)接口基本是圍繞著Specification接口來定義的,， Specification接口中只定義了如下一個(gè)方法：

Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder cb);

要理解這個(gè)方法,，以及正確的使用它，就需要對(duì)JPA2.0的Criteria查詢有一個(gè)足夠的熟悉和理解,，因?yàn)檫@個(gè)方法的參數(shù)和返回值都是JPA標(biāo)準(zhǔn)里面定義的對(duì)象,。

Criteria查詢基本概念

Criteria 查詢是以元模型的概念為基礎(chǔ)的，元模型是為具體持久化單元的受管實(shí)體定義的,，這些實(shí)體可以是實(shí)體類,，嵌入類或者映射的父類。

CriteriaQuery接口：代表一個(gè)specific的頂層查詢對(duì)象,，它包含著查詢的各個(gè)部分,，比如：select 、from,、where,、group by、order by等

注意：CriteriaQuery對(duì)象只對(duì)實(shí)體類型或嵌入式類型的Criteria查詢起作用

Root接口：代表Criteria查詢的根對(duì)象,，Criteria查詢的查詢根定義了實(shí)體類型,，能為將來導(dǎo)航獲得想要的結(jié)果,，它與SQL查詢中的FROM子句類似

1：Root實(shí)例是類型化的，且定義了查詢的FROM子句中能夠出現(xiàn)的類型,。

2：查詢根實(shí)例能通過傳入一個(gè)實(shí)體類型給 AbstractQuery.from方法獲得,。

3：Criteria查詢，可以有多個(gè)查詢根,。

4：AbstractQuery是CriteriaQuery 接口的父類,，它提供得到查詢根的方法。

CriteriaBuilder接口：用來構(gòu)建CritiaQuery的構(gòu)建器對(duì)象

Predicate：一個(gè)簡單或復(fù)雜的謂詞類型,，其實(shí)就相當(dāng)于條件或者是條件組合。

Criteria查詢

基本對(duì)象的構(gòu)建

1：通過EntityManager的getCriteriaBuilder或EntityManagerFactory的getCriteriaBuilder方法可以得到CriteriaBuilder對(duì)象

2：通過調(diào)用CriteriaBuilder的createQuery或createTupleQuery方法可以獲得CriteriaQuery的實(shí)例

3：通過調(diào)用CriteriaQuery的from方法可以獲得Root實(shí)例

過濾條件

1：過濾條件會(huì)被應(yīng)用到SQL語句的FROM子句中,。在criteria 查詢中,，查詢條件通過Predicate或Expression實(shí)例應(yīng)用到CriteriaQuery對(duì)象上。

2：這些條件使用 CriteriaQuery .where 方法應(yīng)用到CriteriaQuery 對(duì)象上

3：CriteriaBuilder也作為Predicate實(shí)例的工廠,，通過調(diào)用CriteriaBuilder 的條件方法（ equal,，notEqual， gt,， ge,，lt， le,，between,，like等）創(chuàng)建Predicate對(duì)象。

4：復(fù)合的Predicate 語句可以使用CriteriaBuilder的and, or andnot 方法構(gòu)建,。

構(gòu)建簡單的Predicate示例：

Predicate p1=cb.like(root.get(“name”).as(String.class), “%”+uqm.getName()+“%”);

Predicate p2=cb.equal(root.get("uuid").as(Integer.class), uqm.getUuid());

Predicate p3=cb.gt(root.get("age").as(Integer.class), uqm.getAge());

構(gòu)建組合的Predicate示例：

Predicate p = cb.and(p3,cb.or(p1,p2));

當(dāng)然也可以形如前面動(dòng)態(tài)拼接查詢語句的方式,，比如：

java代碼：

Specification<UserModel> spec = new Specification<UserModel>() {
public Predicate toPredicate(Root<UserModel> root,
CriteriaQuery<?> query, CriteriaBuilder cb) {
List<Predicate> list = new ArrayList<Predicate>();
if(um.getName()!=null && um.getName().trim().length()>0){
list.add(cb.like(root.get("name").as(String.class), "%"+um.getName()+"%"));
}
if(um.getUuid()>0){
list.add(cb.equal(root.get("uuid").as(Integer.class), um.getUuid()));
}
Predicate[] p = new Predicate[list.size()];
return cb.and(list.toArray(p));
}
};

也可以使用CriteriaQuery來得到最后的Predicate，示例如下：

java代碼：

Specification<UserModel> spec = new Specification<UserModel>() {
public Predicate toPredicate(Root<UserModel> root,
CriteriaQuery<?> query, CriteriaBuilder cb) {
Predicate p1 = cb.like(root.get("name").as(String.class), "%"+um.getName()+"%");
Predicate p2 = cb.equal(root.get("uuid").as(Integer.class), um.getUuid());
Predicate p3 = cb.gt(root.get("age").as(Integer.class), um.getAge());
//把Predicate應(yīng)用到CriteriaQuery中去,因?yàn)檫€可以給CriteriaQuery添加其他的功能,，比如排序,、分組啥的
query.where(cb.and(p3,cb.or(p1,p2)));
//添加排序的功能
query.orderBy(cb.desc(root.get("uuid").as(Integer.class)));
return query.getRestriction();
}
};

多表聯(lián)接

n多表連接查詢稍微麻煩一些，下面演示一下常見的1:M,，順帶演示一下1:1

n使用Criteria查詢實(shí)現(xiàn)1對(duì)多的查詢

1：首先要添加一個(gè)實(shí)體對(duì)象DepModel,，并設(shè)置好UserModel和它的1對(duì)多關(guān)系，如下：

@Entity

@Table(name="tbl_user")

public class UserModel {

@Id

private Integer uuid;

private String name;

private Integer age;

@OneToMany(mappedBy = "um", fetch = FetchType. LAZY, cascade = {CascadeType. ALL})

private Set<DepModel> setDep;

//省略getter/setter

}

@Entity

@Table(name="tbl_dep")

public class DepModel {

@Id

private Integer uuid;

private String name;

@ManyToOne()

@JoinColumn(name = "user_id", nullable = false)

//表示在tbl_dep里面有user_id的字段

private UserModel um = new UserModel();

//省略getter/setter

}

2：配置好Model及其關(guān)系后,，就可以在構(gòu)建Specification的時(shí)候使用了,，示例如下：

Specification<UserModel> spec = new Specification<UserModel>() {

public Predicate toPredicate(Root<UserModel> root, CriteriaQuery<?> query, CriteriaBuilder cb) {

Predicate p1 = cb.like(root.get("name").as(String.class), "%"+um.getName()+"%");

Predicate p2 = cb.equal(root.get("uuid").as(Integer.class), um.getUuid());

Predicate p3 = cb.gt(root.get("age").as(Integer.class), um.getAge());

SetJoin<UserModel,DepModel> depJoin =root.join(root.getModel().getSet("setDep",DepModel.class) , JoinType.LEFT);

Predicate p4 = cb.equal(depJoin.get("name").as(String.class), "ddd");

//把Predicate應(yīng)用到CriteriaQuery去,因?yàn)檫€可以給CriteriaQuery添加其他的功能，比如排序,、分組啥的

query.where(cb.and(cb.and(p3,cb.or(p1,p2)),p4));

//添加分組的功能

query.orderBy(cb.desc(root.get("uuid").as(Integer.class)));

return query.getRestriction();

}};

n接下來看看使用Criteria查詢實(shí)現(xiàn)1:1的查詢

1：在UserModel中去掉setDep的屬性及其配置,，然后添加如下的屬性和配置：

@OneToOne()

@JoinColumn(name = "depUuid")

private DepModel dep;

public DepModel getDep() { return dep;}

public void setDep(DepModel dep) {this.dep = dep; }

2：在DepModel中um屬性上的注解配置去掉，換成如下的配置：

@OneToOne(mappedBy = "dep", fetch = FetchType. EAGER, cascade = {CascadeType. ALL})

3：在Specification實(shí)現(xiàn)中,，把SetJoin的那句換成如下的語句：

Join<UserModel,DepModel> depJoin =

root.join(root.getModel().getSingularAttribute("dep",DepModel.class),JoinType.LEFT);

//root.join(“dep”,JoinType.LEFT); //這句話和上面一句的功能一樣,，更簡單

本站是提供個(gè)人知識(shí)管理的網(wǎng)絡(luò)存儲(chǔ)空間,，所有內(nèi)容均由用戶發(fā)布，不代表本站觀點(diǎn),。請(qǐng)注意甄別內(nèi)容中的聯(lián)系方式,、誘導(dǎo)購買等信息，謹(jǐn)防詐騙,。如發(fā)現(xiàn)有害或侵權(quán)內(nèi)容,，請(qǐng)點(diǎn)擊一鍵舉報(bào)。

轉(zhuǎn)藏 分享

QQ空間 QQ好友新浪微博微信

獻(xiàn)花（0） +1

來自： wjw_595 > 《JPA》

舉報(bào)/認(rèn)領(lǐng)