快捷導(dǎo)航

MyBatis-Plus批量操作SQL日志不打印問題的解決方案

更新時間：2026年03月05日 08:57:09 作者：程序員食堂

在使用 MyBatis-Plus 的?saveBatch()?和?updateBatchById()?方法進(jìn)行批量數(shù)據(jù)操作時,發(fā)現(xiàn)自定義的 Druid SQL 日志攔截器無法打印這些批量操作的 SQL 語句,導(dǎo)致調(diào)試和問題排查困難,本文給大家該問題的詳細(xì)解決方案,需要的朋友可以參考下

問題描述

在使用 MyBatis-Plus 的 saveBatch() 和 updateBatchById() 方法進(jìn)行批量數(shù)據(jù)操作時，發(fā)現(xiàn)自定義的 Druid SQL 日志攔截器（SqlLogInterceptor）無法打印這些批量操作的 SQL 語句，導(dǎo)致調(diào)試和問題排查困難。

問題分析

1. 批量操作的特殊性

MyBatis-Plus 的批量操作方法（如 saveBatch、updateBatchById）使用了 JDBC 的批處理（Batch）模式來提高性能。批處理模式與普通的單條 SQL 執(zhí)行方式不同：

普通執(zhí)行：每條 SQL 單獨執(zhí)行，會觸發(fā) statementExecuteAfter、statementExecuteUpdateAfter 等方法
批處理執(zhí)行：多條 SQL 一起提交執(zhí)行，只會觸發(fā) statementExecuteBatchAfter 方法

2. 原有攔截器的問題

原有的 SqlLogInterceptor 繼承自 Druid 的 FilterEventAdapter，實現(xiàn)了以下方法：

@Override
protected void statementExecuteAfter(StatementProxy statement, String sql, boolean firstResult) {
    statement.setLastExecuteTimeNano();
    printSqlLog(statement, sql);
}

@Override
protected void statementExecuteUpdateAfter(StatementProxy statement, String sql, int updateCount) {
    statement.setLastExecuteTimeNano();
    printSqlLog(statement, sql);
}

@Override
protected void statementExecuteBatchAfter(StatementProxy statement, int[] result) {
    statement.setLastExecuteTimeNano();
    // 這里沒有打印日志！
}

可以看到，statementExecuteBatchAfter 方法中只設(shè)置了執(zhí)行時間，但沒有打印 SQL 日志，這就是批量操作 SQL 不打印的根本原因。

解決方案

方案一：修改 Druid 攔截器（推薦）

修改 SqlLogInterceptor.java 的 statementExecuteBatchAfter 方法，添加 SQL 日志打印邏輯：

@Override
protected void statementExecuteBatchAfter(StatementProxy statement, int[] result) {
    statement.setLastExecuteTimeNano();
    // 批量執(zhí)行后也打印SQL日志
    String sql = statement.getBatchSql();
    if (StringUtil.isNotBlank(sql)) {
        printSqlLog(statement, sql);
    } else {
        // 如果批量SQL為空，嘗試獲取最后執(zhí)行的SQL
        sql = statement.getLastExecuteSql();
        if (StringUtil.isNotBlank(sql)) {
            printSqlLog(statement, sql);
        }
    }
}

優(yōu)點：

統(tǒng)一的日志格式
包含執(zhí)行時間統(tǒng)計
可以格式化 SQL 和參數(shù)

缺點：

批量操作可能只顯示一條 SQL 模板，看不到每條具體的參數(shù)

方案二：啟用 MyBatis 原生日志

在 logback.xml 配置文件中添加 MyBatis Mapper 的 DEBUG 級別日志：

<!-- MyBatis SQL 日志 -->
<logger name="com.hzys.mapper" level="DEBUG"/>

優(yōu)點：

可以看到每條 SQL 的詳細(xì)參數(shù)
MyBatis 原生支持，穩(wěn)定可靠

缺點：

日志格式與自定義攔截器不一致
日志量較大

方案三：雙管齊下（最佳實踐）

同時使用方案一和方案二，既能保證批量操作的 SQL 被記錄，又能在需要時查看詳細(xì)的參數(shù)信息。

完整代碼示例

1. 修改后的 SqlLogInterceptor

@Slf4j
public class SqlLogInterceptor extends FilterEventAdapter {
    private static final SQLUtils.FormatOption FORMAT_OPTION = new SQLUtils.FormatOption(false, false);

    @Override
    protected void statementExecuteBatchAfter(StatementProxy statement, int[] result) {
        statement.setLastExecuteTimeNano();
        // 批量執(zhí)行后也打印SQL日志
        String sql = statement.getBatchSql();
        if (StringUtil.isNotBlank(sql)) {
            printSqlLog(statement, sql);
        } else {
            // 如果批量SQL為空，嘗試獲取最后執(zhí)行的SQL
            sql = statement.getLastExecuteSql();
            if (StringUtil.isNotBlank(sql)) {
                printSqlLog(statement, sql);
            }
        }
    }

    private void printSqlLog(StatementProxy statement, String sql) {
        if (!log.isInfoEnabled() || StringUtil.isEmpty(sql)) {
            return;
        }

        try {
            // 獲取參數(shù)
            int parametersSize = statement.getParametersSize();
            List<Object> parameters = new ArrayList<>(parametersSize);
            for (int i = 0; i < parametersSize; ++i) {
                parameters.add(getJdbcParameter(statement.getParameter(i)));
            }

            // 格式化SQL
            String dbType = statement.getConnectionProxy().getDirectDataSource().getDbType();
            String formattedSql = SQLUtils.format(sql, DbType.of(dbType), parameters, FORMAT_OPTION);

            // 打印日志
            printSql(formattedSql, statement);
        } catch (Exception e) {
            log.error("SQL 格式化失敗", e);
            log.info("\n\n==============  Sql Start  ==============\n" +
                    "Execute SQL : {}\n" +
                    "Execute Time: {}\n" +
                    "==============  Sql  End   ==============\n",
                    sql, StringUtil.format(statement.getLastExecuteTimeNano()));
        }
    }

    private static void printSql(String sql, StatementProxy statement) {
        String sqlLogger = "\n\n==============  Sql Start  ==============" +
                "\nExecute SQL : {}" +
                "\nExecute Time: {}" +
                "\n==============  Sql  End   ==============\n";
        log.info(sqlLogger, sql.trim(), StringUtil.format(statement.getLastExecuteTimeNano()));
    }
}

2. Logback 配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds">
    <!-- 其他配置... -->

    <!-- 日志輸出級別 -->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="INFO"/>
        <appender-ref ref="WARN"/>
        <appender-ref ref="ERROR"/>
    </root>

    <!-- MyBatis SQL 日志 -->
    <logger name="com.hzys.mapper" level="DEBUG"/>
    
    <logger name="net.sf.ehcache" level="INFO"/>
    <logger name="druid.sql" level="INFO"/>
</configuration>

3. Druid 配置

@Slf4j
@Configuration
public class DruidConfig {

    @Bean
    @Primary
    @ConfigurationProperties("spring.datasource.druid")
    public DataSource dataSource() {
        DruidDataSource dataSource = DruidDataSourceBuilder.create().build();

        // 添加自定義的SQL日志攔截器
        SqlLogInterceptor sqlLogInterceptor = new SqlLogInterceptor();
        dataSource.getProxyFilters().add(sqlLogInterceptor);

        return dataSource;
    }
}

驗證效果

修改后，執(zhí)行批量操作時會看到類似以下的日志輸出：

==============  Sql Start  ==============
Execute SQL : INSERT INTO employee_hourly_rate (id, project_member, member_level, ...) VALUES (?, ?, ?, ...)
Execute Time: 15ms
==============  Sql  End   ==============

==>  Preparing: INSERT INTO employee_hourly_rate (id, project_member, member_level, ...) VALUES (?, ?, ?, ...)
==> Parameters: 1(Long), 張三(String), 高級工程師(String), ...
==> Parameters: 2(Long), 李四(String), 中級工程師(String), ...
<==    Updates: 2

注意事項

性能考慮：DEBUG 級別的 MyBatis 日志會輸出大量信息，生產(chǎn)環(huán)境建議關(guān)閉或設(shè)置為 INFO 級別
日志過濾：可以在 SqlLogInterceptor 中添加過濾邏輯，避免打印某些不需要的 SQL（如健康檢查）
批量大小：MyBatis-Plus 默認(rèn)批量大小為 1000，可以通過配置調(diào)整
事務(wù)管理：批量操作需要在事務(wù)中執(zhí)行，確保添加 @Transactional 注解

總結(jié)

MyBatis-Plus 批量操作 SQL 不打印的問題主要是因為批處理模式使用了不同的執(zhí)行路徑，原有的攔截器沒有處理 statementExecuteBatchAfter 方法。通過修改攔截器并配合 MyBatis 原生日志，可以完美解決這個問題，既能保證日志的完整性，又能在需要時查看詳細(xì)的執(zhí)行信息。

以上就是MyBatis-Plus批量操作SQL日志不打印問題的解決方案的詳細(xì)內(nèi)容，更多關(guān)于MyBatis-Plus操作SQL日志不打印的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: