MyBatis自定义拦截器打印完整SQL和耗时

背景

最近在迭代空闲期梳理项目优化点时，其中有一个是慢查。为了能方便的感知改进后的效果，希望能在日志中输出完整的SQL以及耗时，可以快速查询。因为数据源配置的是Druid，所以优先调研了后，经过一番实践发现并不能达到理想的效果，因此想到了MyBatis的自定义拦截器。

实践

因为使用的是读写分离，会涉及多数据源的配置。第一期配置好拦截器后，使用@Component和@Bean都尝试过，发现控制台并没有进入拦截器，debug源码后发现它确实注入到Spring中了，那肯定就是数据源的问题。根据百度提示自定义SqlSessionFactory，经过一番挣扎后，终于实现了满足需要的拦截器。

import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.*;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.type.TypeHandlerRegistry;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.CollectionUtils;

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Properties;
import java.util.regex.Matcher;

/**
 * @Description mybatis自定义拦截器-格式SQL打印
 **/
@Intercepts({@Signature(type = Executor.class, method = "query",
        args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})})
public class MyBatisPrintInterceptor implements Interceptor {

    private static final Logger logger = LoggerFactory.getLogger(MyBatisPrintInterceptor.class);

    /**
     * intercept 方法用来对拦截的sql进行具体的操作
     *
     * @param invocation
     * @return
     * @throws Throwable
     */
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
//        logger.info("执行intercept方法：{}", invocation.toString());
        Object returnValue;
        Long startTime = System.currentTimeMillis();
        returnValue = invocation.proceed();
        Long endTime = System.currentTimeMillis();
        Long executeTime = endTime - startTime;

        try {
            final Object[] args = invocation.getArgs();

            MappedStatement ms = (MappedStatement) args[0];
            Object parameter = null;
            //获取参数，if语句成立，表示sql语句有参数，参数格式是map形式
            if (invocation.getArgs().length > 1) {
                parameter = invocation.getArgs()[1];
            }
            // 获取到节点的id,即sql语句的id
            String sqlId = ms.getId();
            // BoundSql就是封装myBatis最终产生的sql类
            BoundSql boundSql = ms.getBoundSql(parameter);
            // 获取节点的配置
            Configuration configuration = ms.getConfiguration();
            // 获取到最终的sql语句
            getSql(configuration, boundSql, sqlId, executeTime);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return returnValue;
    }

    @Override
    public Object plugin(Object target) {
        if (target instanceof Executor) {
            return Plugin.wrap(target, this);
        }
        return target;
    }

    @Override
    public void setProperties(Properties properties) {
//         获取属性
//         String value1 = properties.getProperty("prop1");
//         logger.info("properties方法：{}", properties.toString());
    }

    /**
     * 封装sql语句，使得结果返回完整xml路径下的sql语句节点id + sql语句
     * @param configuration
     * @param boundSql
     * @param sqlId
     * @param time
     */
    public static void getSql(Configuration configuration, BoundSql boundSql, String sqlId, long time) {
        String sql = showSql(configuration, boundSql);
        String sqlLogger = "\n\n============================  Sql Start  ============================" +
                "\nExecute ID  ：{}" +
                "\nExecute SQL ：{}" +
                "\nExecute Time：{} ms" +
                "\n============================  Sql  End   ============================\n";
        logger.info(sqlLogger, sqlId, sql, time);
    }

    /**
     * 如果参数是String，则添加单引号;
     * 如果是日期，则转换为时间格式器并加单引号;
     @param obj
     @return
     */
    private static String getParameterValue(Object obj) {
        String value;
        if (obj instanceof String) {
            value = "'" + obj.toString() + "'";
        } else if (obj instanceof Date) {
            DateFormat formatter = DateFormat.getDateTimeInstance(DateFormat.DEFAULT, DateFormat.DEFAULT, Locale.CHINA);
            value = "'" + formatter.format(new Date()) + "'";
        } else {
            if (obj != null) {
                value = obj.toString();
            } else {
                value = "";
            }
        }
        return value;
    }

    /**
     * 对sql中的?进行参数替换
     * @param configuration
     * @param boundSql
     * @return
     */
    public static String showSql(Configuration configuration, BoundSql boundSql) {
        // 获取参数
        Object parameterObject = boundSql.getParameterObject();
        List<ParameterMapping> parameterMappings = boundSql
                .getParameterMappings();
        // sql语句中多个空格都用一个空格代替
        String sql = boundSql.getSql().replaceAll("[\\s]+", " ");
        if (!CollectionUtils.isEmpty(parameterMappings) && parameterObject != null) {
            // 获取类型处理器注册器，类型处理器的功能是进行java类型和数据库类型的转换　　　　　　
            // 如果根据parameterObject.getClass(）可以找到对应的类型，则替换
            TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
            if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
                sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(parameterObject)));

            } else {
                // MetaObject主要是封装了originalObject对象，提供了get和set的方法用于获取和设置originalObject的属性值
                // 主要支持对JavaBean、Collection、Map三种类型对象的操作
                MetaObject metaObject = configuration.newMetaObject(parameterObject);
                for (ParameterMapping parameterMapping : parameterMappings) {
                    String propertyName = parameterMapping.getProperty();
                    if (metaObject.hasGetter(propertyName)) {
                        Object obj = metaObject.getValue(propertyName);
                        sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(obj)));
                    } else if (boundSql.hasAdditionalParameter(propertyName)) {
                        // 该分支是动态sql
                        Object obj = boundSql.getAdditionalParameter(propertyName);
                        sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(obj)));

                    } else {
                        //打印出缺失，提醒该参数缺失并防止错位
                        sql = sql.replaceFirst("\\?", "missing");
                    }
                }
            }
        }
        return sql;
    }
}

这里针对查询进行了拦截，如有需要可自行添加别的方法的拦截。

接下来需要自定义SqlSessionFactory，其实说来也简单，我这里不需要别的功能，因此只需要加入拦截器即可。如果你使用了MyBatis的分页插件，这里会有冲突，自定义的拦截器会在分页插件后加载造成失效。所以在addMyBatisInterceptor()方法加上@AutoConfigureBefore({PageHelperAutoConfiguration.class}) 来保证在分页插件之前加载。

import org.apache.ibatis.session.SqlSessionFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;

import javax.annotation.PostConstruct;
import javax.annotation.Resource;
import java.util.List;

/**
 * @Description mybatis自定义配置
 **/
@Configuration
public class MyBatisConfig {

    @Resource
    private List<SqlSessionFactory> sqlSessionFactoryList;

    @Value("${application.env}")
    private String env;

    private static final String ON_LINE = "online";


    @PostConstruct
    public void addMyBatisInterceptor() {
        if (ON_LINE.equals(env)) {
            return;
        }
        MyBatisPrintInterceptor interceptor = new MyBatisPrintInterceptor();
        for (SqlSessionFactory sqlSessionFactory : sqlSessionFactoryList) {
            // 添加自定义属性
            sqlSessionFactory.getConfiguration().addInterceptor(interceptor);
        }
    }

}

看一下效果

============================ Sql Start ============================
Execute ID ：com.didi.xxx.mapper.xxxMapper.selectxxx
Execute SQL ：select xxx from table_xxx WHERE xxx = 1
Execute Time：6 ms
============================ Sql End ============================
像我这种菜鸟确实是走了很多坑，当然目前应该也许有更好的插件等，欢迎来评论区分享。