【MyBatis系列9】只要五分钟，彻底搞懂MyBatis插件原理及PageHelper原理

2、我们还需要在mybatis-config中配置好插件。

这里如果配置了property属性，那么我们可以在setProperties获取到。

完成以上两步，我们就完成了一个插件的配置了，接下来我们运行一下：

可以看到，setProperties方法在加载配置文件阶段就会被执行了。

MyBatis插件实现原理

==========================================================================

接下来让我们分析一下从插件的加载到初始化到运行整个过程的实现原理。

插件的加载

---

既然插件需要在配置文件中进行配置，那么肯定就需要进行解析，我们看看插件式如何被解析的。我们进入XMLConfigBuilder类看看

解析出来之后会将插件存入InterceptorChain对象的list属性

看到InterceptorChain我们是不是可以联想到，MyBatis的插件就是通过责任链模式实现的。

插件如何进行拦截

=====================================================================

既然插件类已经被加载到配置文件了，那么接下来就有一个问题了，插件类何时会被拦截我们需要拦截的对象呢？

其实插件的拦截是和对象有关的，不同的对象进行拦截的时间也会不一致，接下来我们就逐一分析一下。

拦截Executor对象

---

我们知道，SqlSession对象是通过openSession()方法返回的，而Executor又是属于SqlSession内部对象，所以让我们跟随openSession方法去看一下Executor对象的初始化过程。

可以看到，当初始化完成Executor之后，会调用interceptorChain的pluginAll方法，pluginAll方法本身非常简单，就是把我们存到list中的插件进行循环，并调用Interceptor对象的plugin方法：

再次点击进去：

到这里我们是不是发现很熟悉，没错，这就是我们上面示例中重写的方法，而plugin方法是接口中的一个默认方法。

这个方法是关键，我们进去看看：

可以看到这个方法的逻辑也很简单，但是需要注意的是MyBatis插件是通过JDK动态代理来实现的，而JDK动态代理的条件就是被代理对象必须要有接口，这一点和Spring中不太一样，Spring中是如果有接口就采用JDK动态代理，没有接口就是用CGLIB动态代理。

关于动态代理，想详细了解的可以点击这里。

正因为MyBatis的插件只使用了JDK动态代理，所以我们上面才强调了一定要实现Interceptor接口。

而代理之后汇之星Plugin的invoke方法，我们最后再来看看invoke方法：

而最终执行的intercept方法，就是我们上面示例中重写的方法。

其他对象插件解析

---

接下来我们再看看StatementHandler，StatementHandler是在Executor中的doQuery方法创建的，其实这个原理就是一样的了，找到初始化StatementHandler对象的方法：

进去之后里面执行的也是pluginAll方法：

其他两个对象就不在举例了，其实搜一下全局就很明显了：

PS:

四个对象初始化的时候都会调用pluginAll来进行判定是否有被代理。

插件执行流程

===================================================================

下面就是实现了插件之后的执行时序图：

假如一个对象被代理很多次

=========================================================================

一个对象是否可以被多个代理对象进行代理？也就是说同一个对象的同一个方法是否可以被多个拦截器进行拦截？

答案是肯定的，因为被代理对象是被加入到list，所以我们配置在最前面的拦截器最先被代理，但是执行的时候却是最外层的先执行。

具体点：

假如依次定义了三个插件：插件A，插件B和插件C。

那么List中就会按顺序存储：插件A，插件B和插件C，而解析的时候是遍历list，所以解析的时候也是按照：插件A，插件B和插件C的顺序，但是执行的时候就要反过来了，执行的时候是按照：插件C，插件B和插件A的顺序进行执行。

PageHelper插件的使用

============================================================================

上面我们了解了在MyBatis中的插件是如何定义以及MyBatis中是如何处理插件的，接下来我们就以经典分页插件PageHelper为例来进一步加深理解。

首先我们看看PageHelper的用法：

package com.lonelyWolf.mybatis;

import com.alibaba.fastjson.JSONObject;

import com.github.pagehelper.Page;

import com.github.pagehelper.PageHelper;

import com.github.pagehelper.PageInfo;

import com.lonelyWolf.mybatis.mapper.UserMapper;

import com.lonelyWolf.mybatis.model.LwUser;

import org.apache.ibatis.executor.result.DefaultResultHandler;

import org.apache.ibatis.io.Resources;

import org.apache.ibatis.session.ResultHandler;

import org.apache.ibatis.session.SqlSession;

import org.apache.ibatis.session.SqlSessionFactory;

import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.IOException;

import java.io.InputStream;

import java.util.List;

public class MyBatisByPageHelp {

public static void main(String[] args) throws IOException {

String resource = “mybatis-config.xml”;

//读取mybatis-config配置文件

InputStream inputStream = Resources.getResourceAsStream(resource);

//创建SqlSessionFactory对象

SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

//创建SqlSession对象

SqlSession session = sqlSessionFactory.openSession();

PageHelper.startPage(0,10);

UserMapper userMapper = session.getMapper(UserMapper.class);

List userList = userMapper.listAllUser();

PageInfo pageList = new PageInfo<>(userList);

System.out.println(null == pageList ? “”: JSONObject.toJSONString(pageList));

}

}

输出如下结果：

可以看到对象已经被分页，那么这是如何做到的呢？

PageHelper插件原理

===========================================================================

我们上面提到，要实现插件必须要实现MyBatis提供的Interceptor接口，所以我们去找一下，发现PageHeler实现了Interceptor：

经过上面的介绍这个类应该一眼就能看懂，我们关键要看看SqlUtil的intercept方法做了什么：

这个方法的逻辑比较多，因为要考虑到不同的数据库方言的问题，所以会有很多判断，我们主要是关注PageHelper在哪里改写了sql语句，上图中的红框就是改写了sql语句的地方：

这里面会获取到一个Page对象，然后在爱写sql的时候也会将一些分页参数设置到Page对象，我们看看Page对象是从哪里获取的：

我们看到对象是从LOCAL_PAGE对象中获取的，这个又是什么呢？

这是一个本地线程池变量，那么这里面的Page又是什么时候存进去的呢？

这就要回到我们的示例上了，分页的开始必须要调用：

PageHelper.startPage(0,10);

这里就会构建一个Page对象，并设置到ThreadLocal内。
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

总结

以上是字节二面的一些问题，面完之后其实挺后悔的，没有提前把各个知识点都复习到位。现在重新好好复习手上的面试大全资料（含JAVA、MySQL、算法、Redis、JVM、架构、中间件、RabbitMQ、设计模式、Spring等），现在起闭关修炼半个月，争取早日上岸！！！

下面给大家分享下我的面试大全资料

• 第一份是我的后端JAVA面试大全

后端JAVA面试大全

• 第二份是MySQL+Redis学习笔记+算法+JVM+JAVA核心知识整理

MySQL+Redis学习笔记算法+JVM+JAVA核心知识整理

• 第三份是Spring全家桶资料

MySQL+Redis学习笔记算法+JVM+JAVA核心知识整理
《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！
i6JdQ8kT-1712074447359)]

后端JAVA面试大全

• 第二份是MySQL+Redis学习笔记+算法+JVM+JAVA核心知识整理

[外链图片转存中…(img-tQ4efSnj-1712074447360)]

MySQL+Redis学习笔记算法+JVM+JAVA核心知识整理

• 第三份是Spring全家桶资料

[外链图片转存中…(img-w0ak0CPS-1712074447360)]

MySQL+Redis学习笔记算法+JVM+JAVA核心知识整理
《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！