SpringBoot通过MyBatis拦截器打印完整SQL语句(无问号)

- 日理万妓 2021-09-25 14:42 634阅读 0赞

在项目开发中常常需要对idea控制台的sql语句，进行复制粘贴操作，而日志的sql语句是和参数分开的，不免需要手动替换sql中的？，当参数很多时非常的麻烦，而且这种行为很无聊！

于是 Mybatis Log Plugin 很好的解决了这个问题，但是由于本人的idea升级到了20.3版本，新版的Mybatis Log Plugin插件要收费。

遂想方法，使用代码实现了这一过程，以上是原始html版本：[使用JS解析idea控制台SQL日志——JS版MybatisLogPlugin\_hunt\_er的博客-CSDN博客][JS_idea_SQL_JS_MybatisLogPlugin_hunt_er_-CSDN]

使用js去解析sql日志后，便捷了很多，但这种方法还需要多一次手动点击操作，时间长了之后也不爽。

后来经过同事点拨，使用mybatis拦截器进行解析，解析后直接输出在控制台，这样就更方便了！

并且可以设置在只有特定环境下（开发环境）开启拦截器，其他环境下不开启，这样就不用担心性能消耗的问题！

以下是代码：

/**
     * MyBatis拦截器打印不带问号的完整sql语句
     * 只在开发环境下执行
     */
    @Slf4j
    @Component
    @ConditionalOnProperty(value = "spring.profiles.active", havingValue = "dev")
    @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 MybatisSQLResolverInterceptor implements Interceptor {
        @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];
                }
                String id = mappedStatement.getId(); // 获取到节点的id,即sql语句的id
                BoundSql boundSql = mappedStatement.getBoundSql(parameter); // BoundSql就是封装myBatis最终产生的sql类
                Configuration configuration = mappedStatement.getConfiguration(); // 获取节点的配置
                String sql = showSql(configuration, boundSql); // 获取到最终的sql语句
                log.debug("mybatis拦截解析: \n ID: \t{}\n SQL: \t{}", id, sql);
            } catch (Exception e) {
                e.printStackTrace();
            }
            // 执行完上面的任务后，不改变原有的sql执行过程
            return invocation.proceed();
        }
    
        /**
         * 进行？的替换
         */
        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("\\?", "unknown");
                        }
                    }
                }
            }
            return sql;
        }
    
        /**
         * 如果参数是String，则添加单引号
         * 如果参数是日期，则转换为时间格式器并加单引号； 对参数是null和不是null的情况作了处理
         */
        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;
        }
    
    }

如果需要在更复杂的环境下配置该拦截器，可以查看@ConditionalOnProperty的具体使用方法。

提供一篇文章链接，学习SpringBoot如何按需加载 Bean：[传送门][Link 1]

[JS_idea_SQL_JS_MybatisLogPlugin_hunt_er_-CSDN]: https://blog.csdn.net/hunt_er/article/details/115169721
[Link 1]: https://blog.csdn.net/lxh_worldpeace/article/details/105886064