Mybatis之如何攔截慢SQL日志記錄

更新時(shí)間：2023年05月16日 08:48:09 作者：不愛(ài)編程的設(shè)計(jì)師

這篇文章主要介紹了Mybatis之如何攔截慢SQL日志記錄問(wèn)題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

Mybatis攔截慢SQL日志記錄

通過(guò)分析MySQL慢查詢(xún)?nèi)罩静环奖?，利用?shù)據(jù)源不直觀，無(wú)法了解上下文調(diào)用關(guān)系

要求通過(guò)可配置化的操作實(shí)現(xiàn)日志在控制臺(tái)的輸出和在數(shù)據(jù)庫(kù)中記錄

本文利用SpringBoot和Mybatis，基于Mybatis Interceptor實(shí)現(xiàn)慢SQL攔截日志記錄和打印輸出

服務(wù)配置

# slow-sql
# 基于interceptor
slow-sql-interceptor.enabled=true
# 設(shè)置超時(shí)時(shí)間ms
slow-sql.timeout=10
# 日志是否插入數(shù)據(jù)庫(kù)
slow-sql.insertDB=true

日志實(shí)體類(lèi)

@Data
public class SqlLog {
    // 主鍵
    private Long id;
    // 調(diào)用方法名稱(chēng)
    private String methodName;
    // 參數(shù)列表
    private String params;
    // 方法執(zhí)行時(shí)間
    private Long runTime;
    // 執(zhí)行SQL
    private String executeSql;
    // SQL類(lèi)型
    private String sqlType;
    // 記錄創(chuàng)建時(shí)間
    private Date createTime;
}

SQL攔截器

@Intercepts({@Signature(type = StatementHandler.class, method = "query", args = {Statement.class, ResultHandler.class}),
             @Signature(type = StatementHandler.class, method = "update", args = {Statement.class}),
             @Signature(type = StatementHandler.class, method = "batch", args = {Statement.class})})
@Component
@Slf4j
// 配置文件讀取是否啟用此配置
@ConditionalOnProperty(prefix = "slow-sql-interceptor", name = "enabled", havingValue = "true")
public class SqlExecuteTimeInterceptor implements Interceptor {
    // 日志記錄mapper
    @Autowired
    private LogMapper logMapper;
    // 是否插入數(shù)據(jù)庫(kù)標(biāo)識(shí)
    @Value("${slow-sql.insertDB}")
    private boolean isInsertDB;
    // 超時(shí)時(shí)間
    @Value("${slow-sql.timeout}")
    private Long timeout;
    /**
     * @Author thailandking
     * @Date 2020/2/16 16:44
     * @LastEditors thailandking
     * @LastEditTime 2020/2/16 16:44
     * @Description sql攔截器
     */
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Object target = invocation.getTarget();
        long begin = System.currentTimeMillis();
        StatementHandler statementHandler = (StatementHandler) target;
        try {
            return invocation.proceed();
        } finally {
            long end = System.currentTimeMillis();
            // 判斷超時(shí)
            if ((end - begin) > timeout) {
                // 方法名稱(chēng)、類(lèi)型
                MetaObject metaObject = MetaObject.forObject(statementHandler, SystemMetaObject.DEFAULT_OBJECT_FACTORY, SystemMetaObject.DEFAULT_OBJECT_WRAPPER_FACTORY, new DefaultReflectorFactory());
                MappedStatement mappedStatement = (MappedStatement) metaObject.getValue("delegate.mappedStatement");
                String methodName = mappedStatement.getId();
                String sqlType = mappedStatement.getSqlCommandType().toString();
                // 控制臺(tái)打印日志
                BoundSql boundSql = statementHandler.getBoundSql();
                String sql = boundSql.getSql();
                // 參數(shù)map
                Object parameterObject = boundSql.getParameterObject();
                // 參數(shù)列表
                List<ParameterMapping> parameterMappingList = boundSql.getParameterMappings();
                // 格式化sql語(yǔ)句，去除換行符，替換參數(shù)
                sql = formatSQL(sql, parameterObject, parameterMappingList);
                log.error("執(zhí)行 SQL：[ {} ], 執(zhí)行耗時(shí)[ {} ms ]", sql, (end - begin));
                // 判斷是否寫(xiě)入數(shù)據(jù)庫(kù)
                if (isInsertDB) {
                    // 轉(zhuǎn)換參數(shù)map為String
                    String params = changeSqlMapParams(parameterObject, parameterMappingList);
                    SqlLog log = new SqlLog();
                    log.setMethodName(methodName);
                    log.setParams(params);
                    log.setRunTime((end - begin));
                    log.setExecuteSql(sql);
                    log.setSqlType(sqlType);
                    logMapper.insertSqlLog(log);
                }
            }
        }
    }
    private String changeSqlMapParams(Object parameterObject, List<ParameterMapping> parameterMappingList) {
        StringBuilder sb = new StringBuilder();
        Map<String, Object> params = (Map<String, Object>) parameterObject;
        for (ParameterMapping pm : parameterMappingList) {
            if (pm.getMode().name().equals("IN")) {
                String param = ",[" + params.get(pm.getProperty()).toString() + "]";
                sb.append(param);
            }
        }
        return sb.length() > 0 ? sb.substring(1) : null;
    }
    private String formatSQL(String sql, Object parameterObject, List<ParameterMapping> parameterMappingList) {
        if (sql == null || sql.length() == 0) {
            return "";
        }
        // 去除換行符
        sql = sql.replaceAll("[\\s\n ]+", "  ");
        // 替換參數(shù)
        Map<String, Object> params = (Map<String, Object>) parameterObject;
        for (ParameterMapping pm : parameterMappingList) {
            if (pm.getMode().name().equals("IN")) {
                sql = sql.replaceFirst("\\?", params.get(pm.getProperty()).toString());
            }
        }
        return sql;
    }
    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
    @Override
    public void setProperties(Properties properties) {
    }
}

效果展示

Mybatis攔截器打印完整sql日志

開(kāi)始創(chuàng)建攔截器，創(chuàng)建自定義攔截器必須實(shí)現(xiàn)Interceptor接口，那么我們新建一個(gè)SqlLoggerInterceptor類(lèi)并實(shí)現(xiàn)Interceptor接口，并且通過(guò)@Intercepts和@Signature注解來(lái)配置攔截的方法和對(duì)象

我們經(jīng)常用到的就只有update和兩個(gè)query，因此在@Intercepts內(nèi)寫(xiě)上3個(gè)Signature，如：

可以看出update、query、query中的args中的對(duì)象是和Executor中的update、query、query方法中的參數(shù)是一一對(duì)應(yīng)的，實(shí)現(xiàn)Interceptor接口中的方法，主要有三個(gè)方法分別是plugin、setProperties、intercept，而我們主要做的就是intercept方法，plugin方法一般固定即可，setProperties是在外部傳近來(lái)的值

創(chuàng)建攔截器，實(shí)現(xiàn)

org.apache.ibatis.plugin.Interceptor

@Slf4j
@Intercepts({
    //type指定代理的是那個(gè)對(duì)象，method指定代理Executor中的那個(gè)方法,args指定Executor中的query方法都有哪些參數(shù)對(duì)象
    //由于Executor中有兩個(gè)query，因此需要兩個(gè)@Signature
    @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class}),//需要代理的對(duì)象和方法
    @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class,
        ResultHandler.class, CacheKey.class, BoundSql.class}),
    @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class,
        ResultHandler.class})//需要代理的對(duì)象和方法
})
public class SqlLoggerInterceptor implements Interceptor {
  @Override
  public Object intercept(Invocation invocation) throws Throwable {
    MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
    Object parameter = null;
    if (invocation.getArgs().length > 1) {
      //獲得查詢(xún)方法的參數(shù)，比如selectById(Integer id,String name)，那么就可以獲取到四個(gè)參數(shù)分別是：
      //{id:1,name:"user1",param1:1,param2:"user1"}
      parameter = invocation.getArgs()[1];
    }
    String sqlId = mappedStatement.getId();//獲得mybatis的*mapper.xml文件中映射的方法，如：com.best.dao.UserMapper.selectById
    //將參數(shù)和映射文件組合在一起得到BoundSql對(duì)象
    BoundSql boundSql = mappedStatement.getBoundSql(parameter);
    //獲取配置信息
    Configuration configuration = mappedStatement.getConfiguration();
    Object returnValue = null;
    log.debug("/*---------------java:" + sqlId + "[begin]---------------*/");
    //通過(guò)配置信息和BoundSql對(duì)象來(lái)生成帶值得sql語(yǔ)句
    String sql = geneSql(configuration, boundSql);
    //打印sql語(yǔ)句
    log.info("==> mysql : " + sql);
    //先記錄執(zhí)行sql語(yǔ)句前的時(shí)間
    long start = System.currentTimeMillis();
    try {
      //開(kāi)始執(zhí)行sql語(yǔ)句
      returnValue = invocation.proceed();
    } catch (InvocationTargetException | IllegalAccessException e) {
      e.printStackTrace();
    }
    //記錄執(zhí)行sql語(yǔ)句后的時(shí)間
    long end = System.currentTimeMillis();
    //得到執(zhí)行sql語(yǔ)句的用了多長(zhǎng)時(shí)間
    long time = (end - start);
    //以毫秒為單位打印
    log.debug("<== sql執(zhí)行歷時(shí)：" + time + "毫秒");
    //返回值，如果是多條記錄，那么此對(duì)象是一個(gè)list，如果是一個(gè)bean對(duì)象，那么此處就是一個(gè)對(duì)象，也有可能是一個(gè)map
    return returnValue;
  }
  /**
   * 如果是字符串對(duì)象則加上單引號(hào)返回，如果是日期則也需要轉(zhuǎn)換成字符串形式，如果是其他則直接轉(zhuǎn)換成字符串返回。
   *
   * @param obj
   * @return
   */
  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(obj) + "'";
    } else {
      if (obj != null) {
        value = obj.toString();
      } else {
        value = "";
      }
    }
    return value;
  }
  /**
   * 生成對(duì)應(yīng)的帶有值得sql語(yǔ)句
   *
   * @param configuration
   * @param boundSql
   * @return
   */
  public static String geneSql(Configuration configuration, BoundSql boundSql) {
    Object parameterObject = boundSql.getParameterObject();//獲得參數(shù)對(duì)象，如{id:1,name:"user1",param1:1,param2:"user1"}
    List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();//獲得映射的對(duì)象參數(shù)
    String sql = boundSql.getSql().replaceAll("[\\s]+", " ");//獲得帶問(wèn)號(hào)的sql語(yǔ)句
    if (parameterMappings.size() > 0 && parameterObject != null) {//如果參數(shù)個(gè)數(shù)大于0且參數(shù)對(duì)象不為空，說(shuō)明該sql語(yǔ)句是帶有條件的
      TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
      if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {//檢查該參數(shù)是否是一個(gè)參數(shù)
        //getParameterValue用于返回是否帶有單引號(hào)的字符串，如果是字符串則加上單引號(hào)
        sql = sql.replaceFirst("\\?", getParameterValue(parameterObject));//如果是一個(gè)參數(shù)則只替換一次，將問(wèn)號(hào)直接替換成值
      } else {
        MetaObject metaObject = configuration.newMetaObject(parameterObject);//將映射文件的參數(shù)和對(duì)應(yīng)的值返回，比如：id，name以及對(duì)應(yīng)的值。
        for (ParameterMapping parameterMapping : parameterMappings) {//遍歷參數(shù)，如:id,name等
          String propertyName = parameterMapping.getProperty();//獲得屬性名，如id,name等字符串
          if (metaObject.hasGetter(propertyName)) {//檢查該屬性是否在metaObject中
            Object obj = metaObject.getValue(propertyName);//如果在metaObject中，那么直接獲取對(duì)應(yīng)的值
            sql = sql.replaceFirst("\\?", getParameterValue(obj));//然后將問(wèn)號(hào)?替換成對(duì)應(yīng)的值。
          } else if (boundSql.hasAdditionalParameter(propertyName)) {
            Object obj = boundSql.getAdditionalParameter(propertyName);
            sql = sql.replaceFirst("\\?", getParameterValue(obj));
          }
        }
      }
    }
    return sql;//最后將sql語(yǔ)句返回
  }
  @Override
  public Object plugin(Object target) {
    return Plugin.wrap(target, this);
  }
  @Override
  public void setProperties(Properties properties) {
    //properties可以通過(guò)
    System.out.println(properties);
  }
}

此攔截寫(xiě)好之后還需要springboot使用，如果是通過(guò)@Component掃描是無(wú)法正常注入到IOC容器中的，因此需要通過(guò)@Configuration和@Bean的方式進(jìn)行，新建一個(gè)配置BatisPlusConfig類(lèi)，代碼如下

@Configuration
public class BatisPlusConfig {
  @Bean
  public String myInterceptor(SqlSessionFactory sqlSessionFactory) {
    //實(shí)例化插件
    SqlLoggerInterceptor sqlInterceptor = new SqlLoggerInterceptor();
    //創(chuàng)建屬性值
    Properties properties = new Properties();
    properties.setProperty("prop1", "value1");
    //將屬性值設(shè)置到插件中
    sqlInterceptor.setProperties(properties);
    //將插件添加到SqlSessionFactory工廠
    sqlSessionFactory.getConfiguration().addInterceptor(sqlInterceptor);
    return "interceptor";
  }
}