3 Spring JPA Specification 查询

最新推荐文章于 2024-04-18 08:07:25 发布

tyust512

最新推荐文章于 2024-04-18 08:07:25 发布

阅读量1.1k

点赞数

分类专栏： Spring Data JPA

Spring Data JPA 专栏收录该内容

8 篇文章 0 订阅

订阅专栏

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

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

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

Predicate toPredicate(Root<T> 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代码：

 
              查看 
              复制到剪贴板 
              打印 
             
 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应用到CriteriaQuery中去,因为还可以给CriteriaQuery添加其他的功能，比如排序、分组啥的  
         query.where(cb.and(p3,cb.or(p1,p2)));  
         //添加排序的功能  
         query.orderBy(cb.desc(root.get("uuid").as(Integer.class)));  
           
         return query.getRestriction();  
     }  
 };  