pageHelper版本4.2.1
1、PageHelper分页使用的组件
org.apache.ibatis.plugin.Interceptor是mybatis中的一种特有的拦截器,可以拦截特定的方法。
2、PageHelper拦截条件分析
PageHelper就是实现了Interceptor接口进行sql拦截,实现分页。
com.github.pagehelper.PageHelper源码
@Intercepts(@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}))
public class PageHelper extends BasePageHelper implements Interceptor {
private final SqlUtil sqlUtil = new SqlUtil();
// 获取分页sql以及分页参数
@Override
public Object intercept(Invocation invocation) throws Throwable {
return sqlUtil.intercept(invocation);
}
// 生成Executor的代理对象
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties properties) {
sqlUtil.setProperties(properties);
}
}
3、流程
mybatis在执行查询方法之前需要先实例化SqlSession,会调用到org.apache.ibatis.session.defaults.DefaultSqlSessionFactory#openSessionFromDataSource方法;
// 获取SqlSession
private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
Transaction tx = null;
try {
final Environment environment = configuration.getEnvironment();
final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
// 实例化Executor
final Executor executor = configuration.newExecutor(tx, execType);
// 将Executor的引用传给SqlSession
return new DefaultSqlSession(configuration, executor, autoCommit);
} catch (Exception e) {
closeTransaction(tx); // may have fetched a connection so lets call close()
throw ExceptionFactory.wrapException("Error opening session. Cause: " + e, e);
} finally {
ErrorContext.instance().reset();
}
}
在这个方法中会调用org.apache.ibatis.session.Configuration#newExecutor(org.apache.ibatis.transaction.Transaction, org.apache.ibatis.session.ExecutorType)实例化Executor对象;
实例化Executor之后会执行拦截器中的方法。
// 实例化Executor
public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
executorType = executorType == null ? defaultExecutorType : executorType;
executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
Executor executor;
if (ExecutorType.BATCH == executorType) {
executor = new BatchExecutor(this, transaction);
} else if (ExecutorType.REUSE == executorType) {
executor = new ReuseExecutor(this, transaction);
} else {
executor = new SimpleExecutor(this, transaction);
}
if (cacheEnabled) {
executor = new CachingExecutor(executor);
}
// 执行拦截器方法
executor = (Executor) interceptorChain.pluginAll(executor);
return executor;
}
遍历所有拦截器执行拦截器中的plugin方法,即com.github.pagehelper.PageHelper#plugin
public Object pluginAll(Object target) {
for (Interceptor interceptor : interceptors) {
// 执行拦截器中的plugin方法
target = interceptor.plugin(target);
}
return target;
}
该方法返回了一个Executor的代理对象
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
public static Object wrap(Object target, Interceptor interceptor) {
Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
Class<?> type = target.getClass();
Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
if (interfaces.length > 0) {
// 返回代理对象
return Proxy.newProxyInstance(
type.getClassLoader(),
interfaces,
new Plugin(target, interceptor, signatureMap));
}
return target;
}
之后SqlSession会通过Executor去执行查询,当Executor执行方法时,会执行Executor代理对象中的方法
@Override
public <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds) {
try {
MappedStatement ms = configuration.getMappedStatement(statement);
// Executor执行方法,此时会先执行刚才生成的代理对象的方法
return executor.query(ms, wrapCollection(parameter), rowBounds, Executor.NO_RESULT_HANDLER);
} catch (Exception e) {
throw ExceptionFactory.wrapException("Error querying database. Cause: " + e, e);
} finally {
ErrorContext.instance().reset();
}
}
代理对象中的方法org.apache.ibatis.plugin.Plugin#invoke
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
try {
Set<Method> methods = signatureMap.get(method.getDeclaringClass());
if (methods != null && methods.contains(method)) {
// 进行拦截
return interceptor.intercept(new Invocation(target, method, args));
}
return method.invoke(target, args);
} catch (Exception e) {
throw ExceptionUtil.unwrapThrowable(e);
}
}
拦截进入com.github.pagehelper.PageHelper#intercept方法
@Override
public Object intercept(Invocation invocation) throws Throwable {
return sqlUtil.intercept(invocation);
}
/**
* 真正的拦截器方法
*
* @param invocation
* @return
* @throws Throwable
*/
public Object intercept(Invocation invocation) throws Throwable {
try {
return doIntercept(invocation);
} finally {
clearLocalPage();
}
}
/**
* 真正的拦截器方法
*
* @param invocation
* @return
* @throws Throwable
*/
public Object doIntercept(Invocation invocation) throws Throwable {
//获取拦截方法的参数
Object[] args = invocation.getArgs();
MappedStatement ms = (MappedStatement) args[0];
Object parameterObject = args[1];
RowBounds rowBounds = (RowBounds) args[2];
List resultList;
if(autoDialect){
lock.lock();
try{
if(autoDialect){
autoDialect = false;
this.dialect = getDialect(ms);
}
}finally {
lock.unlock();
}
}
Dialect runtimeDialect = dialect;
if(autoRuntimeDialect){
runtimeDialect = getDialect(ms);
}
//调用方法判断是否需要进行分页,如果不需要,直接返回结果
if (!runtimeDialect.skip(ms, parameterObject, rowBounds)) {
ResultHandler resultHandler = (ResultHandler) args[3];
//当前的目标对象
Executor executor = (Executor) invocation.getTarget();
BoundSql boundSql = ms.getBoundSql(parameterObject);
//反射获取动态参数
Map<String, Object> additionalParameters = (Map<String, Object>) additionalParametersField.get(boundSql);
//判断是否需要进行 count 查询
if (runtimeDialect.beforeCount(ms, parameterObject, rowBounds)) {
//创建 count 查询的缓存 key
CacheKey countKey = executor.createCacheKey(ms, parameterObject, RowBounds.DEFAULT, boundSql);
countKey.update("_Count");
MappedStatement countMs = msCountMap.get(countKey);
if(countMs == null){
//根据当前的 ms 创建一个返回值为 Long 类型的 ms
countMs = MSUtils.newCountMappedStatement(ms);
msCountMap.put(countKey, countMs);
}
//调用方言获取 count sql
String countSql = runtimeDialect.getCountSql(ms, boundSql, parameterObject, rowBounds, countKey);
BoundSql countBoundSql = new BoundSql(ms.getConfiguration(), countSql, boundSql.getParameterMappings(), parameterObject);
//当使用动态 SQL 时,可能会产生临时的参数,这些参数需要手动设置到新的 BoundSql 中
for (String key : additionalParameters.keySet()) {
countBoundSql.setAdditionalParameter(key, additionalParameters.get(key));
}
//执行 count 查询
Object countResultList = executor.query(countMs, parameterObject, RowBounds.DEFAULT, resultHandler, countKey, countBoundSql);
Long count = (Long) ((List) countResultList).get(0);
//处理查询总数
runtimeDialect.afterCount(count, parameterObject, rowBounds);
if (count == 0L) {
//当查询总数为 0 时,直接返回空的结果
return runtimeDialect.afterPage(new ArrayList(), parameterObject, rowBounds);
}
}
//判断是否需要进行分页查询
if (runtimeDialect.beforePage(ms, parameterObject, rowBounds)) {
//生成分页的缓存 key
CacheKey pageKey = executor.createCacheKey(ms, parameterObject, rowBounds, boundSql);
//处理参数对象
parameterObject = runtimeDialect.processParameterObject(ms, parameterObject, boundSql, pageKey);
//调用方言获取分页 sql
String pageSql = runtimeDialect.getPageSql(ms, boundSql, parameterObject, rowBounds, pageKey);
BoundSql pageBoundSql = new BoundSql(ms.getConfiguration(), pageSql, boundSql.getParameterMappings(), parameterObject);
//设置动态参数
for (String key : additionalParameters.keySet()) {
pageBoundSql.setAdditionalParameter(key, additionalParameters.get(key));
}
//执行分页查询
resultList = executor.query(ms, parameterObject, RowBounds.DEFAULT, resultHandler, pageKey, pageBoundSql);
} else {
resultList = new ArrayList();
}
} else {
args[2] = RowBounds.DEFAULT;
resultList = (List) invocation.proceed();
}
//返回默认查询
return runtimeDialect.afterPage(resultList, parameterObject, rowBounds);
}
com.github.pagehelper.dialect.AbstractDialect#processParameterObject这个方法会从ThreadLocal里面取出之前放入的分页参数(通过com.github.pagehelper.BasePageHelper#startPage(int, int)放入分页参数);
com.github.pagehelper.dialect.AbstractDialect#getPageSql(org.apache.ibatis.mapping.MappedStatement, org.apache.ibatis.mapping.BoundSql, java.lang.Object, org.apache.ibatis.session.RowBounds, org.apache.ibatis.cache.CacheKey)这个方法获取分页sql。
方法执行完获得了分页的所有信息,之后Executor会继续执行query方法完成数据查询。
4、总结
1)实例化Executor时执行,执行PageHelper中的plugin方法,生成Executor的代理对象;
2)Executor执行query方法之前,执行代理对象中的invoke方法->执行PageHelper的interceptor方法获取分页sql以及分页参数。
3)Executor执行query方法从数据库中查询数据。