本文主要介绍SpringBoot项目如何添加Mybatis拦截器，从而实现打印完整SQL语句、结果集以及耗时。涵盖了XML配置以及零XML配置两种方式。

废话少说，先附上代码吧，后面讲解一下需要注意的点。

打印完整SQL拦截器

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.collections4.CollectionUtils;
import org.apache.ibatis.executor.Executor;
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.session.Configuration;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.type.TypeHandlerRegistry;
import org.springframework.core.env.Environment;
import org.springframework.util.ObjectUtils;

import java.text.DateFormat;
import java.util.*;
import java.util.regex.Matcher;
import java.util.stream.Collectors;

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

    private static final DateFormat FORMATTER = DateFormat.getDateTimeInstance(DateFormat.DEFAULT, DateFormat.DEFAULT, Locale.CHINA);

    private List<String> getPrintSqlMapperIdList() {
        Environment environment = getEnvironment();
      //自行配置需要打印sql的sqlId
        String printSqlMapperIdStr = environment.getProperty("printSqlMapperIdStr");
        if (!ObjectUtils.isEmpty(printSqlMapperIdStr)) {
            return Arrays.stream(printSqlMapperIdStr.split(SPLITTER_COMMA)).collect(Collectors.toList());
        }
        return new ArrayList<>();
    }

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        try {
            // 获取xml中的一个select/update/insert/delete节点，是一条SQL语句
            MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
            Object parameter = null;
            // 获取参数，if语句成立，表示sql语句有参数，参数格式是map形式
            if (invocation.getArgs().length > 1) {
                parameter = invocation.getArgs()[1];
                log.info("printSqlInterceptor parameter:" + parameter);
            }
            // 获取到节点的id,即sql语句的id
            String sqlId = mappedStatement.getId();
            log.info("printSqlInterceptor sqlId:" + sqlId);

            List<String> printSqlMapperIdList = getPrintSqlMapperIdList();
            String evnInfo = getEvnInfo();
            if (ENV_PROD.equals(evnInfo) && printSqlMapperIdList.contains(sqlId)) {
                printSql(mappedStatement, parameter, sqlId);
            } else if (!ENV_PROD.equals(evnInfo)) {
                printSql(mappedStatement, parameter, sqlId);
            }
        } catch (Exception e) {
            log.info("printSqlInterceptor intercept error", e);
        }
        // 执行完上面的任务后，不改变原有的sql执行过程
        return invocation.proceed();
    }

    private void printSql(MappedStatement mappedStatement, Object parameter, String sqlId) {
        // BoundSql就是封装myBatis最终产生的sql类
        BoundSql boundSql = mappedStatement.getBoundSql(parameter);
        // 获取节点的配置
        Configuration configuration = mappedStatement.getConfiguration();
        // 获取到最终的sql语句
        String sql = getSql(configuration, boundSql, sqlId);
        log.info("printSqlInterceptor completeSqlInfo:" + sql);
    }

    /**
     * 封装了一下sql语句，使得结果返回完整xml路径下的sql语句节点id + sql语句
     *
     * @param configuration
     * @param boundSql
     * @param sqlId
     * @return
     */
    public static String getSql(Configuration configuration, BoundSql boundSql, String sqlId) {
        String sql = showSql(configuration, boundSql);
        return sqlId + ":" + sql;
    }

    /**
     * 如果参数是String，则添加单引号， 如果是日期，则转换为时间格式器并加单引号； 对参数是null和不是null的情况作了处理
     *
     * @param obj
     * @return
     */
    private static String getParameterValue(Object obj) {
        String value;
        if (obj instanceof String) {
            value = "'" + obj.toString() + "'";
        } else if (obj instanceof Date) {
            value = "'" + FORMATTER.format((Date) obj) + "'";
        } else {
            if (obj != null) {
                value = obj.toString();
            } else {
                value = "";
            }
        }
        return value;
    }

    /**
     * 进行？的替换
     *
     * @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.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;
    }

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

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

打印结果集和SQL耗时拦截器

import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;
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 org.springframework.core.env.Environment;
import org.springframework.util.ObjectUtils;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Properties;
import java.util.stream.Collectors;

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

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 执行请求方法，并将所得结果保存到result中
        long start = System.currentTimeMillis();
        Object result = invocation.proceed();
        long end = System.currentTimeMillis();
        MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
        String sqlId = mappedStatement.getId();
        printResultAndCost(result, sqlId, end - start);
        return result;
    }

    private void printResultAndCost(Object result, String sqlId, long cost) {
        String evnInfo = getEvnInfo();
        List<String> printSqlResultMapperIdList = getPrintSqlResultMapperIdList();
        if (ENV_PROD.equals(evnInfo) && printSqlResultMapperIdList.contains(sqlId)) {
            log.info("printResultInterceptor printResult:{},cost:{},{}", sqlId, cost, JSON.toJSONString(result));
        } else if (!ENV_PROD.equals(evnInfo)) {
            log.info("printResultInterceptor printResult:{},cost:{},{}", sqlId, cost, JSON.toJSONString(result));
        }
    }

    private List<String> getPrintSqlResultMapperIdList() {
      //自行配置需要打印结果集的sqlId
        String printSqlResultMapperIdStr = getEnvironment().getProperty("printSqlResultMapperIdStr");
        if (!ObjectUtils.isEmpty(printSqlResultMapperIdStr)) {
            return Arrays.stream(printSqlResultMapperIdStr.split(SPLITTER_COMMA)).collect(Collectors.toList());
        }
        return new ArrayList<>();
    }

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

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

上述两个拦截器涉及到的类

import org.springframework.core.env.Environment;

public class BaseMybatisInterceptor {

    protected static final String SPLITTER_COMMA = ",";
    protected static final String ENV_DEV = "dev";
    protected static final String ENV_TEST = "test";
    protected static final String ENV_PROD = "prod";

    protected String getEvnInfo() {
        String evnInfo = null;
        String[] profiles = ContextUtil.getAc().getEnvironment().getActiveProfiles();
        for (String profile : profiles) {
            if (profile.contains("dev")) {
                evnInfo = ENV_DEV;
                break;
            } else if (profile.contains("test")) {
                evnInfo = ENV_TEST;
            } else {
                evnInfo = ENV_PROD;
            }
        }
        return evnInfo;
    }
    protected Environment getEnvironment() {
        return ContextUtil.getAc().getEnvironment();
    }

}


@Component
public class ContextUtils implements ApplicationContextAware {

	private static ApplicationContext applicationContext;

	@Override
	public void setApplicationContext(ApplicationContext actx) throws BeansException {
		applicationContext = actx;
	}

	public static ApplicationContext getApplicationContext() {
		return applicationContext;
	}
}

基于XML配置

在mybatis配置文件里面添加下面的配置

<plugins> 
   <plugin interceptor="xx.xx.MybatisResultInterceptor"></plugin>
    <plugin interceptor="xx.xx.MybatisSqlInterceptor"></plugin> 
 </plugins>

零XML配置
在pom文加引入mybatis-spring-boot-starter

        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.4</version>
        </dependency>

配置拦截器

@Configuration
public class MyBatisConfig {
@Autowired
    private List<SqlSessionFactory> sqlSessionFactoryList;

    @PostConstruct
    public void addMyInterceptor() {
        for (SqlSessionFactory sqlSessionFactory : sqlSessionFactoryList) {
            sqlSessionFactory.getConfiguration().addInterceptor(new MybatisSqlInterceptor());
            sqlSessionFactory.getConfiguration().addInterceptor(new MybatisResultInterceptor());
        }
    }
}

注意

如果你的项目没有引入Mybatis分页插件（如 PageHelper），那么经过上面的配置之后就大功告成了。

如果你的项目有类似PageHelper这种分页插件，那么上述的配置并不能使拦截器生效。具体的原因和解决方式请参考解决PageHelper使Mybatis自定义拦截器失效

Springboot+Mybatis拦截器打印完整SQL结果

打印完整SQL拦截器

打印结果集和SQL耗时拦截器

上述两个拦截器涉及到的类

基于XML配置

零XML配置
在pom文加引入mybatis-spring-boot-starter

注意

相关推荐

取消回复欢迎你发表评论:

Google 黑客常用搜索语句一览原力计划

npx简介（npxvip是哪国的）

在 Android 模拟器上运行 ARM 应用（android模拟器原理）

GB28181,B接口协议之SIPRTSPRTPRTMP协议从入门到精通

手机实时提取SIM卡打电话的信令和声音-辅助外设与商用通话方案

安装使用Hoppscotch构建API请求访问与测试

Python自动化办公——后台截图（python 自动截图）

轻松转换!AppleNumbers到Excel的快捷教程

电脑端腾讯文档如何导出excel

网络流媒体经典开源软件宝典webRTC, FFMpeg, SIP_流媒体开发教程

Springboot+Mybatis拦截器打印完整SQL结果

打印完整SQL拦截器

打印结果集和SQL耗时拦截器

上述两个拦截器涉及到的类

基于XML配置

零XML配置在pom文加引入mybatis-spring-boot-starter

注意

相关推荐

取消回复欢迎 你 发表评论:

Google 黑客常用搜索语句一览 原力计划

npx简介（npxvip是哪国的）

在 Android 模拟器上运行 ARM 应用（android模拟器原理）

GB28181,B接口协议之SIPRTSPRTPRTMP协议从入门到精通

手机实时提取SIM卡打电话的信令和声音-辅助外设与商用通话方案

安装使用Hoppscotch构建API请求访问与测试

Python自动化办公——后台截图（python 自动截图）

轻松转换!AppleNumbers到Excel的快捷教程

电脑端腾讯文档如何导出excel

网络流媒体经典开源软件宝典webRTC, FFMpeg, SIP_流媒体开发教程

零XML配置
在pom文加引入mybatis-spring-boot-starter

取消回复欢迎你发表评论:

Google 黑客常用搜索语句一览原力计划