Mybatis 插件开发

插件注意事项

一个好的插件有几点需要注意：
1、易用，不需要别的配置。
2、不限制用户使用方式。
3、做出友好提示。

插件机制

Mybatis在创建执行器、参数处理器、Statement处理器、结果处理器四个环节提供了接口扩展，我们可以轻松的对以上处理器进行修改，来满足我们的业务要求。

我们接下来看下这个创建执行器、处理器时候的代码。下面我们对这4个环节进行分析。
在创建SqlSession的时候会创建执行器。创建完执行器就会插件拦截器。我们来看下这块代码。
Executor插件：在创建Executor时候会获取Mybatis配置的所有插件，出入参数为Executor，并执行plugin方法。
StatementHandler插件:在创建StatementHandler时候也获取Mybatis配置的所有插件，出入参数为StatementHandler，并执行plugin方法。
ParameterHandler插件：在创建ParameterHandler时候也获取Mybatis配置的所有插件，出入参数为ParameterHandler，并执行plugin方法。
ResultSetHandler插件：在创建ResultSetHandler时候也获取Mybatis配置的所有插件，出入参数为ResultSetHandler，并执行plugin方法。

分页插件

分页是一个很常见的功能，基于Mybatis分页插件已经有很多，如pagehelper、mybatis plus等都实现了分页功能。我们在这里不重复造轮子，只是讲清楚Mybatis给我们提供了哪些扩展。

插件拦截类型

Executor执行SQL脚本最终是交由StatementHandler来进行数据库查询。
StatementHandler包含了ParameterHandler，ResultSetHandler，所以StatementHandler拦截做分页最合适。
分页思路：通过StatementHandler获取ParameterHandler，拿到我们需要执行的sql，对sql进行加工获取总数量。对sql进行加工获取分页数量。

代码实现

Page对象，属性简单不做过多解释。

// An highlighted block
public class Page {
    private int size;
    private int pageNo;
    private int offset;
    private int total;

    public int getSize() {
        return size;
    }

    public void setSize(int size) {
        this.size = size;
    }

    public int getPageNo() {
        return pageNo;
    }

    public void setPageNo(int pageNo) {
        this.pageNo = pageNo;
    }

    public int getTotal() {
        return total;
    }

    public void setTotal(int total) {
        this.total = total;
    }

    public int getOffset(){
        return (pageNo - 1) * size ;
    }
}

插件代码

// @Intercepts是Mybatis定义个注解。用于Aop拦截，Mybatis自己实现了Aop
// @Signature配置拦截对象信息，type = StatementHandler.class,拦截所有的StatementHandler类
//method = "prepare"拦截prepare方法，args = {Connection.class,Integer.class}))参数的类型
@Intercepts(@Signature(type = StatementHandler.class,method = "prepare", args = {Connection.class,Integer.class}))
public class PageInterceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Page page = null;
        //拿到目标对象转换成StatementHandler
        StatementHandler statementHandler = (StatementHandler)invocation.getTarget();
        //获取到BoundSql，BoundSql里面有Sql信息，参数信息
        BoundSql boundSql = statementHandler.getBoundSql();
        //获取请求参数类型，如果是单个参数object就是简单对象，否则为一个Map
        Object object = boundSql.getParameterObject();
        //解析Map中是否含有分页参数page
        if(object instanceof Map){
            page = (Page)((Map)object).values().stream().filter(x->x instanceof Page).findFirst().orElse(null);
        //判断单个参数是否为分页参数
        } else if(object instanceof Object){
            if(object instanceof Page){
                page = (Page)object;
            }
        }
        //含所有分页参数信息需要进行分页处理
        if(page != null){
            //获取连接
            Connection connection = (Connection)invocation.getArgs()[0];
            //获取需要执行的Sql语句，拼接上查询总数的是语句
            String slq =String.format("select count(1) as total from (%s) as totalTable ",boundSql.getSql());
            //预编译SQL
            PreparedStatement ps = connection.prepareStatement(slq);
            //statementHandler进行参数的设置
            statementHandler.parameterize(ps);
            //获取结果集
            ResultSet rs = ps.executeQuery();
            while (rs.next()){
                //获取到总数量并设置到Page中去
                int count = rs.getInt("total");
                page.setTotal(count);
            }
            //关闭游标
            rs.close();
            //关闭statement
            ps.close();
            //获取查询sql，拼接limit参数做分页查询
            String sql2 =  String.format("%s limit %s ,%s",boundSql.getSql(),page.getOffset(),page.getSize());
            SystemMetaObject.forObject(boundSql).setValue("sql",sql2);

        }
        //执行拼接好的sql，查询数据分页信息。
        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        //把当前拦截器交由Plugin进行代理，Plugin类自己去看下，其中invoke会对拦截的参数、方法进行判断。
        return Plugin.wrap(target,this);
    }

    @Override
    public void setProperties(Properties properties) {

    }
}

一个简单的分页查询插件就写完了，下面我们还要在mybatis-config.xml配置我们开发的插件。Mapper.java文件中指定缓存的Namespace，Mapper.xml 违建指定缓存。
mybatis-config.xml配置信息

   <plugins>
        //配置分页插件
        <plugin interceptor="com.wwl.mybatis.dao.PageInterceptor"></plugin>
    </plugins>

UserMapper.java文件的信息

// 开启二级缓存
@CacheNamespace(blocking = true)
public interface UserMapper {

    @Select("select * from user where id=#{id}")
    User selectByid(Long id);

    User selectByIdAndUser(@Param("id") Long id,@Param("user") User user);


    @Options(flushCache = Options.FlushCachePolicy.TRUE)
    User selectByid2(Integer id);

    int updateByid2(User user);

    @Insert("insert into user (name ,createTime,updateTime) values (#{name},#{createTime},#{updateTime})")
    int insertUser(User user);

    @Insert("insert into user (name ,createTime,updateTime) values (#{name},#{createTime},#{updateTime})")
    int insertUser2(User user);

    List<User> selectIds(@Param("ids") List<Integer> ids);

    List<User> selectBypage(Page page,@Param("user") User user);

}

// An highlighted block
 <?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.wwl.mybatis.dao.UserMapper">
    //引用com.wwl.mybatis.dao.UserMapper的二级缓存，这里一定要注意，Mybatis中Mapper.java 和Mapper.xml用的不是同一
    //个缓存，需要手动指定才会使用同一个缓存。如果Mapper.xml,直接<cache/>开启的会异常。
    <cache-ref namespace="com.wwl.mybatis.dao.UserMapper"/>
    <resultMap id="test" type="com.wwl.mybatis.dao.User">

    </resultMap>

    <parameterMap id="test1" type="com.wwl.mybatis.dao.User">
        <parameter property="id" javaType="int"></parameter>
    </parameterMap>

    <select id="selectByid2" resultType="com.wwl.mybatis.dao.User">
       select * from user where id=#{id}
   </select>
    <update id="updateByid2" parameterType="com.wwl.mybatis.dao.User">
        update user set name=#{name} where id=#{id}
    </update>
    <select id="selectIds"
            resultType="com.wwl.mybatis.dao.User"
            lang="org.mybatis.scripting.freemarker.FreeMarkerLanguageDriver">

        select  * from user
       where  id in(${ids?join(',')})

    </select>

    <select id="selectByIdAndUser" resultType="com.wwl.mybatis.dao.User">
       select * from user where id=#{id} and name = #{user.name}
   </select>

    <select id="selectBypage" resultType="com.wwl.mybatis.dao.User">
       select * from user where id > #{user.id}
   </select>

</mapper>

现在开始我们的测试类：

// 我们看看执行类代码，其实很简单
public class PlusTest {

    @Test
    public void test_plus(){
        SqlSessionFactoryBuilder factoryBuilder = new SqlSessionFactoryBuilder();
        SqlSessionFactory factory = factoryBuilder.build(ExecutorTest.class.getResourceAsStream("/mybatis-config.xml"));
        SqlSession sqlSession = factory.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        Page page = new Page();
        page.setPageNo(1);
        page.setSize(2);
        User user = new User();
        user.setId(1L);
        List<User> list = userMapper.selectBypage(page,user);
        System.out.println("第一次查询list.size():" + list.size());
        System.out.println("第一次查询总页数:"+page.getTotal());
    }

}

执行结果：

// 我们可以很清楚的看到执行结果中帮我们分页了，返回了list，并且在page中设置了总的条数。
18:21:52,946 DEBUG com.wwl.mybatis.dao.UserMapper:54 - Cache Hit Ratio [com.wwl.mybatis.dao.UserMapper]: 0.0
18:21:52,959 DEBUG org.apache.ibatis.transaction.jdbc.JdbcTransaction:54 - Opening JDBC Connection
18:21:53,997 DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource:54 - Created connection 915349526.
18:21:53,998 DEBUG org.apache.ibatis.transaction.jdbc.JdbcTransaction:54 - Setting autocommit to false on JDBC Connection [com.mysql.jdbc.JDBC4Connection@368f2016]
18:21:54,051 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - ==>  Preparing: select count(1) as total from (select * from user where id > ?) as totalTable 
18:21:54,111 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - ==> Parameters: 1(Long)
18:21:54,174 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - <==      Total: 1
18:21:54,178 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - ==>  Preparing: select * from user where id > ? limit 0 ,2 
18:21:54,181 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - ==> Parameters: 1(Long)
18:21:54,237 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - <==      Total: 2
第一次查询list.size():2
第一次查询总页数:10

其实到这里分页插件已经开发的差不多了。但是有个问题，Mybatis有缓存，二级缓存的时候如果命中缓存没有走jdbc查询会是什么用的结果呢？我们在看一段代码。

// 这段测试代码和上面差不多
public class PlusTest {

    @Test
    public void test_plus(){
        SqlSessionFactoryBuilder factoryBuilder = new SqlSessionFactoryBuilder();
        SqlSessionFactory factory = factoryBuilder.build(ExecutorTest.class.getResourceAsStream("/mybatis-config.xml"));
        SqlSession sqlSession = factory.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        Page page = new Page();
        page.setPageNo(1);
        page.setSize(2);
        User user = new User();
        user.setId(1L);
        List<User> list = userMapper.selectBypage(page,user);
        System.out.println("第一次查询list.size():" + list.size());
        System.out.println("第一次查询总页数:"+page.getTotal());
        //Mybatis二级缓存需要命中需要提交事物，前面对二级缓存的讲解已经写过。
        sqlSession.commit();


        SqlSession sqlSession2 = factory.openSession();
        UserMapper userMapper2 = sqlSession2.getMapper(UserMapper.class);
        Page page2 = new Page();
        page2.setPageNo(1);
        page2.setSize(2);
        List<User> list2 = userMapper2.selectBypage(page2,user);
        System.out.println("第二次查询list.size():"+list2.size());
        System.out.println("第二次查询总页数:"+page2.getTotal());
    }

}

我们来看看执行结果

// 我们可以看到执行结果中只有第一次中了数据库查询，第二次直接走缓存拿取，接下来分析关键代码
18:27:27,627 DEBUG org.apache.ibatis.logging.LogFactory:54 - Logging initialized using 'class org.apache.ibatis.logging.commons.JakartaCommonsLoggingImpl' adapter.
18:27:28,059 DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource:54 - PooledDataSource forcefully closed/removed all connections.
18:27:28,059 DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource:54 - PooledDataSource forcefully closed/removed all connections.
18:27:28,061 DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource:54 - PooledDataSource forcefully closed/removed all connections.
18:27:28,061 DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource:54 - PooledDataSource forcefully closed/removed all connections.
18:27:28,895 DEBUG com.wwl.mybatis.dao.UserMapper:54 - Cache Hit Ratio [com.wwl.mybatis.dao.UserMapper]: 0.0
18:27:28,922 DEBUG org.apache.ibatis.transaction.jdbc.JdbcTransaction:54 - Opening JDBC Connection
18:27:30,062 DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource:54 - Created connection 397071633.
18:27:30,063 DEBUG org.apache.ibatis.transaction.jdbc.JdbcTransaction:54 - Setting autocommit to false on JDBC Connection [com.mysql.jdbc.JDBC4Connection@17aad511]
18:27:30,238 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - ==>  Preparing: select count(1) as total from (select * from user where id > ?) as totalTable 
18:27:30,290 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - ==> Parameters: 1(Long)
18:27:30,355 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - <==      Total: 1
18:27:30,359 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - ==>  Preparing: select * from user where id > ? limit 0 ,2 
18:27:30,360 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - ==> Parameters: 1(Long)
18:27:30,425 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - <==      Total: 2
第一次查询list.size():2
第一次查询总页数:10
//做了2次查询，一次走数据库，一次走缓存，所以缓存命中率为0.5，这段代码逻辑在二级缓存装饰器LoggingCache中实现，在二级缓存中
//有对LoggingCache做详细介绍
18:27:30,441 DEBUG com.wwl.mybatis.dao.UserMapper:54 - Cache Hit Ratio [com.wwl.mybatis.dao.UserMapper]: 0.5
//我们拿到了查询的结果集
第二次查询list.size():2
//但是这里我看下总输为0，为什么为0呢？因为直接走了缓存，StatementHandler去执行查询总页数，所以这个地方有问题。如何修复呢？
第二次查询总页数:0

二级缓存失效修复

我们上面看到二级缓存失效原因是命中缓存就直接返回了。所以我们需要对Mybatis的执行器进行拦截。对执行器的插件。

	<plugins>
        <plugin interceptor="com.wwl.mybatis.dao.PageInterceptor"></plugin>
        //加上执行器的插件
        <plugin interceptor="com.wwl.mybatis.dao.CachingExecutorInterceptor"></plugin>
    </plugins>

执行器拦截代码

//拦截Executor的query方法，方法对应参数为MappedStatement，Object，RowBounds，ResultHandler
//这里需要注意的是千万别去拦截query含有6个参数的重载方法，在调用query6个参数的重载方法时是本地调用
//并没有经过Mybatis的代理，根本拦截不了，博主就犯了这个错，查了一会。
@Intercepts(@Signature(type = Executor.class,method = "query",args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}))
public class CachingExecutorInterceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Page page = null;
        //获取BoundSql里面的查询参数信息
        BoundSql boundSql = ((MappedStatement)invocation.getArgs()[0]).getBoundSql(invocation.getArgs()[1]);
        Object obj = boundSql.getParameterObject();
        //判断参数中是否含有Page对应的信息
        if(obj instanceof Page){
            page = (Page)obj;
        }else if(obj instanceof Map){
            page = (Page)((Map)obj).values().stream().filter(x-> x instanceof Page).findFirst().orElse(null);
        }
        if(page == null){
            return invocation.proceed();
        }
        //设置为-1，防止数据库查询出来0条，分不清楚是走二级缓存还是数据库查询
        page.setTotal(-1);
        //执行查询方法，如果是总二级缓存则page找那个的total为-1
        Object object = invocation.proceed();
        //如果还是-1则走的缓存查询，数据库查询只会为0
        if(page.getTotal() != -1){
            return object;
        }
        //接下来就是根据执行器去创建Connection、PreparedStatement，并设执行sql，获取结果集。
        if(invocation.getTarget() instanceof CachingExecutor) {
            CachingExecutor cachingExecutor = (CachingExecutor) invocation.getTarget();
            //获取数据库连接
            Connection connection = cachingExecutor.getTransaction().getConnection();
            //拼接查询总数的sql
            String sql = String.format("select count(1) total from (%s) as totalTable ", boundSql.getSql());
            //预处理sql
            PreparedStatement ps = connection.prepareStatement(sql);
            //获取CachingExecutor的装饰类执行器
            BaseExecutor baseExecutor = (BaseExecutor)SystemMetaObject.forObject(cachingExecutor).getValue("delegate");
            //获取Configuration
            Configuration configuration = (Configuration) SystemMetaObject.forObject(baseExecutor).getValue("configuration");
            //创建StatementHandler
            StatementHandler handler = configuration.newStatementHandler(baseExecutor, (MappedStatement) invocation.getArgs()[0], invocation.getArgs()[1], (RowBounds) invocation.getArgs()[2], (ResultHandler) invocation.getArgs()[3], boundSql);
            //进行参数的设值
            handler.parameterize(ps);
            //执行结果集
            ResultSet rs = ps.executeQuery();
            while (rs.next()) {
                int count = rs.getInt("total");
                page.setTotal(count);
            }
            rs.close();
            ps.close();
            connection.close();
        }
        return object;
    }

我们来看看执行结果

// 我们看系统日志可以很清晰的看到执行了缓存查询，并且返回的总页数缓存的命中率为0.5
18:51:27,109 DEBUG org.apache.ibatis.transaction.jdbc.JdbcTransaction:54 - Opening JDBC Connection
18:51:28,140 DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource:54 - Created connection 1376151044.
18:51:28,141 DEBUG org.apache.ibatis.transaction.jdbc.JdbcTransaction:54 - Setting autocommit to false on JDBC Connection [com.mysql.jdbc.JDBC4Connection@52066604]
18:51:28,196 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - ==>  Preparing: select count(1) as total from (select * from user where id > ?) as totalTable 
18:51:28,239 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - ==> Parameters: 1(Long)
18:51:28,309 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - <==      Total: 1
18:51:28,311 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - ==>  Preparing: select * from user where id > ? limit 0 ,2 
18:51:28,313 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - ==> Parameters: 1(Long)
18:51:28,371 DEBUG com.wwl.mybatis.dao.UserMapper.selectBypage:54 - <==      Total: 2
第一次查询list.size():2
第一次查询总页数:10
18:51:28,387 DEBUG com.wwl.mybatis.dao.UserMapper:54 - Cache Hit Ratio [com.wwl.mybatis.dao.UserMapper]: 0.5
18:51:28,389 DEBUG org.apache.ibatis.transaction.jdbc.JdbcTransaction:54 - Opening JDBC Connection
18:51:28,792 DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource:54 - Created connection 649769713.
18:51:28,793 DEBUG org.apache.ibatis.transaction.jdbc.JdbcTransaction:54 - Setting autocommit to false on JDBC Connection [com.mysql.jdbc.JDBC4Connection@26bab2f1]
18:51:28,940 DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource:54 - Returned connection 649769713 to pool.
第二次查询list.size():2
第二次查询总页数:10

总结

这里开发的插件还有很多细节问题，这里只是给大家演示如何开发Mybatis的插件。
如果需要对结果集进行处理、参数进行处理都可以写自己的插件，进行拦截。