JPA Specification禁用总数查询

背景

JPA specification查询使用Pageable进行分页查询,返回的Page对象会查询数据的总数用于计算总页数。这种方式就存在弊端,用户每点击一页都会执行一次总数查询。在数据库数据过多的情况下,这种查询方式通常会伴随着慢查询。

优化方案
通常过大的数据就没必要去计算总页数。对于用户来说去查询最后一页的数据并没有多大意义。用户可以查询采用精确查询,比如根据手机号码查询指定用户的信息。前端分页可以采用向前翻和向后翻的方式。后端只需要根据LIMIT查询的结果,返回给前端是否存在下一页数据即可。

通过查看源码,我们发现JPA并没有提供传递Pageable对象,返回List集合的方法。接下来我们考虑一下是不是有办法把Specification的总数查询给禁用掉,然后实现原生查询 SELECT * FROM xxx LIMIT N, M的功能。

public interface JpaSpecificationExecutor<T> {

    List<T> findAll(Specification<T> spec);

    Page<T> findAll(Specification<T> spec, Pageable pageable);

    List<T> findAll(Specification<T> spec, Sort sort);
}

JPA源码分析

首先看一下JPA是怎么实现总数查询的,查看SimpleJpaRepository的findAll实现。

    /**
     * Returns a {@link Page} of entities matching the given {@link Specification}.
     * 
     * @param spec
     * @param pageable
     * @return
     */
    public Page<T> findAll(Specification<T> spec, Pageable pageable) {
       // 根据复杂条件获取TypedQuery
        TypedQuery<T> query = getQuery(spec, pageable);
        // pageable为空则执行查询获取查询结果
        // pageable不为空则执行readPage
        return pageable == null ? new PageImpl<T>(query.getResultList())
                : readPage(query, getDomainClass(), pageable, spec);
    }

这部分的逻辑很简单,主要是根据复杂条件查询参数获取TypedQuery对象。最后根据是否指定分页参数来决定返回的结果。由于我们这里关注的是分页情况下的总数查询,那么接着看readPage方法。

    /**
     * Reads the given {@link TypedQuery} into a {@link Page} applying the given {@link Pageable} and
     * {@link Specification}.
     *
     * @param query must not be {@literal null}.
     * @param domainClass must not be {@literal null}.
     * @param spec can be {@literal null}.
     * @param pageable can be {@literal null}.
     * @return
     */
    protected <S extends T> Page<S> readPage(TypedQuery<S> query, final Class<S> domainClass, Pageable pageable,
            final Specification<S> spec) {
        // 设置LIMIT参数    
        query.setFirstResult(pageable.getOffset());
        // 设置每页数量
        query.setMaxResults(pageable.getPageSize());
        // 分别执行数据查询和总数查询,封装成Page对象
        return PageableExecutionUtils.getPage(query.getResultList(), pageable, new TotalSupplier() {

            @Override
            public long get() {
                return executeCountQuery(getCountQuery(spec, domainClass));
            }
        });
    }

此时,我们已经发现了JPA默认查询总数的具体地方,那么假如我们不需要这个总数查询,只需要将该方法通过子类重写就可以了。以下为具体的代码实现。

/**
 * 分页查询,不查询总数
 **/
@Repository
public class CriteriaNoCountRepository {

    /**
     * 注入JPA实体管理器用于自定义Repository的初始化
     */
    @PersistenceContext
    protected EntityManager entityManager;

    public <T, ID extends Serializable> Page<T> findAll(Specification<T> spec, Pageable pageable, Class<T> clazz){
        // 创建对象
        SimpleJpaNoCountRepository<T, ID> noCountRepository = new SimpleJpaNoCountRepository<T, ID>(clazz, entityManager);
        // 执行查询方法
        return noCountRepository.findAll(spec, pageable);
    }

    /**
     * 创建一个内部类 继承SimpleJpaRepository,重写readPage方法
     */
    public static class SimpleJpaNoCountRepository<T, ID extends Serializable> extends SimpleJpaRepository<T, ID> {

        public SimpleJpaNoCountRepository(Class<T> domainClass, EntityManager entityManager) {
            super(domainClass, entityManager);
        }

        /**
         * 不对总数据进行查询
         * 根据查询的结果估算总数用于算出hasNext hasPrevious
         */
        @Override
        protected <S extends T> Page<S> readPage(TypedQuery<S> query, Class<S> domainClass, Pageable pageable, Specification<S> spec) {
            query.setFirstResult(pageable.getOffset());
            query.setMaxResults(pageable.getPageSize());

            // 分页总数查询
            List<S> content = query.getResultList();


            // 分页查询结果小于查询数 page-> hasNext = false
            if (content.size() < pageable.getPageSize()) {
                // 查询结果小于需求数,说明没有下一页
                return new PageImpl<S>(content, pageable, (pageable.getPageNumber() + 1) * pageable.getPageSize());
            }
            // page -> hasNext = true;
            return new PageImpl<S>(content, pageable, (pageable.getPageNumber() + 1) * pageable.getPageSize() + 1);
        }
    }
}

这里的总数计算公式是怎么来的呢?我们这里最终的目的是为了返回正确的hasNext和hasPrevious字段,由于PageImpl类未提供set方法让我们设置这两个字段,而是通过Pageable和count两个字段算出,因此我们需要通过计算一个假的count传递进去。

    @Override
    public boolean hasNext() {
        return getNumber() + 1 < getTotalPages();
    }

我们接着看一下PageImpl的实现,可以看到hasNext()方法判断逻辑很简单,就是当前页小于总页数,就存在下一页。

因此我们总数只需要根据当前页数进行计算

hasNext = true  -> count = (pageNumber + 1) * pageSize + 1
hasNext = false -> count = (pageNumber + 1) * pageSize

补充说明
这里计算hasNext的逻辑是根据结果数量和预期每页数量做的比较。如果查询小于每页需要的数量则认为没有下一页。当总数量是每页数量的整数倍,并且翻到最后一页的时候,这个判断逻辑可能会出现误判。举个例子,数据库中有10条数据,我们进行分页查询每页查询两条,当查询到第五页的时候,由于此时返回的也是2条数据,那么根据刚刚的逻辑,hasNext=true。然而再去进行查询,已经查询不到数据了。

参考资料

https://stackoverflow.com/questions/26738199/how-to-disable-count-when-specification-and-pageable-are-used-together

https://gist.github.com/tcollins/0ebd1dfa78028ecdef0b

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