🥂(?′?`?)您的點贊👍?評論📝?收藏?是作者創作的最大動力🤞

💖📕🎉🔥 支持我：點贊👍+收藏??+留言📝歡迎留言討論

🔥🔥🔥（源碼 + 調試運行 + 問題答疑）🔥🔥🔥 ?有興趣可以聯系我

🔥🔥🔥 ?文末有往期免費源碼，直接領取獲取（無刪減，無套路）

MyBatis SQL日志輸出全解析：從基礎實現到高級優化

熱門標題推薦

1. MyBatis SQL日志輸出深度剖析：從基礎實現到插件優化

2. 手把手實現MyBatis SQL日志功能：原理、實現與陷阱規避

3. MyBatis SQL監控終極指南：掌握SQL執行的每一個細節

4. 深入理解MyBatis日志機制：如何優雅輸出可執行的SQL語句

5. MyBatis SQL日志輸出全攻略：從簡單打印到高級定制

正文

SQL日志輸出是MyBatis開發中最常用且重要的功能之一，它幫助開發者監控和調試數據庫操作。一個良好的SQL日志系統不僅能顯示執行的SQL語句，還能展示參數值、執行時間等關鍵信息。本文將深入探討MyBatis中SQL日志輸出的實現原理、各種實現方式及其優缺點。

一、SQL日志輸出的重要性

在開發過程中，SQL日志輸出具有不可替代的價值：

1. 調試與排錯：當SQL執行出現問題時，日志可以幫助快速定位問題

2. 性能監控：通過記錄SQL執行時間，識別性能瓶頸

3. 審計追蹤：記錄所有數據庫操作，滿足審計需求

4. SQL優化：分析實際執行的SQL，進行優化調整

二、基礎SQL日志輸出實現

最簡單的SQL日志輸出可以在StatementHandler.prepare方法之后或Executor執行SQL之前實現：

public class SimpleStatementHandler implements StatementHandler {@Overridepublic Statement prepare(Connection connection) throws SQLException {// 原始prepare邏輯Statement statement = connection.createStatement();// 輸出SQL日志String sql = boundSql.getSql();System.out.println("Executing SQL: " + sql);return statement;}}

這種方式雖然簡單，但只能輸出帶有占位符(?)的SQL，無法顯示實際的參數值。

三、帶參數值的SQL日志輸出

要輸出完整的可執行SQL，需要獲取參數值并替換到SQL中的占位符：

public class ParameterAwareStatementHandler implements StatementHandler {@Overridepublic int update(Statement statement) throws SQLException {// 獲取SQL和參數String sql = boundSql.getSql();Object parameter = boundSql.getParameterObject();List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();// 構建完整SQLString completeSql = buildCompleteSql(sql, parameter, parameterMappings);System.out.println("Executing SQL: " + completeSql);// 執行原始邏輯return statement.executeUpdate(sql);}private String buildCompleteSql(String sql, Object parameter, List<ParameterMapping> parameterMappings) {if (parameterMappings == null || parameterMappings.isEmpty()) {return sql;}String completeSql = sql;for (int i = 0; i < parameterMappings.size(); i++) {ParameterMapping mapping = parameterMappings.get(i);Object value = getParameterValue(parameter, mapping);completeSql = completeSql.replaceFirst("\\?", formatParameterValue(value));}return completeSql;}}

注意：這種方法僅用于日志輸出，不能直接執行拼接后的SQL，因為存在SQL注入風險。

四、SQL注入風險與安全處理

在拼接SQL參數時，必須注意安全性問題：

1. 字符串值需要引號包裹：字符串參數必須用單引號包裹

2. 特殊字符轉義：包含單引號的字符串需要轉義處理

3. NULL值處理：NULL值應該直接替換為NULL關鍵字

4. 日期格式處理：日期類型需要轉換為合適的字符串格式

?private String formatParameterValue(Object value) {if (value == null) {return "NULL";}if (value instanceof String) {return "'" + ((String) value).replace("'", "''") + "'";}if (value instanceof Date) {return "'" + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format((Date) value) + "'";}if (value instanceof Number) {return value.toString();}return "'" + value.toString().replace("'", "''") + "'";}

五、基于插件的優雅實現

使用MyBatis插件機制可以實現更優雅、非侵入式的SQL日志輸出：

1. 定義日志插件

?@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})})public class SqlLogPlugin implements Interceptor {private static final Logger logger = LoggerFactory.getLogger(SqlLogPlugin.class);@Overridepublic Object intercept(Invocation invocation) throws Throwable {MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];Object parameter = invocation.getArgs()[1];BoundSql boundSql = mappedStatement.getBoundSql(parameter);String sql = boundSql.getSql();List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();// 構建完整SQLString completeSql = buildCompleteSql(sql, parameter, parameterMappings);long start = System.currentTimeMillis();Object result = invocation.proceed();long end = System.currentTimeMillis();logger.info("SQL: {} | Time: {}ms", completeSql, (end - start));return result;}}

2. 配置插件

在MyBatis配置文件中注冊插件：

?<plugins><plugin interceptor="com.example.SqlLogPlugin"><property name="logLevel" value="DEBUG"/></plugin></plugins>

六、高級SQL日志功能

除了基本的SQL輸出，還可以實現更高級的日志功能：

1. 執行時間監控

?public class PerformanceMonitorPlugin implements Interceptor {@Overridepublic Object intercept(Invocation invocation) throws Throwable {long start = System.currentTimeMillis();Object result = invocation.proceed();long end = System.currentTimeMillis();long threshold = 1000; // 1秒閾值if (end - start > threshold) {logger.warn("Slow SQL detected: {}ms", (end - start));}return result;}}

2. SQL格式化輸出

對于復雜的SQL，格式化輸出更易于閱讀：

?private String formatSql(String sql) {// 簡單的SQL格式化邏輯sql = sql.replaceAll("(?i)select", "\nSELECT ").replaceAll("(?i)from", "\nFROM ").replaceAll("(?i)where", "\nWHERE ").replaceAll("(?i)join", "\nJOIN ").replaceAll("(?i)order by", "\nORDER BY ").replaceAll("(?i)group by", "\nGROUP BY ");return sql;}

3. 敏感數據脫敏

對于包含敏感信息的SQL，需要進行脫敏處理：

?private String maskSensitiveData(String sql) {// 脫敏手機號sql = sql.replaceAll("1[3-9]\\d{9}", "1**********");// 脫敏身份證號sql = sql.replaceAll("\\d{17}[\\dXx]", "***************");// 脫敏銀行卡號sql = sql.replaceAll("\\d{16,19}", "*******************");return sql;}

七、集成日志框架

直接使用System.out.println不是生產環境的最佳選擇，應該集成成熟的日志框架：

1. SLF4J集成

public class Slf4jSqlLogger {private static final Logger logger = LoggerFactory.getLogger("SQL_LOGGER");public void logSql(String sql, long executionTime, Object... params) {if (logger.isDebugEnabled()) {StringBuilder logMessage = new StringBuilder();logMessage.append("SQL: ").append(sql);logMessage.append(" | Parameters: ").append(Arrays.toString(params));logMessage.append(" | Time: ").append(executionTime).append("ms");logger.debug(logMessage.toString());}}
}

2. 動態日志級別控制

通過配置動態控制SQL日志的詳細程度：

?public enum SqlLogLevel {NONE, ? ?// 不輸出日志BASIC, ? // 只輸出SQL語句PARAMS, ?// 輸出SQL和參數PERFORMANCE, // 輸出SQL、參數和執行時間FULL ? ? // 輸出所有信息}

八、生產環境最佳實踐

在生產環境中使用SQL日志時，應注意以下最佳實踐：

1. 性能影響：日志輸出可能影響性能，應在必要時開啟

2. 日志級別控制：根據環境動態調整日志級別

3. 敏感信息保護：對敏感數據進行脫敏處理

4. 日志輪轉：配置適當的日志輪轉策略，避免日志文件過大

5. 監控告警：對慢SQL和異常SQL設置監控告警

九、常見問題與解決方案

1. 日志輸出不完整

問題：參數過多時日志輸出被截斷?解決方案：限制參數輸出長度，或提供摘要信息

2. 性能開銷過大

問題：日志輸出導致性能顯著下降?解決方案：使用異步日志輸出，或采樣輸出部分SQL

3. 特殊類型處理

問題：Blob、Clob等特殊類型無法正常輸出?解決方案：對這些類型提供特殊處理，輸出摘要信息而非完整內容

十、總結

SQL日志輸出是MyBatis開發中不可或缺的功能，從最簡單的System.out.println到基于插件的完整解決方案，每種方式都有其適用場景。在實際項目中，應根據具體需求選擇合適的實現方式，并注意安全性、性能和可維護性等方面的考慮。

通過本文的介紹，相信您已經對MyBatis SQL日志輸出有了全面的了解，能夠根據項目需求實現適合的SQL日志功能，從而更好地監控和優化數據庫操作。

---

往期免費源碼 (無刪減，無套路)：🔥🔥🔥 ?

https://pan.baidu.com/s/1sjAr08PU9Xe7MQf1gjGM5w?pwd=6666?

「在線考試系統源碼（含搭建教程）」 (無刪減，無套路)：🔥🔥🔥 ?

鏈接：https://pan.quark.cn/s/96c4f00fdb43 提取碼：WR6M
往期免費源碼對應視頻：

🥂(?′?`?)您的點贊👍?評論📝?收藏?是作者創作的最大動力🤞

💖📕🎉🔥 支持我：點贊👍+收藏??+留言📝歡迎留言討論

🔥🔥🔥（源碼 + 調試運行 + 問題答疑）

🔥🔥🔥 ?有興趣可以聯系我