深入浅出学Spring Data JPA

深入浅出学Spring Data JPA 

转自 http://sishuok.com/forum/blogPost/list/7000.html;jsessionid=82E805FF4C373448C2745E9C284ADEE0

第一章:Spring Data JPA入门

 

Spring Data是什么

Spring Data是一个用于简化数据库访问,并支持云服务的开源框架。其主要目标是使得对数据的访问变得方便快捷,并支持map-reduce框架和云计算数据服务。 Spring Data 包含多个子项目:

Commons - 提供共享的基础框架,适合各个子项目使用,支持跨数据库持久化

JPA - 简化创建 JPA 数据访问层和跨存储的持久层功能

Hadoop - 基于 Spring 的 Hadoop 作业配置和一个 POJO 编程模型的 MapReduce 作业

Key-Value  - 集成了 Redis 和 Riak ,提供多个常用场景下的简单封装

Document - 集成文档数据库:CouchDB 和 MongoDB 并提供基本的配置映射和资料库支持

Graph - 集成 Neo4j 提供强大的基于 POJO 的编程模型

Graph Roo AddOn - Roo support for Neo4j

JDBC Extensions - 支持 Oracle RAD、高级队列和高级数据类型

Mapping - 基于 Grails 的提供对象映射框架,支持不同的数据库

Examples - 示例程序、文档和图数据库

Guidance - 高级文档

Spring Data JPA是什么

由Spring提供的一个用于简化JPA开发的框架

nSpring Data JPA能干什么

可以极大的简化JPA的写法,可以在几乎不用写实现的情况下,实现对数据的访问和操作。除了CRUD外,还包括如分页、排序等一些常用的功能。

Spring Data JPA有什么

主要来看看Spring Data JPA提供的接口,也是Spring Data JPA的核心概念:

1:Repository:最顶层的接口,是一个空的接口,目的是为了统一所有Repository的类型,且能让组件扫描的时候自动识别。

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

3:PagingAndSortingRepository:是CrudRepository的子接口,添加分页和排序的功能

4:JpaRepository:是PagingAndSortingRepository的子接口,增加了一些实用的功能,比如:批量操作等。

5:JpaSpecificationExecutor:用来做负责查询的接口

6:Specification:是Spring Data JPA提供的一个查询规范,要做复杂的查询,只需围绕这个规范来设置查询条件即可

 

HelloWorld

n环境构建

在Eclipse里面构建一个普通的Java工程,主要就是要加入一堆的jar包。

1:首先去官网下载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的实现选用的是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实体对象,就是以前的实现方式

@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{

//空的,可以什么都不用写

}

无需提供实现,Spring Data JPA会为我们搞定一切

n写个逻辑层的Service,其实就相当于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的配置文件中配置,基本跟使用注解的配置类似:

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

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

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

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

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

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

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

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

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

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

">

    

            base-package="cn.javass"

            repository-impl-postfix="Impl"

            entity-manager-factory-ref="entityManagerFactory"

            transaction-manager-ref="transactionManager">

       

     

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

       

       

       

           

       

       

           

               

               

               

               

           

       

        

           

       

       

           

               

               

               

               

               

               

               

           

       

   

   

       

   

 

org.gjt.mm.mysql.Driver

jdbc:mysql://localhost:3306/cc?useUnicode=true&characterEncoding=UTF-8

root

 

配置完成后,可以去运行Client测试一下了,当然数据库和表需要先准备好

也可以在下面添加filter,形如:

 

 

第二章:JpaRepository基本功能

JpaRepository的基本功能示范

具体的看代码演示

其中:Pageable接口的实现类是PageRequest,Page接口的实现类是PageImpl。

示例如下:

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

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

 

 

第三章:JpaRepository的查询

直接在接口中定义查询方法,如果是符合规范的,可以不用写实现,目前支持的关键字写法如下:

 深入浅出学Spring Data JPA_第1张图片

 深入浅出学Spring Data JPA_第2张图片

  

Spring Data JPA框架在进行方法名解析时,会先把方法名多余的前缀截取掉,比如 find、findBy、read、readBy、get、getBy,然后对剩下部分进行解析。

假如创建如下的查询:findByUserDepUuid(),框架在解析该方法时,首先剔除 findBy,然后对剩下的属性进行解析,假设查询实体为Doc

1:先判断 userDepUuid (根据 POJO 规范,首字母变为小写)是否为查询实体的一个属性,如果是,则表示根据该属性进行查询;如果没有该属性,继续第二步;

2:从右往左截取第一个大写字母开头的字符串此处为Uuid),然后检查剩下的字符串是否为查询实体的一个属性,如果是,则表示根据该属性进行查询;如果没有该属性,则重复第二步,继续从右往左截取;最后假设user为查询实体的一个属性;

3:接着处理剩下部分(DepUuid),先判断 user 所对应的类型是否有depUuid属性,如果有,则表示该方法最终是根据 “ Doc.user.depUuid” 的取值进行查询;否则继续按照步骤 2 的规则从右往左截取,最终表示根据 “Doc.user.dep.uuid” 的值进行查询。

4:可能会存在一种特殊情况,比如 Doc包含一个 user 的属性,也有一个 userDep 属性,此时会存在混淆。可以明确在属性之间加上 "_" 以显式表达意图,比如 "findByUser_DepUuid()" 或者 "findByUserDep_uuid()"

特殊的参数: 还可以直接在方法的参数上加入分页或排序的参数,比如:

Page findByName(String name, Pageable pageable);

List findByName(String name, Sort sort);

 

也可以使用JPA的NamedQueries,方法如下:

1:在实体类上使用@NamedQuery,示例如下:

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

2:在自己实现的DAO的Repository接口里面定义一个同名的方法,示例如下:

public List findByAge(int age);

3:然后就可以使用了,Spring会先找是否有同名的NamedQuery,如果有,那么就不会按照接口定义的方法来解析。

 

使用@Query

可以在自定义的查询方法上使用@Query来指定该方法要执行的查询语句,比如:

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

public List findByUuidOrAge(int uuid);

注意:

1:方法的参数个数必须和@Query里面需要的参数个数一致

2:如果是like,后面的参数需要前面或者后面加“%”,比如下面都对:

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

public List findByUuidOrAge(String name);

 

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

public List findByUuidOrAge(String name);

 

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

public List findByUuidOrAge(String name);

 

当然,这样在传递参数值的时候就可以不加‘%’了,当然加了也不会错

 

n还可以使用@Query来指定本地查询,只要设置nativeQuery为true,比如:

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

public List findByUuidOrAge(String name);

注意:当前版本的本地查询不支持翻页和动态的排序

 

使用命名化参数,使用@Param即可,比如:

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

public List 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:方法的返回值应该是int,表示更新语句所影响的行数

2:在调用的地方必须加事务,没有事务不能正常执行

 

JpaRepository的查询功能

创建查询的顺序

Spring Data JPA 在为接口创建代理对象时,如果发现同时存在多种上述情况可用,它该优先采用哪种策略呢?

提供了 query-lookup-strategy 属性,用以指定查找的顺序。它有如下三个取值:

1:create-if-not-found:如果方法通过@Query指定了查询语句,则使用该语句实现查询;如果没有,则查找是否定义了符合条件的命名查询,如果找到,则使用该命名查询;如果两者都没有找到,则通过解析方法名字来创建查询。这是 query-lookup-strategy 属性的默认值

2:create:通过解析方法名字来创建查询。即使有符合的命名查询,或者方法通过 @Query指定的查询语句,都将会被忽略

3:use-declared-query:如果方法通过@Query指定了查询语句,则使用该语句实现查询;如果没有,则查找是否定义了符合条件的命名查询,如果找到,则使用该命名查询;如果两者都没有找到,则抛出异常

 

第四章:客户化扩展JpaRepository

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

当然更灵活的是自己写一个实现类,来实现自己需要的方法

1:写一个与接口同名的类,加上后缀为Impl,这个在前面xml里面配置过,可以自动被扫描到。这个类不需要实现任何接口。

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

public Page getByCondition(UserQueryModel u);

3:在实现类中,去实现这个方法就好了,会被自动找到


java代码:

查看复制到剪贴板打印

  1. public class UserRepositoryImpl {  
  2.     @PersistenceContext  
  3.     private EntityManager em;     
  4.     public Page getByCondition(UserQueryModel u){  
  5. String hql = "select o.uuid,o.name from UserModel o where 1=1 and o.uuid=:uuid";  
  6.         Query q = em.createQuery(hql);  
  7.         q.setParameter("uuid", u.getUuid());          
  8.         q.setFirstResult(0);  
  9.         q.setMaxResults(1);       
  10. Page page = new PageImpl(q.getResultList(),new PageRequest(0,1),3);   
  11.         return page;  
  12. }}  

 

第五章:Specifications查询

Spring Data JPA支持JPA2.0的Criteria查询,相应的接口是JpaSpecificationExecutor。

Criteria 查询:是一种类型安全和更面向对象的查询

 

这个接口基本是围绕着Specification接口来定义的, Specification接口中只定义了如下一个方法:

Predicate toPredicate(Root root, CriteriaQuery query, CriteriaBuilder cb);

 

要理解这个方法,以及正确的使用它,就需要对JPA2.0的Criteria查询有一个足够的熟悉和理解,因为这个方法的参数和返回值都是JPA标准里面定义的对象。

 

Criteria查询基本概念

Criteria 查询是以元模型的概念为基础的,元模型是为具体持久化单元的受管实体定义的,这些实体可以是实体类,嵌入类或者映射的父类。

CriteriaQuery接口:代表一个specific的顶层查询对象,它包含着查询的各个部分,比如:select 、from、where、group by、order by等

注意:CriteriaQuery对象只对实体类型或嵌入式类型的Criteria查询起作用

Root接口:代表Criteria查询的根对象,Criteria查询的查询根定义了实体类型,能为将来导航获得想要的结果,它与SQL查询中的FROM子句类似

1:Root实例是类型化的,且定义了查询的FROM子句中能够出现的类型。

2:查询根实例能通过传入一个实体类型给 AbstractQuery.from方法获得。

3:Criteria查询,可以有多个查询根。 

4:AbstractQuery是CriteriaQuery 接口的父类,它提供得到查询根的方法。

CriteriaBuilder接口:用来构建CritiaQuery的构建器对象

Predicate:一个简单或复杂的谓词类型,其实就相当于条件或者是条件组合。

 

Criteria查询

基本对象的构建

1:通过EntityManager的getCriteriaBuilder或EntityManagerFactory的getCriteriaBuilder方法可以得到CriteriaBuilder对象

2:通过调用CriteriaBuilder的createQuery或createTupleQuery方法可以获得CriteriaQuery的实例

3:通过调用CriteriaQuery的from方法可以获得Root实例

过滤条件

1:过滤条件会被应用到SQL语句的FROM子句中。在criteria 查询中,查询条件通过Predicate或Expression实例应用到CriteriaQuery对象上。

2:这些条件使用 CriteriaQuery .where 方法应用到CriteriaQuery 对象上

3:CriteriaBuilder也作为Predicate实例的工厂,通过调用CriteriaBuilder 的条件方法( equal,notEqual, gt, ge,lt, le,between,like等)创建Predicate对象。

4:复合的Predicate 语句可以使用CriteriaBuilder的and, or andnot 方法构建。

 

构建简单的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());

构建组合的Predicate示例:

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

 

当然也可以形如前面动态拼接查询语句的方式,比如:


java代码:

查看复制到剪贴板打印

  1. Specification spec = new Specification() {  
  2. public Predicate toPredicate(Root root,  
  3.         CriteriaQuery query, CriteriaBuilder cb) {  
  4.     List list = new ArrayList();  
  5.           
  6.     if(um.getName()!=null && um.getName().trim().length()>0){  
  7.         list.add(cb.like(root.get("name").as(String.class), "%"+um.getName()+"%"));  
  8.     }  
  9.     if(um.getUuid()>0){  
  10.         list.add(cb.equal(root.get("uuid").as(Integer.class), um.getUuid()));  
  11.     }  
  12.     Predicate[] p = new Predicate[list.size()];  
  13.     return cb.and(list.toArray(p));  
  14. }  
  15. };  


 

也可以使用CriteriaQuery来得到最后的Predicate,示例如下:

  
java代码:

查看复制到剪贴板打印

  1. Specification spec = new Specification() {  
  2.     public Predicate toPredicate(Root root,  
  3.             CriteriaQuery query, CriteriaBuilder cb) {  
  4.         Predicate p1 = cb.like(root.get("name").as(String.class), "%"+um.getName()+"%");  
  5.         Predicate p2 = cb.equal(root.get("uuid").as(Integer.class), um.getUuid());  
  6.         Predicate p3 = cb.gt(root.get("age").as(Integer.class), um.getAge());  
  7.         //把Predicate应用到CriteriaQuery中去,因为还可以给CriteriaQuery添加其他的功能,比如排序、分组啥的  
  8.         query.where(cb.and(p3,cb.or(p1,p2)));  
  9.         //添加排序的功能  
  10.         query.orderBy(cb.desc(root.get("uuid").as(Integer.class)));  
  11.           
  12.         return query.getRestriction();  
  13.     }  
  14. };  

多表联接

n多表连接查询稍微麻烦一些,下面演示一下常见的1:M,顺带演示一下1:1

n使用Criteria查询实现1对多的查询

1:首先要添加一个实体对象DepModel,并设置好UserModel和它的1对多关系,如下:

@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 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及其关系后,就可以在构建Specification的时候使用了,示例如下:

Specification spec = new Specification() {

public Predicate toPredicate(Root 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 depJoin = root.join(root.getModel().getSet("setDep",DepModel.class) , JoinType.LEFT);

 

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

//把Predicate应用到CriteriaQuery去,因为还可以给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查询实现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实现中,把SetJoin的那句换成如下的语句:

Join depJoin =

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

//root.join(“dep”,JoinType.LEFT); //这句话和上面一句的功能一样,更简单

你可能感兴趣的:(spring,java)