快捷導(dǎo)航

MyBatis自定義攔截器實(shí)現(xiàn)優(yōu)化SQL日志輸出

更新時(shí)間：2026年03月16日 08:43:41 作者：湯姆yu

這篇文章主要介紹了優(yōu)化MyBatisPlus SQL日志輸出的方案,針對(duì)默認(rèn)日志格式存在的不足,例如缺少時(shí)間、可讀性差、存儲(chǔ)成本高等,希望對(duì)大家有所幫助

1、背景

MyBatis Plus 通過(guò)配置文件中設(shè)置 log-impl 屬性來(lái)指定日志實(shí)現(xiàn)，以打印 SQL 語(yǔ)句。

mybatis-plus:
  configuration:
    log-impl:org.apache.ibatis.logging.stdout.StdOutImpl
logging:
  level:
    org.ylzl.eden.demo.mapper:DEBUG

打印出來(lái)的 SQL 內(nèi)容如下：

==> Preparing: SELECT id,login,email,activated,locked,lang_key,activation_key,reset_key,reset_date,created_by,created_date,last_modified_by,last_modified_date FROM demo_user WHERE id=?
==> Parameters: 1(Long)
<== Columns: ID, LOGIN, EMAIL, ACTIVATED, LOCKED, LANG_KEY, ACTIVATION_KEY, RESET_KEY, RESET_DATE, CREATED_BY, CREATED_DATE, LAST_MODIFIED_BY, LAST_MODIFIED_DATE
<== Row: 1, admin, 1813986321@qq.com, TRUE, FALSE, zh-cn, null, null, null, system, 2025-02-10 22:31:03.818, system, null
<== Total: 1

然而，默認(rèn)的日志輸出格式存在以下不足：

缺少日志時(shí)間，無(wú)法快速定位 SQL 執(zhí)行時(shí)間。
SQL 語(yǔ)句可讀性差，復(fù)雜的 SQL 語(yǔ)句難以閱讀。
日志存儲(chǔ)成本高：SQL 模板占用較多字符，增加了日志存儲(chǔ)成本。

2、目標(biāo)

通過(guò) MyBatis 的攔截器實(shí)現(xiàn) SQL 原始語(yǔ)句的打印。

3、實(shí)現(xiàn)

首先，自定義 MyBatis 攔截器，實(shí)現(xiàn) org.apache.ibatis.plugin.Interceptor 接口。

@Intercepts({
@Signature(method = "query", type = Executor.class, args= {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
 @Signature(method= "query", type = Executor.class, args= {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class}),
 @Signature(method= "update", type = Executor.class, args= {MappedStatement.class, Object.class})
})
publicclassMybatisSqlLogInterceptorimplementsInterceptor{
privatestaticfinal Logger log = LoggerFactory.getLogger("MybatisSqlLog");
private Duration slownessThreshold = Duration.ofMillis(1000);
@Override
public Object intercept(Invocation invocation)throws Throwable {
  MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
  String mapperId = mappedStatement.getId();
  String originalSql = MybatisUtils.getSql(mappedStatement, invocation);
long start = SystemClock.now();
  Object result = invocation.proceed();
long duration = SystemClock.now() - start;
        // 當(dāng) SQL 執(zhí)行超過(guò)我們?cè)O(shè)置的閾值，轉(zhuǎn)為 WARN 級(jí)別 
if (Duration.ofMillis(duration).compareTo(slownessThreshold) < 0) {
   log.info("{} execute sql: {} ({} ms)", mapperId, originalSql, duration);
  } else {
   log.warn("{} execute sql took more than {} ms: {} ({} ms)", mapperId, slownessThreshold.toMillis(), originalSql, duration);
  }
return result;
 }
@Override
public Object plugin(Object target){
if (target instanceof Executor) {
   return Plugin.wrap(target, this);
  }
return target;
 }
    // 設(shè)置慢 SQL 閾值，單位為秒
publicvoidsetSlownessThreshold(Duration slownessThreshold){
this.slownessThreshold = slownessThreshold;
 }
}

筆者編寫(xiě)了一個(gè)工具類(lèi)負(fù)責(zé)解析 MyBatis 執(zhí)行語(yǔ)句，還原為可執(zhí)行的 SQL 內(nèi)容。

@UtilityClass
publicclassMybatisUtils{

    privatestaticfinal Pattern PARAMETER_PATTERN = Pattern.compile("\\?");

public String getSql(MappedStatement mappedStatement, Invocation invocation){
  Object parameter = null;
if (invocation.getArgs().length > 1) {
   parameter = invocation.getArgs()[1];
  }
  BoundSql boundSql = mappedStatement.getBoundSql(parameter);
  Configuration configuration = mappedStatement.getConfiguration();
return resolveSql(configuration, boundSql);
 }

privatestatic String resolveSql(Configuration configuration, BoundSql boundSql){
  Object parameterObject = boundSql.getParameterObject();
  List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
  String sql = boundSql.getSql().replaceAll("[\\s]+", " ");
if (!parameterMappings.isEmpty() && parameterObject != null) {
   TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
   if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
    sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(resolveParameterValue(parameterObject)));

   } else {
    MetaObject metaObject = configuration.newMetaObject(parameterObject);
    Matcher matcher = PARAMETER_PATTERN.matcher(sql);
    StringBuffer sqlBuffer = new StringBuffer();
    for (ParameterMapping parameterMapping : parameterMappings) {
     String propertyName = parameterMapping.getProperty();
     Object obj = null;
     if (metaObject.hasGetter(propertyName)) {
      obj = metaObject.getValue(propertyName);
     } elseif (boundSql.hasAdditionalParameter(propertyName)) {
      obj = boundSql.getAdditionalParameter(propertyName);
     }
     if (matcher.find()) {
      matcher.appendReplacement(sqlBuffer, Matcher.quoteReplacement(resolveParameterValue(obj)));
     }
    }
    matcher.appendTail(sqlBuffer);
    sql = sqlBuffer.toString();
   }
  }
return sql;
 }

privatestatic String resolveParameterValue(Object obj){
if (obj instanceof CharSequence) {
   return"'" + obj + "'";
  }
if (obj instanceof Date) {
   DateFormat formatter = DateFormat.getDateTimeInstance(DateFormat.DEFAULT, DateFormat.DEFAULT, Locale.CHINA);
   return"'" + formatter.format(obj) + "'";
  }
return obj == null ? "" : String.valueOf(obj);
 }
}

將 MyBatis 攔截器設(shè)置為 Spring 自動(dòng)裝配。

@AutoConfigureAfter(DataSourceAutoConfiguration.class)
@ConditionalOnBean(SqlSessionFactory.class)
@ConditionalOnProperty(name= "mybatis.plugin.sql-log.enabled")
@EnableConfigurationProperties({MybatisPluginProperties.class})
@RequiredArgsConstructor
@Slf4j
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
@Configuration(proxyBeanMethods= false)
publicclassMybatisPluginAutoConfiguration{

privatefinal MybatisPluginProperties mybatisPluginProperties;

@Bean
public MybatisSqlLogInterceptor mybatisSqlLogInterceptor(){
  MybatisSqlLogInterceptor interceptor = new MybatisSqlLogInterceptor();
  interceptor.setSlownessThreshold(mybatisPluginProperties.getSqlLog().getSlownessThreshold());
return interceptor;
 }
}

@Data
@ConfigurationProperties(prefix = "mybatis.plugin")
publicclassMybatisPluginProperties{

privatefinal SqlLog sqlLog = new SqlLog();

@Data
publicstaticclassSqlLog{

privateboolean enabled = true;

private Duration slownessThreshold = Duration.ofMillis(1000);
 }
}

當(dāng)項(xiàng)目配置了屬性 mybatis.plugin.sql-log.enabled=true 時(shí)，SQL 攔截將生效，打印的內(nèi)容如下：

2024-02-10 23:03:01.845 INFO [dev] [XNIO-1 task-1] org.ylzl.eden.demo.infrastructure.user.database.UserMapper.selectById execute sql: SELECT id,login,email,activated,locked,lang_key,activation_key,reset_key,reset_date,created_by,created_date,last_modified_by,last_modified_date FROM demo_user WHERE id=1 (10 ms)

這種日志格式比較符合我們實(shí)際的生產(chǎn)要求：提供日志時(shí)間、可運(yùn)行的 SQL、執(zhí)行耗時(shí)。