MyBatis SQL 耗时记录的拦截器实战

记录MyBatis SQL 耗时记录的拦截器实战

在性能优化的道路上，SQL执行时间往往是关键突破口。本文将从一个八年经验Java开发者的视角，带你深入探索MyBatis SQL耗时监控的最佳实践。

一、为什么我们需要关注SQL执行时间？

在我多年的开发经历中，数据库性能瓶颈往往是系统优化的关键点。特别是在微服务架构和高并发场景下，一个未优化的SQL可能拖垮整个系统。以下是几个典型的业务场景：

1. 生产环境性能问题排查：用户突然反馈系统变慢，需要快速定位慢SQL
2. 接口性能优化：API响应时间超过预期，需要分析数据库操作耗时
3. 慢SQL监控：建立系统化的慢查询监控机制
4. SQL优化验证：验证SQL优化措施的实际效果

二、技术方案选型：为什么选择MyBatis拦截器？

在Java生态中，我们有多种方式可以实现SQL耗时统计：

方案	优点	缺点
MyBatis拦截器	原生支持、侵入性低、精准控制	需要理解MyBatis内部机制
AOP切面	通用性强、与ORM解耦	无法获取SQL语句细节
日志框架	简单直接	日志量大、难以结构化处理
数据库监控	无需代码改动	脱离应用上下文、配置复杂

作为有经验的开发者，我推荐使用MyBatis拦截器方案。它提供了最直接的SQL执行切入点，能获取最丰富的执行上下文信息，且对业务代码零侵入。

三、核心实现：从拦截器到耗时统计

3.1 实现原理

MyBatis拦截器基于责任链模式，我们可以通过实现Interceptor接口，在以下关键点插入逻辑：

1. Executor.update() - 拦截增删改操作
2. Executor.query() - 拦截查询操作

3.2 完整代码实现

import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Properties;

@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}),
    @Signature(type = Executor.class, method = "query",
               args = {MappedStatement.class, Object.class, RowBounds.class, 
                       ResultHandler.class, CacheKey.class, BoundSql.class})
})
public class SqlCostInterceptor implements Interceptor {
    
    private static final Logger logger = LoggerFactory.getLogger("SQL_PERF");
    
    // 慢查询阈值（毫秒）
    private long slowQueryThreshold = 1000;
    
    // 是否打印参数
    private boolean showParameters = true;
    
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Object[] args = invocation.getArgs();
        MappedStatement mappedStatement = (MappedStatement) args[0];
        Object parameterObject = args[1];
        
        // 获取SQL信息
        BoundSql boundSql = mappedStatement.getBoundSql(parameterObject);
        String sqlId = mappedStatement.getId();
        String sql = boundSql.getSql().replaceAll("\\s+", " ");
        
        long start = System.currentTimeMillis();
        try {
            return invocation.proceed(); // 执行目标方法
        } finally {
            long cost = System.currentTimeMillis() - start;
            logSqlPerformance(sqlId, sql, parameterObject, cost);
        }
    }
    
    private void logSqlPerformance(String sqlId, String sql, 
                                   Object params, long cost) {
        // 基础日志
        String logMsg = String.format("SQL执行耗时: %dms | ID: %s | SQL: %s",
                                     cost, sqlId, sql);
        
        // 参数日志（敏感数据需脱敏）
        if (showParameters && params != null) {
            String paramStr = params.toString();
            // 简单脱敏处理（实际项目应使用专业脱敏工具）
            paramStr = paramStr.replaceAll("(\"password\":\")([^\"]+)(\")", 
                                          "$1****$3");
            logMsg += " | 参数: " + paramStr;
        }
        
        // 分级日志输出
        if (cost > slowQueryThreshold) {
            logger.warn("[慢查询告警] {}", logMsg);
        } else if (cost > 500) {
            logger.info("{}", logMsg);
        } else {
            logger.debug("{}", logMsg);
        }
    }
    
    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
    
    @Override
    public void setProperties(Properties properties) {
        // 从配置加载参数
        String threshold = properties.getProperty("slowQueryThreshold");
        if (threshold != null) {
            this.slowQueryThreshold = Long.parseLong(threshold);
        }
        
        String showParams = properties.getProperty("showParameters");
        if (showParams != null) {
            this.showParameters = Boolean.parseBoolean(showParams);
        }
    }
}

3.3 关键代码解析

1. @Intercepts注解：定义拦截的类和方法签名
2. BoundSql获取：通过MappedStatement获取实际执行的SQL
3. 参数脱敏处理：防止敏感数据（如密码）泄露到日志
4. 分级日志输出：根据耗时长短使用不同日志级别
5. 可配置化：通过setProperties方法实现阈值可配置

3.4 Spring Boot集成配置

@Configuration
public class MyBatisConfig {
    
    @Bean
    public SqlCostInterceptor sqlCostInterceptor() {
        SqlCostInterceptor interceptor = new SqlCostInterceptor();
        Properties properties = new Properties();
        properties.setProperty("slowQueryThreshold", "500"); // 500ms以上视为慢查询
        properties.setProperty("showParameters", "true");
        interceptor.setProperties(properties);
        return interceptor;
    }
}

四、生产环境进阶技巧

4.1 性能优化策略

1. 异步日志输出：避免日志IO阻塞业务线程

   private final ExecutorService logExecutor = 
       Executors.newSingleThreadExecutor();
   
   private void logSqlPerformance(...) {
       logExecutor.submit(() -> {
           // 日志记录逻辑
       });
   }

2. 采样率控制：高并发场景下按比例采样

   // 在intercept方法中加入
   if (ThreadLocalRandom.current().nextDouble() < 0.2) {
       // 只记录20%的请求
   }

4.2 监控系统集成

将SQL耗时数据发送到监控系统（如Prometheus）：

private void recordMetrics(String sqlId, long cost) {
    // Prometheus指标记录
    Summary.builder("sql_execution_time")
           .tag("sql_id", sqlId)
           .register()
           .observe(cost);
    
    // 慢查询计数器
    if (cost > slowQueryThreshold) {
        Counter.builder("slow_sql_count")
               .tag("sql_id", sqlId)
               .register()
               .inc();
    }
}

4.3 可视化与告警

结合Grafana等工具创建SQL性能仪表盘：

1. 按SQL ID统计平均耗时
2. 慢查询发生频率
3. SQL执行次数统计

设置告警规则：

• 单个SQL平均耗时连续5分钟 > 500ms
• 慢查询频率每分钟 > 10次

五、经验总结与避坑指南

在八年开发实践中，我总结了以下重要经验：

1. 谨慎处理参数日志：

   • 必须进行敏感信息脱敏
   • 大对象参数截断处理

   if (paramStr.length() > 1000) {
       paramStr = paramStr.substring(0, 1000) + "...[truncated]";
   }

2. 区分环境配置：

   • 开发环境：记录详细SQL和参数
   • 生产环境：仅记录慢查询，关闭参数打印

3. 线程安全考量：

   • 拦截器是单例的，所有状态变量必须线程安全
   • 使用ThreadLocal存储耗时上下文

4. 避免过度监控：

   • 核心业务SQL重点监控
   • 低频管理后台SQL可降低监控强度

5. 与其他监控工具协同：

   • 整合链路追踪（如SkyWalking）的TraceID
   • 与APM工具协同工作

六、结论

记录MyBatis SQL执行耗时不是目的，而是优化系统性能的手段。通过本文介绍的拦截器方案，我们可以：

1. 精准定位性能瓶颈
2. 建立SQL性能基线
3. 主动发现慢查询问题
4. 量化SQL优化效果

技术不是目的，而是解决问题的工具。八年的经验告诉我：最好的优化发生在设计阶段，最有效的监控是预防性监控。