【Mybatis】MybatisSqlInterceptor Interceptor 拦截器打印完整的sql语句

最近在做公司的项目，发现项目当中使用Mybatis框架的时候，打印的SQL都是用原生的DEBUG的日志，执行SQL和参数都是分开的，这样我们在排查SQL问题的时候，都需要手动拼接，浪费了一些时间，

所以我们需要想办法打印出完成的SQL，Mybatis为我们提供了 org.apache.ibatis.plugin.Interceptor接口，我们来实现该接口做一些打印SQL的工作，可能很多小伙伴的项目都已经用了此功能，但是也可以

看一下，温故而知新，主要是为了那些真正需要帮助的小伙伴提供一些参考。 我参与的项目的Mybatis版本 3.4.2。 

 

虽然Mybatis打印SQL的功能网上多的是，但是真正需要的时候，网上大部分都是不完整的，着急的时候根本帮不上忙，所以我把我写的内容给大家分享一下，保证能够复制到项目中就可以使用，现在来粘贴我们的代码：

 

package com.sr.microservice.interceptor;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.collections.CollectionUtils;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.SystemMetaObject;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.type.TypeHandlerRegistry;

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

/**
 * 类说明： @Intercepts  拦截器
 *         @Signature 拦截器签名
 *         type 拦截的类型 四大对象之一( Executor , ResultSetHandler , ParameterHandler , StatementHandler )
 *         method 拦截的方法
 *         args 参数,高版本需要加个Integer.class参数,不然会报错
 * @Author wangzhizhong
 * @Date 2020/12/9 10:55
 * @Version 1.0
 */
@Slf4j
@Intercepts({
        @Signature(type = StatementHandler.class,
                method = "prepare",
                args = {Connection.class, Integer.class})})
public class MybatisSqlInterceptor implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 耗时开始时间
        long startTime = System.currentTimeMillis();
        // 获取 StatementHandler ，默认是 RoutingStatementHandler
        StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
        // 获取 StatementHandler 包装类
        MetaObject metaObjectHandler = SystemMetaObject.forObject(statementHandler);
        // 获取查询接口映射的相关信息
        MappedStatement mappedStatement = (MappedStatement) metaObjectHandler.getValue("delegate.mappedStatement");
        // 获取请求时的参数
        Object parameterObject = statementHandler.getParameterHandler().getParameterObject();
        // 获取sql
        String sql = showSql(mappedStatement.getConfiguration(),  mappedStatement.getBoundSql(parameterObject));
        // 获取执行sql方法
        String sqlId = mappedStatement.getId();
        // 执行sql
        Object result = invocation.proceed();
        // 计算总耗时
        long cost = System.currentTimeMillis() - startTime;
        log.info(" ======> SQL方法 : {} , 总耗时 : {}毫秒,  SQL语句 : {} ", sqlId, cost, sql);
        return result;
    }


    /**
     * 拦截器对应的封装原始对象的方法，获取代理对象
     */
    @Override
    public Object plugin(Object target) {
        return (target instanceof StatementHandler) ? Plugin.wrap(target, this) : target;
    }


    /**
     * 设置注册拦截器时设定的属性，设置代理对象的参数
     */
    @Override
    public void setProperties(Properties properties) {
    }


    private 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.isNotEmpty(parameterMappings) && parameterObject != null) {
            // 获取类型处理器注册器，类型处理器的功能是进行java类型和数据库类型的转换
            TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
            // 如果根据parameterObject.getClass(）可以找到对应的类型，则替换
            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("\\?", "缺失");
                    }
                }
            }
        }

        return sql;
    }


    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;
    }

}

 

写完了拦截器，我们需要注册到 Mybatis的 SessionFactory中，我们主要粘贴关键代码如下：

@Primary
	@Bean(name = SQL_SESSION_FACTORY)
	public SqlSessionFactory sqlSessionFactory(@Qualifier(DATASOURCE) DataSource dataSource) throws Exception {
		final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
		sessionFactory.setDataSource(dataSource);
		sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(MAPPER_LOCATION));

        // 小伙子，关键代码在这呢，你过来啊
		sessionFactory.setPlugins(new Interceptor[]{mybatisSqlInterceptor()});

		return sessionFactory.getObject();
	}





	@Bean
	public MybatisSqlInterceptor mybatisSqlInterceptor() {
		MybatisSqlInterceptor mybatisSqlInterceptor = new MybatisSqlInterceptor();
		Properties properties = new Properties();
		mybatisSqlInterceptor.setProperties(properties);
		return mybatisSqlInterceptor;
	}

 

那我们运行项目来打印我们的SQL，给个结果，我们庆祝一下：

好了，后续再分享项目中遇到的问题和代码，个人分享的内容只具有参考意义，每个人的理解不一样，代码不一样，遇到一些志同道合的小伙伴，我们一起努力进步。生活总是美好的。