【排错日记】PageHelper插件的默认分页参数

现象

没有写如下代码,执行的结果却被分页显示了。

PageHelper.startPage(listParam.getPageNum(), listParam.getPageSize());

源码分析

 //调用方法判断是否需要进行分页，如果不需要，直接返回结果
if (!dialect.skip(ms, parameter, rowBounds)) {
    //判断是否需要进行 count 查询
    if (dialect.beforeCount(ms, parameter, rowBounds)) {
        //查询总数
        Long count = count(executor, ms, parameter, rowBounds, null, boundSql);
        //处理查询总数，返回 true 时继续分页查询，false 时直接返回
        if (!dialect.afterCount(count, parameter, rowBounds)) {
            //当查询总数为 0 时，直接返回空的结果
            return dialect.afterPage(new ArrayList(), parameter, rowBounds);
        }
    }
    resultList = ExecutorUtil.pageQuery(dialect, executor,
            ms, parameter, rowBounds, resultHandler, boundSql, cacheKey);
} else {
    //rowBounds用参数值，不使用分页插件处理时，仍然支持默认的内存分页
    resultList = executor.query(ms, parameter, rowBounds, resultHandler, cacheKey, boundSql);
}

可知关键代码dialect.skip(ms, parameter, rowBounds)，进入该方法：

 @Override
public boolean skip(MappedStatement ms, Object parameterObject, RowBounds rowBounds) {
    if (ms.getId().endsWith(MSUtils.COUNT)) {
        throw new RuntimeException("在系统中发现了多个分页插件，请检查系统配置!");
    }
    Page page = pageParams.getPage(parameterObject, rowBounds);
    if (page == null) {
        return true;
    } else {
        //设置默认的 count 列
        if (StringUtil.isEmpty(page.getCountColumn())) {
            page.setCountColumn(pageParams.getCountColumn());
        }
        autoDialect.initDelegateDialect(ms);
        return false;
    }
}

可知Page page = pageParams.getPage(parameterObject, rowBounds)是关键，进入：

 if (page == null) {
    if (rowBounds != RowBounds.DEFAULT) {
        if (offsetAsPageNum) {
            page = new Page(rowBounds.getOffset(), rowBounds.getLimit(), rowBoundsWithCount);
        } else {
            page = new Page(new int[]{rowBounds.getOffset(), rowBounds.getLimit()}, rowBoundsWithCount);
            //offsetAsPageNum=false的时候，由于PageNum问题，不能使用reasonable，这里会强制为false
            page.setReasonable(false);
        }
        if(rowBounds instanceof PageRowBounds){
            PageRowBounds pageRowBounds = (PageRowBounds)rowBounds;
            page.setCount(pageRowBounds.getCount() == null || pageRowBounds.getCount());
        }
    } else if(parameterObject instanceof IPage || supportMethodsArguments){
        try {
            page = PageObjectUtil.getPageFromObject(parameterObject, false);
        } catch (Exception e) {
            return null;
        }
    }
    if(page == null){
        return null;
    }
    PageHelper.setLocalPage(page);
}

关键代码如下：

if(parameterObject instanceof IPage || supportMethodsArguments){
    try {
        page = PageObjectUtil.getPageFromObject(parameterObject, false);
    } catch (Exception e) {
        return null;
    }
}

发现supportMethodsArguments=true，这时就会根据提交的参数自动设置分页，证据如下：

 try {
    Object _pageNum = getParamValue(paramsObject, "pageNum", required);
    Object _pageSize = getParamValue(paramsObject, "pageSize", required);
    if (_pageNum == null || _pageSize == null) {
        if(hasOrderBy){
            Page page = new Page();
            page.setOrderBy(orderBy.toString());
            page.setOrderByOnly(true);
            return page;
        }
        return null;
    }
    pageNum = Integer.parseInt(String.valueOf(_pageNum));
    pageSize = Integer.parseInt(String.valueOf(_pageSize));
} catch (NumberFormatException e) {
    throw new PageException("分页参数不是合法的数字类型!", e);
}
//设置分页
Page page = new Page(pageNum, pageSize);

结论

到现在，恍然大悟，可知：

设置参数supportMethodsArguments为true，并且提交的请求参数里有pageNum和pageSize，同时满足都不为null时，即使不显示写明分页也会自动分页。