SpringBoot專案實現日誌列印SQL明細(包括SQL語句和引數)幾種方式

sum墨發表於2024-04-25
Spring BootSQL

前言

我們在開發專案的時候，都會連線資料庫。有時候遇到問題需要根據我們編寫的SQL進行分析，但如果不進行一些開發或者配置的話，這些SQL是不會列印到控制檯的，它們預設是隱藏的。下面給大家介紹幾種常用的方法。

第一種、程式碼形式

Mybatis框架是Java程式設計師最常用的資料庫對映框架，MyBatis 允許你在已對映語句執行過程中的某一點進行攔截呼叫。預設情況下，MyBatis 允許使用外掛來攔截的方法呼叫。那麼我們可以根據這個機制來獲取我們執行的sql語句以及引數。下面的SqlExecuteTimeCountInterceptor.java直接複製到SpringBoot專案就可以使用了。

1. 程式碼如下

package com.example.springbootsqlmonitor.config;

import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.session.ResultHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import java.sql.Statement;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Properties;


@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
public class SqlExecuteTimeCountInterceptor implements Interceptor {

    private static final Logger logger = LoggerFactory.getLogger(SqlExecuteTimeCountInterceptor.class);

    /**
     * 列印的引數字串的最大長度
     */
    private final static int MAX_PARAM_LENGTH = 50;

    /**
     * 記錄的最大SQL長度
     */
    private final static int MAX_SQL_LENGTH = 500;

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Object target = invocation.getTarget();
        long startTime = System.currentTimeMillis();
        StatementHandler statementHandler = (StatementHandler) target;
        try {
            return invocation.proceed();
        } finally {
            long endTime = System.currentTimeMillis();
            long timeCount = endTime - startTime;

            BoundSql boundSql = statementHandler.getBoundSql();
            String sql = boundSql.getSql();
            Object parameterObject = boundSql.getParameterObject();
            List<ParameterMapping> parameterMappingList = boundSql.getParameterMappings();

            // 格式化Sql語句，去除換行符，替換引數
            sql = formatSQL(sql, parameterObject, parameterMappingList);

            logger.info("執行 SQL：[{}]執行耗時[ {} ms])", sql, timeCount);
        }
    }

    /**
     * 格式化/美化 SQL語句
     *
     * @param sql                  sql 語句
     * @param parameterObject      引數的Map
     * @param parameterMappingList 引數的List
     * @return 格式化之後的SQL
     */
    private String formatSQL(String sql, Object parameterObject, List<ParameterMapping> parameterMappingList) {
        // 輸入sql字串空判斷
        if (sql == null || sql.length() == 0) {
            return "";
        }
        // 美化sql
        sql = beautifySql(sql);
        // 不傳引數的場景，直接把sql美化一下返回出去
        if (parameterObject == null || parameterMappingList == null || parameterMappingList.size() == 0) {
            return sql;
        }
        return limitSQLLength(sql, parameterObject, parameterMappingList);
    }

    /**
     * 返回限制長度之後的SQL語句
     *
     * @param sql                  原始SQL語句
     * @param parameterObject
     * @param parameterMappingList
     */
    private String limitSQLLength(String sql, Object parameterObject, List<ParameterMapping> parameterMappingList) {
        if (sql == null || sql.length() == 0) {
            return "";
        }
        Map<String, Object> parameterMap = (Map<String, Object>) parameterObject;
        StringBuilder paramsBuilder = new StringBuilder("\n引數列表：");
        parameterMap.forEach((key, value) -> {
            parameterMappingList.forEach(parameterMapping -> {
                if (parameterMapping.getProperty().equals(key)) {
                    String detail = "[" + key + ":" + value + "]；";
                    paramsBuilder.append(detail);
                }
            });
        });
        sql += paramsBuilder.toString();
        if (sql.length() > MAX_SQL_LENGTH) {
            return sql.substring(0, MAX_SQL_LENGTH);
        } else {
            return sql;
        }
    }

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

    @Override
    public void setProperties(Properties properties) {

    }

    /**
     * 美化sql
     *
     * @param sql sql語句
     */
    private String beautifySql(String sql) {
        sql = sql.replaceAll("[\\s\n ]+", "  ");
        return sql;
    }
}

2. 效果如下

2022-07-21 19:14:07.685  INFO 25936 --- [           main] c.e.s.c.SqlExecuteTimeCountInterceptor   : 執行 SQL：[SELECT  t3.user_id,  t3.user_name,  t2.role_id,  t2.role_name  FROM  my_user_role_rel  t1  LEFT  JOIN  my_role  t2  ON  t1.role_id  =  t2.role_id  LEFT  JOIN  my_user  t3  ON  t1.user_id  =  t3.user_id  WHERE  t1.user_id  =  ?  AND  t2.role_id  =  ?
引數列表：[roleId:1]；[userId:1]；]執行耗時[ 18 ms])

第二種、Mybatis-Plus配置

如果你的專案用的是Mybatis-Plus框架，那麼你可以不用寫程式碼，直接用一行配置就可以實現sql日誌監控:
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

1. 配置如下

# mybatis
mybatis.configuration.auto-mapping-behavior=full
mybatis.configuration.map-underscore-to-camel-case=true
mybatis-plus.mapper-locations=classpath*:/mybatis/mapper/*.xml
# 開啟mybatis-plus自帶SQL列印
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

2. 效果如下

Creating a new SqlSession
SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@b14b60a] was not registered for synchronization because synchronization is not active
JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@1142d377] will not be managed by Spring
==>  Preparing: SELECT t3.user_id, t3.user_name, t2.role_id, t2.role_name FROM my_user_role_rel t1 LEFT JOIN my_role t2 ON t1.role_id = t2.role_id LEFT JOIN my_user t3 ON t1.user_id = t3.user_id WHERE t1.user_id = ? 
==> Parameters: 1(Long)
<==    Columns: user_id, user_name, role_id, role_name
<==        Row: 1, 使用者1, 1, 超級管理員
<==        Row: 1, 使用者1, 2, 遊客
<==      Total: 2
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@b14b60a]

第三種、整合p6spy框架

使用p6spy這種形式是最複雜的，不過也是最好的，是專門用來跟蹤資料庫操作的。

1. maven引入

<!-- sql 列印 -->
<dependency>
	<groupId>p6spy</groupId>
	<artifactId>p6spy</artifactId>
	<version>3.8.5</version>
</dependency>

2. application.properties配置檔案

這裡要注意該兩個地方：

spring.datasource.url=jdbc:p6spy:mysql://localhost:3306/mybatis-test?characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai&rewriteBatchedStatements=true

spring.datasource.driver-class-name=com.p6spy.engine.spy.P6SpyDriver

spring.datasource.url=jdbc:p6spy:mysql://localhost:3306/mybatis-test?characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai&rewriteBatchedStatements=true&zeroDateTimeBehavior=convertToNull
spring.datasource.username=root
spring.datasource.password=***
spring.datasource.driver-class-name=com.p6spy.engine.spy.P6SpyDriver

3. 在resources下建立spy.properties檔案

內容如下：

# 開啟模組sql記錄和長時sql記錄
module.log=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 自己編寫格式類
logMessageFormat=com.example.springbootsqlmonitor.config.P6spySqlFormatConfig

# 透過配置進行格式設定
#logMessageFormat=com.p6spy.engine.spy.appender.CustomLineFormat
# 自定義sql輸出格式
#customLogMessageFormat=%(currentTime) | TIME\uFF1A %(executionTime) ms | SQL\uFF1A %(sql)

# 日誌輸出方式(輸出到控制檯)
appender=com.p6spy.engine.spy.appender.StdoutLogger
#appender=com.p6spy.engine.spy.appender.Slf4JLogger

excludecategories=info,debug,result,resultset
deregisterdrivers=true
dateformat=yyyy-MM-dd HH:mm:ss
driverlist=com.mysql.cj.jdbc.Driver
# 開啟長時sql記錄
outagedetection=true
# 觸發長時記錄時限
outagedetectioninterval=2

4. 效果如下

耗時 5 ms | SQL 語句：
SELECT t3.user_id, t3.user_name, t2.role_id, t2.role_name FROM my_user_role_rel t1 LEFT JOIN my_role t2 ON t1.role_id = t2.role_id LEFT JOIN my_user t3 ON t1.user_id = t3.user_id WHERE t1.user_id = 1 AND t2.role_id = 1;

整合p6spy遇到的一些問題

1. 啟動報錯

Caused by: java.lang.IllegalStateException: dbType not support : null, url jdbc:p6spy:mysql://localhost:3306/mybatis-test?characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai&rewriteBatchedStatements=true&zeroDateTimeBehavior=convertToNull

出現這個問題的原因是配置了Druid連線池，是它的一個屬性導致的，把這個屬性註釋掉
spring.datasource.druid.filters=stat,wall

或者增加如下配置：
spring.datasource.druid.filter.wall.enabled=true spring.datasource.druid.filter.wall.db-type=mysql spring.datasource.druid.filter.stat.db-type=mysql spring.datasource.druid.filter.stat.enabled=true

2、spy.properties配置檔案不生效

出現這個問題，一般要去檢查一下你的jar包，看一下spy.properties檔案有沒有被打包進去。因為這個是不需要增加配置類的，是透過劫持資料庫連線實現的。

結語

對比上面這三種方式，其中p6spy列印的sql最完整，是可以直接放在資料庫工具上執行的，而不是像Mybatis列印那種引數帶問號的。但其實列印這些sql語句挺消耗效能的，建議到了線上把它給關掉，避免非業務消耗資源。

文末小彩蛋，自己花一個星期做的小網站，放出來給大家看看，網址如下：http://47.120.49.119:8080

相關文章