深入理解 Mybatis 插件开发

本篇案例将帮助读者对Mybatis插件的使用场景，实现机制，以及其中涉及的编程思想进行一个小结，希望对以后的编程开发工作有所帮助。

注：本案例以mybatis 3.4.7-SNAPSHOT版本为例。

PS：文章是挺久之前写的，当时花了一些心思，存到电脑的word里，今天正好看到，就是里面的源码都是图片，哈哈哈，凑合着看吧。更多 MyBatis干货，可以关注微信公众号 Java后端 回复 666 下载。

分页功能

mybatis的分页默认是基于内存分页的（查出所有，再截取），数据量大的情况下效率较低，不过使用mybatis插件可以改变该行为，只需要拦截StatementHandler类的prepare方法，改变要执行的SQL语句为分页语句即可；

公共字段统一赋值

一般业务系统都会有创建者，创建时间，修改者，修改时间四个字段，对于这四个字段的赋值，实际上可以在DAO层统一拦截处理，可以用mybatis插件拦截Executor类的update方法，对相关参数进行统一赋值即可；

性能监控

对于SQL语句执行的性能监控，可以通过拦截Executor类的update, query等方法，用日志记录每个方法执行的时间；

其它

其实mybatis扩展性还是很强的，基于插件机制，基本上可以控制SQL执行的各个阶段，如执行阶段，参数处理阶段，语法构建阶段，结果集处理阶段，具体可以根据项目业务来实现对应业务逻辑。

什么是Mybatis插件

与其称为Mybatis插件，不如叫Mybatis拦截器，更加符合其功能定位，实际上它就是一个拦截器，应用代理模式，在方法级别上进行拦截。

支持拦截的方法

• 执行器Executor（update、query、commit、rollback等方法）；
  
• 参数处理器ParameterHandler（getParameterObject、setParameters方法）；
  
• 结果集处理器ResultSetHandler（handleResultSets、handleOutputParameters等方法）；
  
• SQL语法构建器StatementHandler（prepare、parameterize、batch、update、query等方法）；
  

拦截阶段

• 读取mybatis的xml配置文件信息
  
• 通过SqlSessionFactoryBuilder创建SqlSessionFactory对象
  
• 通过SqlSessionFactory获取SqlSession对象
  
• 执行SqlSession对象的selectList方法，查询结果
  
• 关闭SqlSession
  

插件配置信息的加载

1. 根据解析到的类信息创建Interceptor对象；
   
2. 调用setProperties方法设置属性变量；
   
3. 添加到Configuration的interceptorChain拦截器链中；
   

代理对象的生成

 拦截逻辑的执行

1. intercept:在此实现自己的拦截逻辑，可从Invocation参数中拿到执行方法的对象，方法，方法参数，从而实现各种业务逻辑, 如下代码所示，从invocation中获取的statementHandler对象即为被代理对象，基于该对象，我们获取到了执行的原始SQL语句，以及prepare方法上的分页参数，并更改SQL语句为新的分页语句，最后调用invocation.proceed()返回结果。
   
2. plugin：生成代理对象；
   
3. setProperties：设置一些属性变量；
   

1. 设计模式：代理模式、责任链模式；
   
2. 软件思想：AOP编程思想，降低模块间的耦合度，使业务模块更加独立；
   

1. 不要定义过多的插件，代理嵌套过多，执行方法的时候，比较耗性能；
   
2. 拦截器实现类的intercept方法里最后不要忘了执行invocation.proceed()方法，否则多个拦截器情况下，执行链条会断掉；