吃透Mybatis源码-通过分析Pagehelper源码来理解Mybatis的拦截器
Posted 墨家巨子@俏如来
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了吃透Mybatis源码-通过分析Pagehelper源码来理解Mybatis的拦截器相关的知识，希望对你有一定的参考价值。
2021一路有你，2022我们继续加油！你的肯定是我最大的动力
博主在参加博客之星评比，点击链接 ， https://bbs.csdn.net/topics/603957267 疯狂打Call！五星好评 ⭐⭐⭐⭐⭐ 感谢
前言
面试官：用过pagehelper做分页把，你说一下pagehelper的分页实现原理。额…此时你只能说我不知道。如果你事先看了我接下来的这篇文章，相信你一定也把这个面试题答得很好。
认识Mybatis插件(拦截器)
SpringMVC的拦截器相信大家都清楚，作用是在Controller执行前或执行后拦截器请求从而实现对请求做增强，比如：登录检查等。在mybais中也有拦截器(当然它应该叫插件，我觉得叫拦截器更贴切)，它拦截的是发向数据库的请求，达到增强Mybatis的目的，道理都差不多。
下面的文字是Mybatis官方文档对拦截器的描述
MyBatis 允许你在映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：
• Executor(update, query, flushStatements, commit, rollback,getTransaction, close,isClosed)
• ParameterHandler(getParameterObject, setParameters)
• ResultSetHandler(handleResultSets, handleOutputParameters)
• StatementHandler(prepare, parameterize, batch, update, query)
通过 MyBatis 提供的强大机制，使用插件是非常简单的，只需实现 Interceptor 接口，并指定想要拦截的方法签名即可
这句话告诉我们，Mybatis的拦截器会对四个类进行拦截，Executor执行器，ParameterHandler参数处理器，ResultSetHandler结果处理器，StatementHandler 语句处理器。待会儿带大家去看相关的源码。
PageHelper的使用和源码解析
PageHelper是一个分页插件，使用它我们在做分页查询的时候不需要编写查询总条数的SQL,以及查询列表的SQL不需要指定Limit 。我们只需要把分页条件交给PageHelper，它就可以帮我们自动生成查询总条数的SQL,以及在查询列表的SQL后面自动加上 Limit。PageHelper 就是一个Mybatis的拦截器。
下面我们来简单使用一下PageHelper,首先需要导入PageHelper的依赖
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>4.1.4</version>
</dependency>
第二步，在mybatis-config.xml配置插件 PageHelper
<plugins>
<plugin interceptor="com.github.pagehelper.PageHelper">
<!-- 指定方言，mysql数据库 -->
<property name="dialect" value="mysql"/>
</plugin>
</plugins>
第三步，编写查询列表的SQL
<select id="selectList" resultMap="resultMap">
select * from student
</select>
第四步，使用PageHelper查询结果
@Test
public void testInterceptor() throws IOException
//设置分页信息
Page page = PageHelper.startPage(1, 10, true);
//================================================================================
//加载配置
InputStream inputStream= Resources.getResourceAsStream("mybatis-config.xml");
//创建一个sqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
//创建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
//Page pageInfo = (Page)sqlSession.selectList("cn.whale.mapper.StudentMapper.selectList");
StudentMapper mapper = sqlSession.getMapper(StudentMapper.class);
//==================================================================================
//结果以Page来接收
Page pageInfo = (Page) mapper.selectList();
System.out.println(pageInfo.getTotal());
pageInfo.getResult().stream().forEach( System.out::println);
测试结果如下
看到这个结果是不是觉得很有意思，我并没有编写select count(0) from student 这条查询总条数的SQL，但是该SQL被执行了，同时还给查询列表的SQL增加了limit 分页条件。
接下来我们分析一下PageHelper的实现原理，首先看一下 com.github.pagehelper.PageHelper 这个类com.github.pagehelper.PageHelper
@Intercepts(@Signature(
//拦截器Executor的query方法
type = Executor.class,
method = "query",
//方法的参数，拦截拥有这四个参数的query方法
args = MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class
))
public class PageHelper implements Interceptor
//....省略....
首先 PageHelper 实现了 Interceptor接口，Mybatis的拦截器都需要实现该接口。类上通过@Intercepts指定了只需要拦截Executor执行器的 “query” 方法。
拦截器接口源码如下
public interface Interceptor
//拦截器方法，拦截器的核心方法
Object intercept(Invocation invocation) throws Throwable;
//该方法的参数 target就是拦截器的目标类，plugin方法中需要对target做增强
Object plugin(Object target);
//设置属性，Properties是mybatis-config.xml对拦截器配置中的属性
void setProperties(Properties properties);
我们看一下 PageHelper 的三个方法，先看plugin方法 :com.github.pagehelper.PageHelper#plugin
public Object plugin(Object target)
//如果是Executor就对target做增强，否则不做任何处理，直接返回target
if (target instanceof Executor)
//把target交给Plugin.wrap ，this就是PageHelper拦截器类
return Plugin.wrap(target, this);
else
return target;
如果target是Executor就对target做增强，否则不做任何处理，直接返回target，看一下 Plugin.wrap做了什么
public class Plugin implements InvocationHandler
//原生对象
private final Object target;
//拦截器
private final Interceptor interceptor;
//方法
private final Map<Class<?>, Set<Method>> signatureMap;
private Plugin(Object target, Interceptor interceptor, Map<Class<?>, Set<Method>> signatureMap)
this.target = target;
this.interceptor = interceptor;
this.signatureMap = signatureMap;
//对target做增强，因为pageHelper只是拦截Executor，所以target是 Executor比如CacheingExector， interceptor是拦截器类即：PageHelper
public static Object wrap(Object target, Interceptor interceptor)
//1.拿到拦截器类上的@Intercepts 指定的方法签名@Signature，即：要拦截器什么方法比如：query方法
Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
//拿到目标类的class,比如：org.apache.ibatis.executor.CachingExecutor
Class<?> type = target.getClass();
Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
if (interfaces.length > 0)
//2.使用JDK动态代理为target生成代理类
return Proxy.newProxyInstance(
type.getClassLoader(),
interfaces,
//3.Plugin是一个 InvocationHandler
new Plugin(target, interceptor, signatureMap));
return target;
//对象执行会被invoke方法拦截到 ，比如在执行CachingExecutor#query方法的时候会被invoke方法拦截
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable
try
//4.拿到执行到Method
Set<Method> methods = signatureMap.get(method.getDeclaringClass());
//5.判断当前方法是否包含在要拦截的方法中
if (methods != null && methods.contains(method))
//6.如果方法需要被拦截，调用拦截器的intercept方法，也就是PageHelper的intercept方法
//把拦截的原生对象，方法对象，参数对象封装成Invocation
return interceptor.intercept(new Invocation(target, method, args));
//7.如果方法没有被拦截，就直接调用
return method.invoke(target, args);
catch (Exception e)
throw ExceptionUtil.unwrapThrowable(e);
有学习过JDK动态代理的同学是能够看得懂上面的代码，使用Proxy为被拦截的对象生成代理类，并解析拦截器上的@Intercepts的@Signature属性来得到要拦截的方法。
当对象方法被执行就会被Plugin#invoke拦截到，Plugin是一个InvocationHandler，其中的invoke会拦截器对象方法的调用。在invoke方法中判断了方法是否需要拦截，如果需要调用interceptor.intercept对原生对象做增强。如果方法不需要拦截就直接调用方法，不走拦截器。
接下来代码走到 com.github.pagehelper.PageHelper#intercept
//Invocation 是对方法调用的封装，其中包括：target类 ；method ;arg参数
public Object intercept(Invocation invocation) throws Throwable
//自动获取方言
if (autoRuntimeDialect)
SqlUtil sqlUtil = getSqlUtil(invocation);
return sqlUtil.processPage(invocation);
else
//自动获取dialect,如果没有setProperties或setSqlUtilConfig，也可以正常进行
if (autoDialect)
initSqlUtil(invocation);
//1.重点看这里，使用SqlUtil处理分页
return sqlUtil.processPage(invocation);
//处理分页
public Object processPage(Invocation invocation) throws Throwable
try
//2.处理分页
Object result = _processPage(invocation);
return result;
finally
//处理分页数据，分页数据是保存在SqlUtil中的 ThreadLocal<Page>中
clearLocalPage();
private Object _processPage(Invocation invocation) throws Throwable
//方法参数
final Object[] args = invocation.getArgs();
Page page = null;
//支持方法参数时，会先尝试获取Page
if (supportMethodsArguments)
page = getPage(args);
//分页信息，里面包括了pageNum和pageSize.默认是0到Integer的最大值
RowBounds rowBounds = (RowBounds) args[2];
//支持方法参数时，如果page == null就说明没有分页条件，不需要分页查询
//是否支持接口参数来传递分页参数，默认false。就是不支持我们自己传入分页参数
if ((supportMethodsArguments && page == null)
//当不支持分页参数时，判断LocalPage和RowBounds判断是否需要分页
|| (!supportMethodsArguments && SqlUtil.getLocalPage() == null && rowBounds == RowBounds.DEFAULT))
return invocation.proceed();
else
//不支持分页参数时，page==null，这里需要获取
if (!supportMethodsArguments && page == null)
//【重点】我们自己没有传入分页对象，所以代码会走这里
page = getPage(args);
//【重点】 处理分页查询，该方法中会先查询count,再查询list
return doProcessPage(invocation, page, args);
在 PageHelper#intercept 拦截方法中调用了 SqlUtil.processPage 来处理分页，该方法中会判断是否支持接口传入分页对象来分页，默认是supportMethodsArguments=false。代码会来到 com.github.pagehelper.SqlUtil#getPage 获取分页对象Page
public Page getPage(Object[] args)
//【重要】 这里是拿到分页信息，使用的一个ThreadLocal<Page>来存储的
Page page = getLocalPage();
...省略...
//分页合理化
if (page.getReasonable() == null)
page.setReasonable(reasonable);
//当设置为true的时候，如果pagesize设置为0（或RowBounds的limit=0），就不执行分页，返回全部结果
if (page.getPageSizeZero() == null)
page.setPageSizeZero(pageSizeZero);
return page;
在SqlUtil#getPage中，如果我们自己没有在方法中传入分页对象，那么会从 com.github.pagehelper.SqlUtil#LOCAL_PAGE 获取分页对象，它是一个ThreadLocal<Page> , 那这个分页对象是在什么时候保存进去的呢？就是在我们最开始测试代码中执行Page page = PageHelper.startPage(1, 10, true); 的时候，就会把pageNum和pageSize封装成 Page对象存储到SqlUtil中的一个ThreadLocal<Page>中。
拿到Page分页对象后，代码来到com.github.pagehelper.SqlUtil#doProcessPage ，处理分页查询，该方法中会先查询count,再查询list
private Page doProcessPage(Invocation invocation, Page page, Object[] args) throws Throwable
//保存RowBounds状态
RowBounds rowBounds = (RowBounds) args[2];
//获取原始的ms
MappedStatement ms = (MappedStatement) args[0];
//判断并处理为PageSqlSource
if (!isPageSqlSource(ms))
//[重要]1.处理MappedStatment，因为要生成一个count语句所以该方法中会
//新建count查询和分页查询的MappedStatement ，id会加上_COUNT,比如：
//cn.whale.StudentMapper.selectList会变成cn.whale.StudentMapper.selectList_COUNT
processMappedStatement(ms);
//设置当前的parser，后面每次使用前都会set，ThreadLocal的值不会产生不良影响
//【重要】 给 PageSqlSource设置parse。PageSqlSource表示从 XML 文件或注释读取的映射语句的内容
//PageSqlSource中有一个 ThreadLocal<Parser> ，Parser是pagehelper提供的SQL解析器比如：MysqlParser
((PageSqlSource)ms.getSqlSource()).setParser(parser);
try
//忽略RowBounds-否则会进行Mybatis自带的内存分页
args[2] = RowBounds.DEFAULT;
//如果只进行排序 或 pageSizeZero的判断
if (isQueryOnly(page))
return doQueryOnly(page, invocation);
//简单的通过total的值来判断是否进行count查询
if (page.isCount())
page.setCountSignal(Boolean.TRUE);
//替换MS
args[0] = msCountMap.get(ms.getId());
//【重要】查询总数
Object result = invocation.proceed();
//还原ms
args[0] = ms;
//【重要】设置总数
page.setTotal((Integer) ((List) result).get(0));
if (page.getTotal() == 0)
return page;
else
page.setTotal(-1l);
//pageSize>0的时候执行分页查询，pageSize<=0的时候不执行相当于可能只返回了一个count
if (page.getPageSize() > 0 &&
((rowBounds == RowBounds.DEFAULT && page.getPageNum() > 0)
|| rowBounds != RowBounds.DEFAULT))
//将参数中的MappedStatement替换为新的qs
page.setCountSignal(null);
//拿到原本的SQL
BoundSql boundSql = ms.getBoundSql(args[1]);
//设置分页，信息，啊page总的开始也和每页条数设置到args[1]
args[1] = parser.setPageParameter(ms, args[1], boundSql, page);
page.setCountSignal(Boolean.FALSE);
//【重要】执行分页查询
Object result = invocation.proceed();
//【重要】得到处理结果
page.addAll((List) result);
finally
((PageSqlSource)ms.getSqlSource()).removeParser();
//返回结果
return page;
方法稍微比较复杂，总共做了这些事情
-
processMappedStatement(ms); 新建count查询和分页查询的MappedStatement
-
((PageSqlSource)ms.getSqlSource()).setParser(parser); 给 PageSqlSource设置parse。PageSqlSource表示从 XML 文件或注释读取的映射语句的内容，PageSqlSource中有一个
ThreadLocal<Parser>，Parser是Pagehelper提供的SQL解析器比如：MysqlParserpublic class MysqlParser extends AbstractParser @Override public String getPageSql(String sql) StringBuilder sqlBuilder = new StringBuilder(sql.length() + 14); sqlBuilder.append(sql); //处理SQL的分页条件【重要重要重要】 sqlBuilder.append(" limit ?,?"); return sqlBuilder.toString();在MysqlParser中处理了分页SQL，那么对于查询Count Sql是在哪儿生成的呢？是在com.github.pagehelper.parser.
SqlParser#getSimpleCountSql中public String getSimpleCountSql(final String sql) isSupportedSql(sql); StringBuilder stringBuilder = new StringBuilder(sql.length() + 40); stringBuilder.append("select count(0) from ("); stringBuilder.append(sql); stringBuilder.append(") tmp_count"); return stringBuilder.toString();SqlParser存储在MysqlParser的父类AbstractParser中，他们的继承体系如下。
-
Object result = invocation.proceed(); 查询总条数，然后把总条数设置给结果对象 page。该方法会触发
以上是关于吃透Mybatis源码-通过分析Pagehelper源码来理解Mybatis的拦截器的主要内容，如果未能解决你的问题，请参考以下文章CachingExecutor#query的调用，方法中会调用 PageSqlSource#getBoundSql 去生成查询count的SQL，而底层最终会调用SqlParser#getSimpleCountSql解析查询count的SQL，然后执行count查询。