快捷導(dǎo)航

MyBatis-Plus輸出完整SQL(帶參數(shù))的三種方案

更新時(shí)間：2025年02月06日 10:02:03 作者：( ????? )920

當(dāng)我們使用 mybatis-plus 時(shí),可能會(huì)遇到SQL 不能直接執(zhí)行,調(diào)試也不方便的情況,那么,如何打印完整 SQL（帶參數(shù)）呢？本篇文章將介紹 3 種實(shí)現(xiàn)方式,并對(duì)比它們的優(yōu)缺點(diǎn),需要的朋友可以參考下

為什么 MyBatis Plus 默認(rèn) SQL 日志沒(méi)有參數(shù)？

當(dāng)你使用 mybatis-plus 時(shí)，可能會(huì)遇到這樣的情況：

Preparing: SELECT id, name, `desc` FROM author WHERE name = ?
Parameters: 劉禹錫(String)

這導(dǎo)致 SQL 不能直接執(zhí)行，調(diào)試也不方便。那么，如何打印完整 SQL（帶參數(shù)）呢？本篇文章將介紹 3 種實(shí)現(xiàn)方式，并對(duì)比它們的優(yōu)缺點(diǎn)。

方案 1：使用 SqlLogInterceptor（推薦）

從 MyBatis Plus 3.5.3 版本開(kāi)始，官方提供了 SqlLogInterceptor，可以自動(dòng)替換 SQL 語(yǔ)句中的 ? 為實(shí)際參數(shù)。

配置方式：

import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.SqlLogInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyBatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new SqlLogInterceptor()); // ? 讓 SQL 帶參數(shù)
        return interceptor;
    }
}

效果：

Executing SQL: SELECT id, name, `desc` FROM author WHERE name = '劉禹錫'

優(yōu)點(diǎn)：

官方支持，無(wú)侵入，簡(jiǎn)單易用
低性能開(kāi)銷(xiāo)，僅影響日志輸出
適用于 MyBatis Plus

缺點(diǎn)：

只適用于 MyBatis Plus（普通 MyBatis 需要用方案 2）

方案 2：自定義 MyBatis Interceptor

如果你使用的是 原生 MyBatis，或者想要更靈活的日志格式，可以 自定義 Interceptor。

編寫(xiě) Interceptor：

@Intercepts({
    @Signature(type = Executor.class, method = "query", args = {
        MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
    @Signature(type = Executor.class, method = "update", args = {
        MappedStatement.class, Object.class})
})
@Slf4j
public class SqlInterceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object proceed = invocation.proceed();
        long endTime = System.currentTimeMillis();

        String sql = generateSql(invocation);
        log.info("\n 執(zhí)行SQL耗時(shí)：{}ms \n 執(zhí)行SQL：{}", endTime - startTime, sql);
        return proceed;
    }

    private static String generateSql(Invocation invocation) {
        MappedStatement statement = (MappedStatement) invocation.getArgs()[0];
        Object parameter = invocation.getArgs().length > 1 ? invocation.getArgs()[1] : null;
        BoundSql boundSql = statement.getBoundSql(parameter);

        String sql = boundSql.getSql().replaceAll("[\\s]+", " ");
        for (ParameterMapping param : boundSql.getParameterMappings()) {
            Object value = boundSql.getAdditionalParameter(param.getProperty());
            sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(value)));
        }
        return sql;
    }

    private static String getParameterValue(Object object) {
        return object instanceof String ? "'" + object + "'" : String.valueOf(object);
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
}

優(yōu)點(diǎn)：

適用于 原生 MyBatis 和 MyBatis Plus
可自定義日志格式，控制輸出內(nèi)容

缺點(diǎn)：

需要手動(dòng)編寫(xiě)，稍微復(fù)雜一點(diǎn)
性能開(kāi)銷(xiāo)略大（需要解析 SQL 并替換參數(shù)）

方案 3：開(kāi)啟 MyBatis 日志（手動(dòng)拼接 SQL）

如果只是 臨時(shí)調(diào)試，可以在 application.yml 配置 MyBatis 日志：

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

然后，手動(dòng)拼接 SQL 進(jìn)行調(diào)試。

優(yōu)點(diǎn)：

無(wú)代碼改動(dòng)，適合臨時(shí)調(diào)試

缺點(diǎn)：

仍然是 Preparing: xxx 和 Parameters: xxx 的分離格式
不能直接復(fù)制執(zhí)行

最佳方案對(duì)比與選擇

方案	適用場(chǎng)景	侵入性	性能開(kāi)銷(xiāo)	適用框架
SqlLogInterceptor	MyBatis Plus	無(wú)	低	MyBatis Plus
自定義 Interceptor	需要特殊格式	中等	中	MyBatis & MyBatis Plus
MyBatis 日志	臨時(shí)調(diào)試	無(wú)	低	MyBatis & MyBatis Plus