PageHelper分页插件源码及原理剖析
摘要: com.github.pagehelper.PageHelper是⼀款好⽤的开源免费的Mybatis第三⽅物理分页插件。
PageHelper是⼀款好⽤的开源免费的Mybatis第三⽅物理分页插件，其实我并不想加上好⽤两个字，但是为了表扬插件作者开源免费的崇⾼精神，我毫不犹豫的加上了好⽤⼀词作为赞美。
原本以为分页插件，应该是很简单的，然⽽PageHelper⽐我想象的要复杂许多，它做的很强⼤，也很彻底，强⼤到使⽤者可能并不需要这么多功能，彻底到⼀参可以两⽤。但是，我认为，作为分页插件，完成物理分页任务是根本，其它的很多智能并不是必要的，保持它够傻够憨，专业术语叫stupid，简单就是美。
我们将简单介绍PageHelper的基本使⽤和配置参数的含义，重点分析PageHelper作为Mybatis分页插件的实现原理。
1. PageHelper的maven依赖及插件配置
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>4.1.6</version>
</dependency>
PageHelper除了本⾝的jar包外，它还依赖了⼀个叫jsqlparser的jar包，使⽤时，我们不需要单独指定jsqlparser的maven依赖，maven 的间接依赖会帮我们引⼊。
<!-- com.github.pagehelper为PageHelper类所在包名 -->
<plugin interceptor="com.github.pagehelper.PageHelper">
<property name="dialect" value="mysql" />
<!-- 该参数默认为false -->
<!-- 设置为true时，会将RowBounds第⼀个参数offset当成pageNum页码使⽤ -->
<!-- 和startPage中的pageNum效果⼀样 -->
<property name="offsetAsPageNum" value="false" />
<!-- 该参数默认为false -->
<!-- 设置为true时，使⽤RowBounds分页会进⾏count查询 -->
<property name="rowBoundsWithCount" value="true" />
<!-- 设置为true时，如果pageSize=0或者RowBounds.limit = 0就会查询出全部的结果 -->
<!-- （相当于没有执⾏分页查询，但是返回结果仍然是Page类型） <property name="pageSizeZero" value="true"/> -->
<!-- 3.3.0版本可⽤ - 分页参数合理化，默认false禁⽤ -->
<!-- 启⽤合理化时，如果pageNum<1会查询第⼀页，如果pageNum>pages会查询最后⼀页 -->
<!-- 禁⽤合理化时，如果pageNum<1或pageNum>pages会返回空数据 -->
<property name="reasonable" value="true" />
<!-- 3.5.0版本可⽤ - 为了⽀持startPage(Object params)⽅法 -->
<!-- 增加了⼀个`params`参数来配置参数映射，⽤于从Map或ServletRequest中取值 -->
<!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable，不配置映射的⽤默认值 -->
<!-- 不理解该含义的前提下，不要随便复制该配置 <property name="params" value="pageNum=start;pageSize=limit;"/> -->
</plugin>
上⾯是PageHelper官⽅给的配置和注释，虽然写的很多，不过确实描述的很明⽩。
dialect：标识是哪⼀种数据库，设计上必须。
offsetAsPageNum：将RowBounds第⼀个参数offset当成pageNum页码使⽤，这就是上⾯说的⼀参两⽤，个⼈觉得完全没必
要，offset = pageSize * pageNum就搞定了，何必混⽤参数呢？
rowBoundsWithCount：设置为true时，使⽤RowBounds分页会进⾏count查询，个⼈觉得完全没必要，实际开发中，每⼀个列表分页查询，都配备⼀个count数量查询即可。
reasonable：value=true时，pageNum⼩于1会查询第⼀页，如果pageNum⼤于pageSize会查询最后
⼀页 ，个⼈认为，参数校验在进⼊Mybatis业务体系之前，就应该完成了，不可能到达Mybatis业务体系内参数还带有⾮法的值。
这么⼀来，我们只需要记住 dialect = mysql ⼀个参数即可，其实，还有下⾯⼏个相关参数可以配置。
autoDialect：true or false，是否⾃动检测dialect。
autoRuntimeDialect：true or false，多数据源时，是否⾃动检测dialect。
closeConn：true or false，检测完dialect后，是否关闭Connection连接。
上⾯这3个智能参数，不到万不得已，我们不应该在系统中使⽤，我们只需要⼀个dialect = mysql 或者 dialect = oracle就够了，如果系统中需要使⽤，还是得问问⾃⼰，是否真的⾮⽤不可。
2. PageHelper源码分析
@Intercepts(@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class public class PageHelper implements Interceptor {
//sql⼯具类
private SqlUtil sqlUtil;
//属性参数信息
private Properties properties;
//配置对象⽅式
private SqlUtilConfig sqlUtilConfig;
//⾃动获取dialect，如果没有setProperties或setSqlUtilConfig，也可以正常进⾏
private boolean autoDialect = true;
//运⾏时⾃动获取dialect
private boolean autoRuntimeDialect;
//多数据源时，获取jdbcurl后是否关闭数据源
private boolean closeConn = true;
/
/缓存
private Map<String, SqlUtil> urlSqlUtilMap = new ConcurrentHashMap<String, SqlUtil>();
private ReentrantLock lock = new ReentrantLock();
// ...
}
上⾯是官⽅源码以及源码所带的注释，我们再补充⼀下。
SqlUtil：数据库类型专⽤sql⼯具类，⼀个数据库url对应⼀个SqlUtil实例，SqlUtil内有⼀个Parser对象，如果是mysql，它是MysqlParser，如果是oracle，它是OracleParser，这个Parser对象是SqlUtil不同实例的主要存在价值。执⾏count查询、设置Parser对象、执⾏分页查询、保存Page分页对象等功能，均由SqlUtil来完成。
SqlUtilConfig：Spring Boot中使⽤，忽略。
autoRuntimeDialect：多个数据源切换时，⽐如mysql和oracle数据源同时存在，就不能简单指定dialect，这个时候就需要运⾏时⾃动检测当前的dialect。
Map<String, SqlUtil> urlSqlUtilMap：它就⽤来缓存autoRuntimeDialect⾃动检测结果的，key是数据库的url，value是SqlUtil。由于这种⾃动检测只需要执⾏1次，所以做了缓存。
ReentrantLock lock：这个lock对象是⽐较有意思的现象，urlSqlUtilMap明明是⼀个同步ConcurrentHashMap，⼜搞了⼀个lock出来同步ConcurrentHashMap做什么呢？是否是画蛇添⾜？在《Java并发编程实战》⼀书中有详细论述，简单的说，ConcurrentHashMap 可以保证put或者remove⽅法⼀定是线程安全的，但它不能保证put、get、remove的组合操作是线程安全的，为了保证组合操作也是线程安全的，所以使⽤了lock。
com.github.pagehelper.PageHelper.java源码。
// Mybatis⽅法
public Object intercept(Invocation invocation) throws Throwable {
if (autoRuntimeDialect) {
// 多数据源
SqlUtil sqlUtil = getSqlUtil(invocation);
return sqlUtil.processPage(invocation);
} else {
// 单数据源
if (autoDialect) {
if (autoDialect) {
initSqlUtil(invocation);
}
// 指定了dialect
return sqlUtil.processPage(invocation);
}
}
public synchronized void initSqlUtil(Invocation invocation) {
if (this.sqlUtil == null) {
this.sqlUtil = getSqlUtil(invocation);
if (!autoRuntimeDialect) {
properties = null;
sqlUtilConfig = null;
}
autoDialect = false;
}
}
public void setProperties(Properties p) {
checkVersion();
//多数据源时，获取jdbcurl后是否关闭数据源
String closeConn = p.getProperty("closeConn");
//解决#97
if(StringUtil.isNotEmpty(closeConn)){
this.closeConn = Boolean.parseBoolean(closeConn);
}
//初始化SqlUtil的PARAMS
SqlUtil.Property("params"));
//数据库⽅⾔
String dialect = p.getProperty("dialect");
String runtimeDialect = p.getProperty("autoRuntimeDialect");
if (StringUtil.isNotEmpty(runtimeDialect) && runtimeDialect.equalsIgnoreCase("TRUE")) {
this.autoRuntimeDialect = true;
this.autoDialect = false;
this.properties = p;
} else if (StringUtil.isEmpty(dialect)) {
autoDialect = true;
this.properties = p;
} else {
autoDialect = false;
sqlUtil = new SqlUtil(dialect);
sqlUtil.setProperties(p);
}
}
public SqlUtil getSqlUtil(Invocation invocation) {
MappedStatement ms = (MappedStatement) Args()[0];
//改为对dataSource做缓存
DataSource dataSource = ms.getConfiguration().getEnvironment().getDataSource();
String url = getUrl(dataSource);
if (ainsKey(url)) {
(url);
}
try {
lock.lock();
if (ainsKey(url)) {
(url);
}
if (StringUtil.isEmpty(url)) {
throw new RuntimeException("⽆法⾃动获取jdbcUrl，请在分页插件中配置dialect参数!");            }
String dialect = Dialect.fromJdbcUrl(url);
if (dialect == null) {
throw new RuntimeException("⽆法⾃动获取数据库类型，请通过dialect参数指定!");
}
SqlUtil sqlUtil = new SqlUtil(dialect);
if (this.properties != null) {
if (this.properties != null) {
sqlUtil.setProperties(properties);
} else if (this.sqlUtilConfig != null) {
sqlUtil.setSqlUtilConfig(this.sqlUtilConfig);
}
urlSqlUtilMap.put(url, sqlUtil);
return sqlUtil;
} finally {
lock.unlock();
}
}
autoRuntimeDialect：多数据源，会创建多个SqlUtil。
autoDialect：单数据源，只会创建1个SqlUtil。单数据源时，也可以当做多数据源来使⽤。指定了dialect：只会创建1个SqlUtil。
3. PageSqlSource
public abstract class PageSqlSource implements SqlSource {
/**
* 获取正常的BoundSql
*
* @param parameterObject
* @return
*/
protected abstract BoundSql getDefaultBoundSql(Object parameterObject);
/**
* 获取Count查询的BoundSql
*
* @param parameterObject
* @return
*/
protected abstract BoundSql getCountBoundSql(Object parameterObject);
/**
* 获取分页查询的BoundSql
*
* @param parameterObject
* @return
*/
protected abstract BoundSql getPageBoundSql(Object parameterObject);
/**
* 获取BoundSql
*
* @param parameterObject
* @return
*/
@Override
public BoundSql getBoundSql(Object parameterObject) {
Boolean count = getCount();
if (count == null) {
return getDefaultBoundSql(parameterObject);
} else if (count) {
return getCountBoundSql(parameterObject);
} else {
return getPageBoundSql(parameterObject);
}
}
}
getDefaultBoundSql：获取原始的未经改造的BoundSql。
getCountBoundSql：不需要写count查询，插件根据分页查询sql，智能的为你⽣成的count查询BoundSql。
getPageBoundSql：获取分页查询的BoundSql。
举例：
DefaultBoundSql：select  stud_id as studId , name, email, dob, phone from students
CountBoundSql：select  count(0) from students --由PageHelper智能完成
PageBoundSql：select  stud_id as studId , name, email, dob, phone from students limit ?, ?
（Made In Intellij Idea IDE）
public class PageStaticSqlSource extends PageSqlSource {
private String sql;
private List<ParameterMapping> parameterMappings;
private Configuration configuration;
private SqlSource original;
@Override
protected BoundSql getDefaultBoundSql(Object parameterObject) {
String tempSql = sql;
String orderBy = OrderBy();
if (orderBy != null) {
tempSql = verToOrderBySql(sql, orderBy);
}
return new BoundSql(configuration, tempSql, parameterMappings, parameterObject);
}
@Override
protected BoundSql getCountBoundSql(Object parameterObject) {
// localParser指的就是MysqlParser或者OracleParser
// ().getCountSql(sql)，可以根据原始的sql，⽣成⼀个count查询的sql
分页查询插件return new BoundSql(configuration, ().getCountSql(sql), parameterMappings, parameterObject);
}
@Override
protected BoundSql getPageBoundSql(Object parameterObject) {
String tempSql = sql;
String orderBy = OrderBy();
if (orderBy != null) {
tempSql = verToOrderBySql(sql, orderBy);
}
// getPageSql可以根据原始的sql，⽣成⼀个带有分页参数信息的sql，⽐如 limit ?, ?
tempSql = ().getPageSql(tempSql);
// 由于sql增加了分页参数的？号占位符，getPageParameterMapping()就是在原有List<ParameterMapping>基础上，增加两个分页参数对应的ParameterMappi        return new BoundSql(configuration, tempSql, ().getPageParameterMapping(configuration, BoundSql(parameterObject)), paramete    }
}
假设List<ParameterMapping>原来的size=2，添加分页参数后，其size=4，具体增加多少个，看分页参数的？号数量。
其他PageSqlSource，原理和PageStaticSqlSource⼀模⼀样。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。