Spring Data JPA中的动态查询

原文出自：http://blog.csdn.net/anxpp/article/details/51996472，转载标明出处，谢谢！

    Spring Data JPA大大的简化了我们持久层的开发，但是实际应用中，我们还是需要动态查询的。

    比如，前端有多个条件，这些条件很多都是可选的，那么后端的SQL，就应该是可以定制的，在使用Hibernate的时候，可以通过判断条件来拼接SQL(HQL)，当然，Spring Data JPA在简化我们开发的同时，也是提供了支持的。

    通过实现Criteria二实现的动态查询，需要我们的Repo接口继承JpaSpecificationExecutor接口，这是个泛型接口。

    然后查询的时候，传入动态查询参数，分页参数等即可。

    使用起来很简单，不过为了知其所以然，先介绍一下Criteria API。

    Criteria API

    如果编译器能够对查询执行语法正确性检查，那么对于 Java 对象而言该查询就是类型安全的。Java™Persistence API (JPA) 的 2.0 版本引入了 Criteria API，这个 API 首次将类型安全查询引入到 Java 应用程序中，并为在运行时动态地构造查询提供一种机制。本文介绍如何使用 Criteria API 和与之密切相关的 Metamodel API 编写动态的类型安全查询。

    在使用Spring Data JPA的时候，只要我们的Repo层继承JpaSpecificationExecutor接口就可以使用Specification进行动态查询了，我们先看下JpaSpecificationExecutor接口：

 

[java]  view plain  copy 

 

 print ?

1. public interface JpaSpecificationExecutor<T> {  
2.     T findOne(Specification<T> spec);  
3.     List<T> findAll(Specification<T> spec);  
4.     Page<T> findAll(Specification<T> spec, Pageable pageable);  
5.     List<T> findAll(Specification<T> spec, Sort sort);  
6.     long count(Specification<T> spec);  
7. }  

    可以看到提供了5个方法，方法的参数和返回值已经很明显的表达了其意图。其中的参数，Pageable和Sort应该是比较简单的，分别是分页参数和排序参数，而重点就是Specification参数，先看下这个接口的定义：

[java]  view plain  copy 

 

 print ?

1. public interface Specification<T> {  
2.     Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder cb);  
3. }  

    其中就一个方法，返回的是动态查询的数据结构。

 

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

    这里使用的都是Java EE中的规范，具体实现本人采用的是Hibernate，当然也可以选择其他实现了JPA规范的数据持久层框架。

    这里需要再次回过头看看Criteria API中的一些东西：

    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：一个简单或复杂的谓词类型，其实就相当于条件或者是条件组合
    其中支持的方法非常之强大，下面给出一个示例，大家可以参考一下，同样的，可以根据示例，自己可以写出更为复杂的查询：
    Repo接口：

 

[java]  view plain  copy 

 

 print ?

1. public interface DevHREmpConstrastDao  
2.         extends JpaRepository<DevHREmpConstrast, Long>,JpaSpecificationExecutor<DevHREmpConstrast>  

    查询实例1：

[java]  view plain  copy 

 

 print ?

1. /** 
2.  * 条件查询时动态组装条件 
3.  */  
4. private Specification<DevHREmpConstrast> where(  
5.         final String corg,final String name,final String type,final String date,final String checker){  
6.     return new Specification<DevHREmpConstrast>() {  
7.         @Override  
8.         public Predicate toPredicate(Root<DevHREmpConstrast> root, CriteriaQuery<?> query, CriteriaBuilder cb) {  
9.             List<Predicate> predicates = new ArrayList<Predicate>();  
10.             //机构  
11.             if(corg!=null&&!corg.equals("")){  
12.                 List<String> orgIds = organizationDao.findByName("%"+corg+"%");  
13.                 if(orgIds.size()>0&&orgIds.size()<1000)  
14.                     predicates.add(root.<String>get("confirmOrgNo").in(orgIds));//confirmOrgNo  
15.             }  
16.             //名字  
17.             if(name!=null&&!name.equals("")){  
18.                 List<String> userIds = userDao.findByName(name);  
19.                 if(userIds.size()>0&&userIds.size()<1000)//如果太多就不管了这个条件了  
20.                     predicates.add(root.<String>get("hrUserName").in(userIds));  
21.             }  
22.             //类型  
23.             if(type!=null&&!type.equals(""))  
24.                 predicates.add(cb.equal(root.<String>get("hrUpdateType"),type));  
25.             //日期  
26.             if(date!=null&&!date.equals("")){  
27.                 //处理时间  
28.                 SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");  
29.                 Date startDate;  
30.                 Date endDate;  
31.                 try {  
32.                     startDate = format.parse(date);  
33.                 } catch (ParseException e) {  
34.                     startDate = new Date(946656000000L);//2000 01 01  
35.                 }  
36.                 endDate = startDate;  
37.                 Calendar calendar = Calendar.getInstance() ;  
38.                 calendar.setTime(endDate);  
39.                 calendar.add(Calendar.DATE, 1);  
40.                 endDate = calendar.getTime();  
41.                 calendar = null;  
42.                 predicates.add(cb.between(root.<Date>get("insDate"),startDate,endDate));  
43.             }  
44.             //审核人  
45.             if(checker!=null&&!checker.equals("")){  
46.                 List<String> userIds = userDao.findByName(checker);  
47.                 if(userIds.size()>0&&userIds.size()<1000)//如果太多就不管了这个条件了  
48.                     predicates.add(root.<String>get("confirmUserId").in(userIds));  
49.             }  
50.             return query.where(predicates.toArray(new Predicate[predicates.size()])).getRestriction();  
51.         }  
52.     };  
53. }  

    查询实例2：

 

 

[java]  view plain  copy 

 

 print ?

1. /** 
2.    * 条件查询时动态组装条件 
3.    */  
4.   private Specification<DevHREmpConstrast> where(  
5.           final String corg,final String name,final String type,final String date,final String checker){  
6.       return new Specification<DevHREmpConstrast>() {  
7.           @Override  
8.           public Predicate toPredicate(Root<DevHREmpConstrast> root, CriteriaQuery<?> query, CriteriaBuilder cb) {  
9.               List<Predicate> predicates = new ArrayList<Predicate>();  
10.               //机构  
11.               if(corg!=null&&!corg.equals("")){  
12.                   List<String> orgIds = organizationDao.findByName("%"+corg+"%");  
13.                   if(orgIds.size()>0&&orgIds.size()<1000)  
14.                       predicates.add(root.<String>get("confirmOrgNo").in(orgIds));//confirmOrgNo  
15.               }  
16.               //名字  
17.               if(name!=null&&!name.equals("")){  
18.                   List<String> userIds = userDao.findByName(name);  
19.                   if(userIds.size()>0&&userIds.size()<1000)//如果太多就不管了这个条件了  
20.                       predicates.add(root.<String>get("hrUserName").in(userIds));  
21.               }  
22.               //类型  
23.               if(type!=null&&!type.equals(""))  
24.                   predicates.add(cb.equal(root.<String>get("hrUpdateType"),type));  
25.               //日期  
26.               if(date!=null&&!date.equals("")){  
27.                   //处理时间  
28.                   SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");  
29.                   Date startDate;  
30.                   Date endDate;  
31.                   try {  
32.                       startDate = format.parse(date);  
33.                   } catch (ParseException e) {  
34.                       startDate = new Date(946656000000L);//2000 01 01  
35.                   }  
36.                   endDate = startDate;  
37.                   Calendar calendar = Calendar.getInstance() ;  
38.                   calendar.setTime(endDate);  
39.                   calendar.add(Calendar.DATE, 1);  
40.                   endDate = calendar.getTime();  
41.                   calendar = null;  
42.                   predicates.add(cb.between(root.<Date>get("insDate"),startDate,endDate));  
43.               }  
44.               //审核人  
45.               if(checker!=null&&!checker.equals("")){  
46.                   List<String> userIds = userDao.findByName(checker);  
47.                   if(userIds.size()>0&&userIds.size()<1000)//如果太多就不管了这个条件了  
48.                       predicates.add(root.<String>get("confirmUserId").in(userIds));  
49.               }  
50.               return query.where(predicates.toArray(new Predicate[predicates.size()])).getRestriction();  
51.           }  
52.       };  
53.   }  

    然后调用dao层方法传入where()方法返回的参数即可。