Mybatis扩展Interceptor监控SQL日志

素颜马尾好姑娘i 2023-10-11 18:07 11阅读 0赞

实现一（不指定特定数据源）

public class SqlStatementInterceptor implements Interceptor {
        
    
        private Properties properties;
    
        @Override
        public Object intercept(Invocation invocation) throws Throwable {
        
            Object returnValue;
            long start = System.currentTimeMillis();
            returnValue = invocation.proceed();
            long end = System.currentTimeMillis();
            long time = end - start;
            final Object[] args = invocation.getArgs();
            //获取原始的ms
            MappedStatement ms = (MappedStatement) args[0];
            Object parameter = null;
            //获取参数，if语句成立，表示sql语句有参数，参数格式是map形式
            if (invocation.getArgs().length > 1) {
        
                parameter = invocation.getArgs()[1];
            }
            String sqlId = ms.getId();// 获取到节点的id,即sql语句的id
            BoundSql boundSql = ms.getBoundSql(parameter);  // BoundSql就是封装myBatis最终产生的sql类
            Configuration configuration = ms.getConfiguration();  // 获取节点的配置
            System.out.println("================ start execute sql ================ \n" + showSql(configuration, boundSql) + "" +
                    "\n ================ end execute sql ================\n" );
            return returnValue;
        }
    
        /*<br>    *如果参数是String，则添加单引号， 如果是日期，则转换为时间格式器并加单引号； 对参数是null和不是null的情况作了处理<br>　　*/
        private static String getParameterValue(Object obj) {
        
            String value = null;
            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;
        }
    
        // 进行？的替换
        public static String showSql(Configuration configuration, BoundSql boundSql) {
        
            Object parameterObject = boundSql.getParameterObject();  // 获取参数
            List<ParameterMapping> parameterMappings = boundSql
                    .getParameterMappings();
            String sql = boundSql.getSql().replaceAll("[\\s]+", " ");  // sql语句中多个空格都用一个空格代替
            if (!CollectionUtils.isEmpty(parameterMappings) && parameterObject != null) {
        
                TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry(); // 获取类型处理器注册器，类型处理器的功能是进行java类型和数据库类型的转换<br>　　　　　　　// 如果根据parameterObject.getClass(）可以找到对应的类型，则替换
                if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
        
                    sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(parameterObject)));
    
                } else {
        
                    MetaObject metaObject = configuration.newMetaObject(parameterObject);// MetaObject主要是封装了originalObject对象，提供了get和set的方法用于获取和设置originalObject的属性值,主要支持对JavaBean、Collection、Map三种类型对象的操作
                    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)) {
        
                            Object obj = boundSql.getAdditionalParameter(propertyName);  // 该分支是动态sql
                            sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(obj)));
                        } else {
        
                            sql = sql.replaceFirst("\\?", "缺失");
                        }//打印出缺失，提醒该参数缺失并防止错位
                    }
                }
            }
            return sql;
        }
    
        @Override
        public Object plugin(Object arg0) {
        
            return Plugin.wrap(arg0, this);
        }
    
        @Override
        public void setProperties(Properties arg0) {
        
            this.properties = arg0;
        }
    }

*  实现二

@Slf4j
    @Profile(value = "dev") //dev环境有效，本地开发监测日志
    @Component
    @Intercepts({
        
            @Signature(type = ParameterHandler.class, method = "setParameters", args = {
        PreparedStatement.class})
    })
    public class MyBatisLogInterceptor implements Interceptor {
        
    
        @Override
        public Object intercept(Invocation invocation) throws Throwable {
        
            PreparedStatement statement = (PreparedStatement) invocation.getArgs()[0];
            Object result = invocation.proceed();
            if (statement.toString().indexOf(":") > 0){
        
                String substring = statement.toString().substring(statement.toString().indexOf(":") + 1);
                String sql = substring = substring.replaceAll("\n\n","").
                        replaceAll("\n"," ").
                        replaceAll("  "," ");
                System.out.println(Constants.MYBATIS_LOG_START + "\n" + sql + "\n" + Constants.MYBATIS_LOG_END);
            }
            return result;
        }
    
    }

*  使用自定义配置的方式创建sqlsessionFactory时注入plugin-interceptor

@Bean
        public SqlSessionFactory primarySqlSessionFactory(DataSource dataSource,
                                                          @Autowired(required = false)SqlStatementInterceptor sqlStatementInterceptor) throws Exception {
        
            final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
            // 设置数据源bean
            sessionFactory.setDataSource(dataSource);
            // 设置mapper文件路径
            sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(DataBaseConfig.MAPPER_LOCATION));
    
            org.apache.ibatis.session.Configuration ibatisConfiguration = new org.apache.ibatis.session.Configuration();
            ibatisConfiguration.setMapUnderscoreToCamelCase(true);
            sessionFactory.setConfiguration(ibatisConfiguration);
            //设置拦截器插件
            if (sqlStatementInterceptor != null) {
        
                sessionFactory.setPlugins(sqlStatementInterceptor);
            }
            return sessionFactory.getObject();
        }