掌握MyBatis插件原理轻松写出自己的PageHelper分页插件

前言

提到插件，相信大家都知道，插件的存在主要是用来改变或者增强原有的功能，MyBatis中也一样。

然而如果我们对MyBatis的工作原理不是很清楚的话，最好不要轻易使用插件，否则的话如果因为使用插件导致了底层工作逻辑被改变，很可能会出现很多意料之外的问题。。 整理了100+个Java项目视频+源码+笔记

本文主要会介绍MyBatis插件的使用及其实现原理，相信读完本文，我们也可以写出自己的PageHelper分页插件了。

MyBatis中插件是如何实现的

在MyBatis中插件式通过拦截器来实现的，那么既然是通过拦截器来实现的，就会有一个问题，哪些对象才允许被拦截呢？

真正执行Sql的是四大对象：Executor，StatementHandler，ParameterHandler，ResultSetHandler。

MyBatis插件的使用

首先我们先来通过一个例子来看看如何使用插件。

1、 首先建立一个MyPlugin实现接口Interceptor，然后重写其中的三个方法(注意，这里必须要实现Interceptor接口，否则无法被拦截)。

package com.lonelyWolf.mybatis.plugin;

import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import java.util.Properties;

@Intercepts({@Signature(type = Executor.class,method = "query",args = {MappedStatement.class,Object.class, RowBounds.class, ResultHandler.class})})
public class MyPlugin implements Interceptor {

    /**
     * 这个方法会直接覆盖原有方法
     * @param invocation
     * @return
     * @throws Throwable
     */
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        System.out.println("成功拦截了Executor的query方法，在这里我可以做点什么");
        return invocation.proceed();//调用原方法
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target,this);//把被拦截对象生成一个代理对象
    }

    @Override
    public void setProperties(Properties properties) {//可以自定义一些属性
        System.out.println("自定义属性:userName->" + properties.getProperty("userName"));
    }
}

@Intercepts是声明当前类是一个拦截器，后面的@Signature是标识需要拦截的方法签名，通过以下三个参数来确定

(1)type：被拦截的类名

(2)method：被拦截的方法名

(3)args：标注方法的参数类型

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

<plugins>
    <plugin interceptor="com.lonelyWolf.mybatis.plugin.MyPlugin">
        <property name="userName" value="张三"/>
    </plugin>
</plugins>

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

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

MyBatis插件实现原理

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

插件的加载

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

插件如何进行拦截

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

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

拦截Executor对象

可以看到这个方法的逻辑也很简单，但是需要注意的是MyBatis插件是通过JDK动态代理来实现的。

而JDK动态代理的条件就是被代理对象必须要有接口，这一点和Spring中不太一样，Spring中是如果有接口就采用JDK动态代理，没有接口就是用CGLIB动态代理。

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

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

其他对象插件解析

插件执行流程

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

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

答案是肯定的，因为被代理对象是被加入到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<LwUser> userList = userMapper.listAllUser();
        PageInfo<LwUser> pageList = new PageInfo<>(userList);
        System.out.println(null == pageList ? "": JSONObject.toJSONString(pageList));

    }
}

PageHelper插件原理

这是一个本地线程池变量，那么这里面的Page又是什么时候存进去的呢？这就要回到我们的示例上了，分页的开始必须要调用：

PageHelper.startPage(0,10);

这里就会构建一个Page对象，并设置到ThreadLocal内。

为什么PageHelper只对startPage后的第一条select语句有效

在finally内把ThreadLocal中的分页数据给清除掉了，所以只要执行一次查询语句就会清除分页信息，故而后面的select语句自然就无效了。

不通过插件能否改变MyBatis的核心行为

上面我们介绍了通过插件来改变MyBatis的核心行为，那么不通过插件是否也可以实现呢？

答案是肯定的，官网中提到，我们可以通过覆盖配置类来实现改变MyBatis核心行为，也就是我们自己写一个类继承Configuration类，然后实现其中的方法，最后构建SqlSessionFactory对象的时候传入自定义的Configuration方法：

SqlSessionFactory build(MyConfiguration)

当然，这种方法是非常不建议使用的，因为这种方式就相当于在建房子的时候把地基抽出来重新建了，稍有不慎，房子就要塌了。

总结

本文主要会介绍MyBatis插件的使用及MyBatis其实现原理，最后我们也大致介绍了PageHelper插件的主要实现原理，相信读完本文学会MyBatis插件原理之后，我们也可以写个简单的自己的PageHelper分页插件了。等设备。 整理了100+个Java项目视频+源码+笔记