若依系统分页工具学习-PageHelper篇十五

922 阅读2分钟

这是我参与11月更文挑战的第26天,活动详情查看:2021最后一次更文挑战

我们接着昨天的文章继续阅读PageHelper的项目源码。

昨日文章中我们介绍了com.github.pagehelper.page包中的两个类:PageParams以及PageBoundSqlInterceptors。了解到PageParams可以保存分页参数,而执行SQL的拦截器可以按照指定的次序保存在PageBoundSqlInterceptors.chain中。

并且作者在代码中使用了大量的java.util.Properties类的接口,我们也学习到了如何使用java.util.Properties类,以及Class.forName(xx).newInstance()这一创建对象的方式。

通过我们测试Class.forName(xx).newInstance(),这一创建对象的方式已经是“废弃”了,即Deprecated,现在应该使用如下方式:

Object ob = Class.forName("xxx").getDeclaredConstructor(...).newInstance(...)

今天我们继续来看com.github.pagehelper.page中的其他两个类:PageMethod以及PageAutoDialect

PageMethod

PageMethod,基础分页方法,有两个静态变量,一个是我们前面已经熟知的LOCAL_PAGE,线程局部变量;另一个静态变量DEFAULT_COUNT,默认值为true。

其中的方法大致可以划分为:

  1. LOCAL_PAGE的setter/getter/clear方法: setLocalPage/getLocalPage/clearPage
  2. 获取查询count总数的方法:long count(select)
  3. 五种参数的名为startPage方法;
  4. 两种参数形式的offsetPage方法;
  5. 设置参数的orderBy属性的orderBy方法;
  6. 通过配置文件设置DEFAULT_COUNT值的setStaticProperties方法。

看到startPage方法我们或许会有些眼熟,没错,在Controller接口入口处执行的方法不也叫startPage吗,通过查找若依系统源码,我们发现某个Controller中调用的startPage方法入口均为BaseController中的startPage方法,并在方法内部有:

PageHelper.startPage(pageNum, pageSize, orderBy).....

而PageHelper的类定义为:

public class PageHelper extends PageMethod implements Dialect, BoundSqlInterceptor.Chain {
    // 此处省略类内部代码
}

PageHelperPageMethod的子类,而实际执行的startPage方法正是PageMethod中的startPage方法。

根据我们前面的解读,我们知道startPage方法的重要作用就是设置Page变量,并存储在线程局部变量LOCAL_PAGE中以便后续执行分页sql时获取。

根据PageHelper中的文档HowToUse.md以及源码,我们了解到offsetPagestartPage方法作用相似。(源码显示offsetPage方法不支持设置reasonable与pageSizeZero参数)。