JPA原理(一) 模糊查询解析

本次就下面这段代码讲一下对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步:【构造查询条件】设定即可!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,723评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,003评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,512评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,825评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,874评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,841评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,812评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,582评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,033评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,309评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,450评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,158评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,789评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,409评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,609评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,440评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,357评论 2 352

推荐阅读更多精彩内容