4、mybatis（oracle分页）分页拦截器

接上一节，增加一个分页拦截器来实现dao层的分页逻辑
拦截器就是在不改变源码的情况下，改变mybatis源码的一些行为。在sql语句执行之前，把普通sql语句换成分页语句即可。

分析：怎样拦截
（1）确定拦截对象:
a: 确定什么样的拦截对象---后缀为Page的方法
b: 拦截对象什么行为---需要分页操作
c: 什么时候拦截---在mybatis执行sql语句之前拦截，准确点是获取statement之前，在mybatis的源码中
（2）拦截下来做什么事：代替某个方法完成分页功能，改进原始的查询语句
（3）拦截结束，交回主权

做这个拦截器之前，复习了一下动态代理。我们的目的是在分页sql执行之前加上我们自己的分页逻辑，而且多次用到分页，所以用动态代理非常合适。此处我们的PageInterceptor 就是自定义的执行逻辑，其他工作交给jdk的Proxy，让它生成代理类，让代理类执行分页。

例子中mybatis版本3.4.0

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.util.Map;
import java.util.Properties;

import org.apache.ibatis.executor.parameter.ParameterHandler;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Plugin;
import org.apache.ibatis.plugin.Signature;
import org.apache.ibatis.reflection.DefaultReflectorFactory;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.SystemMetaObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;


/**
*@Component: 注入到spring boot容器中
 * @Intercepts分页拦截器，type：要拦截的类的class对象，method：要拦截的方法，args：方法的参数
 */
@Component
@Intercepts({@Signature(type=StatementHandler.class,method="prepare",args={Connection.class, Integer.class})})
public class PageInterceptor implements Interceptor {
    
    private String test;
    
    private final static Logger logger = LoggerFactory.getLogger(PageInterceptor.class);
    
    // 拦截实现
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        StatementHandler statementHandler = (StatementHandler)invocation.getTarget();
        // 对statementHandler进行封装
        MetaObject metaObject = MetaObject.forObject(statementHandler, SystemMetaObject.DEFAULT_OBJECT_FACTORY, 
                SystemMetaObject.DEFAULT_OBJECT_WRAPPER_FACTORY, new DefaultReflectorFactory());
        MappedStatement mappedStatement = (MappedStatement)metaObject.getValue("delegate.mappedStatement");
        // 配置文件中SQL语句的ID
        String id = mappedStatement.getId();
        if(id.matches(".+Page$")) {
            BoundSql boundSql = statementHandler.getBoundSql();
            // 原始的SQL语句
            String sql = boundSql.getSql();
            logger.info("原始sql：" + sql);
            // 查询总条数的SQL语句
            String countSql = "select count(*) from (" + sql + ")a";
            logger.info("查询总条数sql：" + countSql);
            Connection connection = (Connection)invocation.getArgs()[0];
            PreparedStatement countStatement = connection.prepareStatement(countSql);
            ParameterHandler parameterHandler = (ParameterHandler)metaObject.getValue("delegate.parameterHandler");
            parameterHandler.setParameters(countStatement);
            ResultSet rs = countStatement.executeQuery();
            
            Map parameter = (Map)boundSql.getParameterObject();
            Page page = (Page)parameter.get("page");
            if(rs.next()) {
                page.setTotalNumber(rs.getInt(1));
            }
            // 改造后带分页查询的SQL语句
//          String pageSql = sql + " limit " + page.getDbIndex() + "," + page.getDbNumber();
            String pageSql = "select * from (select t1.*, rownum rn from (" + sql + 
                    ") t1 ) t2 where rn > " + page.getDbIndex() +" and rn <= " + page.getDbEnd();
            logger.info("分页sql：" + pageSql);
            metaObject.setValue("delegate.boundSql.sql", pageSql);
        }
        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        logger.info(this.test);
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
    }
}

mybatis源码说明：target被代理对象，Plugin.wrap(target, this)返回的是动态生成的代理对象

Paste_Image.png

getSignatureMap(interceptor)：通过注解获取要拦截的类，方法等。

Paste_Image.png

先通过setProperties拿到配置文件里的属性值，再通过plugin方法对拦截的对象进行过滤，最后通过intercept方法执行拦截的逻辑。

Paste_Image.png

Paste_Image.png

Paste_Image.png

Paste_Image.png