本次就下面这段代码讲一下对JPA模糊查询的理解，记录的同时，希望能帮到他人。
之所以选择解析这段代码，是因为自己也因这段代码迷惑过，并且它具有一定的代表性，管中窥豹，可见一斑，把这个例子理解了，模糊查询也应该了解的差不多了
//源于文件 CfgPhysicalDbServiceImpl.java
public Map<String,Object> queryAll1(CfgPhysicalDbQueryCriteria criteria, Pageable pageable){
Page<CfgPhysicalDb> page = cfgPhysicalDbRepository.findAll(
(root, criteriaQuery, criteriaBuilder) -> QueryHelp.getPredicate(root,criteria,criteriaBuilder),pageable);
return PageUtil.toPage(page.map(cfgPhysicalDbMapper::toDto));
}
一、解析该Lambda表达式
这是一个Lambda表达式，如果不明白的话可以参考文章 [https://www.cnblogs.com/CarpenterLee/p/5978721.html]
为了方便阅读，在下面代码中不使用lambda表达式，上述代码等价于：
public Map<String,Object> queryAll(CfgPhysicalDbQueryCriteria criteria, Pageable pageable){
Page<CfgPhysicalDb> page = cfgPhysicalDbRepository.findAll(
new Specification<CfgPhysicalDb>() {
@Override
public Predicate toPredicate(Root<CfgPhysicalDb> root, CriteriaQuery<?> query, CriteriaBuilder criteriaBuilder) {
return QueryHelp.getPredicate(root,criteria,criteriaBuilder);
}
},pageable);
return PageUtil.toPage(page.map(cfgPhysicalDbMapper::toDto));
}
二、弄清楚JPA repository 的结构图
可以使用 Intellij IDEA 的快捷键 Ctrl + Alt + Shirft + U 生成UML图
JPA Repository
1、我们来分析一下上图中的几个类：
这是业务接口 CfgPhysicalDbRepository 的代码：
public interface CfgPhysicalDbRepository extends JpaRepository<CfgPhysicalDb, Integer>, JpaSpecificationExecutor<CfgPhysicalDb> {
}
（1）JpaRepository 接口：它的作用是定义了常用的 CRUD 方法
Repository 接口类似于 Dao 或者 mybatis 中的 mapper，含义上略有不同，我们的业务接口 CfgPhysicalDbRepository 会继承两个接口（接口是可以继承多个的）, JpaRepository 接口和 JpaSpecificationExecutor 接口。业务接口 CfgPhysicalDbRepository 会做两件事，一个是在接口中定义自己的方法，如需要写原生 sql 的方法都习惯写在这里；第二个是继承 JpaRepository 接口中已经存在的 CRUD 方法。所以 JpaRepository 接口的作用是定义了常用的 CRUD 方法。
JpaRepository 接口的三个父接口中，CrudRepository 接口定义了最基本的 CRUD 方法；PagingAndSortingRepository 接口定义了分页和排序要用到的方法； QueryByExampleExecutor 接口定义的是按实例进行查询的方法。
（2）JpaSpecificationExecutor 接口：自定义查询的接口
比如模糊查询、表关联查询等都通过它来完成，业务接口 CfgPhysicalDbRepository 同样实现了它，我们在代码中调用的 findAll(Specification<T> spec, Pageable pageable) 方法就是由它定义的。
（3）SimpleJpaRepository 类：常用 CRUD 方法的真正实现类
当业务接口 CfgPhysicalDbRepository 调用 JpaRepository 接口中的 CRUD 方法，或者 JpaSpecificationExecutor 接口中的 findAll 方法时，应该有一个业务实现类 CfgPhysicalDbRepositoryImpl 来实现这些方法，所以我们可以在同一个包下定义一个实现类 CfgPhysicalDbRepositoryImpl 来重写这些方法。但是我们很少看见有人这样写，这样写就是和普通的 Dao、DaoImpl 没有两样了。 JPA 有它自己的玩法，这些常用的方法， JPA 都通过接口定义好并且在 SimpleJpaRepository 中替你一一实现了，所以说当代码执行找不到 CfgPhysicalDbRepositoryImpl 的时候，就会一直向下找，最终找到 SimpleJpaRepository 中的实现方法为止，此处是一个委派模式。
2、详解 SimpleJpaRepository 的 findAll(Specification<T> spec, Pageable pageable) 方法
它的代码如下：
public Page<T> findAll(@Nullable Specification<T> spec, Pageable pageable) {
TypedQuery<T> query = getQuery(spec, pageable);
return isUnpaged(pageable) ? new PageImpl<T>() : readPage(query, getDomainClass(), pageable, spec);
}
（1）JPA的复杂查询都必须经历四个步骤：
1、获取 builder => CriteriaBuilder builder = em.getCriteriaBuilder();
2、获取 Query =>CriteriaQuery<Student> query = builder.createQuery(CfgPhysicalDb.class);
3、在 Query 中构造查询条件 => Predicate predicate = spec.toPredicate(root, query, builder);
4、执行查询 => query.getResultList()
这四个步骤中第1、2、4步在所有复杂查询中都完全相同，只有第3步是不同的，所以 JPA 在 SimpleJpaRepository 将第1、2、4步都做了统一处理，留下第3步让我们自己实现，我们在 CfgPhysicalDbServiceImpl.java 重写了匿名类的 toPredicate(...) 方法就是在做第3步，上述代码的 query.getResultList() 则完成了第4步执行查询。
（2）深入SimpleJpaRepository.findAll(...)中的 getQuery(Specification<T> spec, Pageable pageable)方法
protected <S extends T> TypedQuery<S> getQuery(@Nullable Specification<S> spec, Class<S> domainClass, Sort sort) {
CriteriaBuilder builder = em.getCriteriaBuilder();
CriteriaQuery<S> query = builder.createQuery(domainClass);
Root<S> root = applySpecificationToCriteria(spec, domainClass, query);
query.select(root);
if (sort.isSorted()) {
query.orderBy(toOrders(sort, root, builder));
}
return applyRepositoryMethodMetadata(em.createQuery(query));
}
该方法的第一行 CriteriaBuilder builder = em.getCriteriaBuilder() 完成了复杂查询的第1步：【获取 builder】 ，第二行 Query CriteriaQuery<S> query = builder.createQuery(domainClass) 完成了第2步：【获取 Query】。
我们再进入 applySpecificationToCriteria(spec, domainClass, query) 方法中：
private <S, U extends T> Root<U> applySpecificationToCriteria(@Nullable Specification<U> spec, Class<U> domainClass,
CriteriaQuery<S> query) {
Assert.notNull(domainClass, "Domain class must not be null!");
Assert.notNull(query, "CriteriaQuery must not be null!");
Root<U> root = query.from(domainClass);
if (spec == null) {
return root;
}
CriteriaBuilder builder = em.getCriteriaBuilder();
Predicate predicate = spec.toPredicate(root, query, builder);
if (predicate != null) {
query.where(predicate);
}
return root;
}
我们重点看 Predicate predicate = spec.toPredicate(root, query, builder) 这一行，此处的 toPredicate(...)是在接口 Specification 中定义的，而我们在 CfgPhysicalDbServiceImpl.java 中通过匿名类的方式重写了toPredicate(...)方法。
重写 toPredicate(...) 的方法在网上一搜一大把，本例中使用 QueryHelp.getPredicate(root,criteria,criteriaBuilder),pageable) 对其进行了封装处理。
看到这里，一切明了，JPA 执行复杂查询的4个步骤都找到了各自代码实现的位置，其中有三步 JPA 都替我们完成了，而我们只需要在 service 的实现类中通过匿名类的方式实现第3步：【构造查询条件】设定即可！
网友评论