Spring Boot：使用p6spy監控數據庫操作

最近因爲換工作的原因導致博客停更好久，感覺再不寫點什麼就要廢掉了_(:з」∠*)_

首先p6spy是一個開源的數據庫監控插件，我們能通過使用p6spy打印數據庫操作或者保存操作日誌。
首先放上p6spy的git地址https://github.com/p6spy/p6spy

在Spring Boot中使用p6spy也是非常簡單。

Spring Boot中使用p6spy

1.添加maven依賴

https://mvnrepository.com/artifact/p6spy/p6spy找一個合適的版本。
我這裏以3.8.2爲例，在pom.xml中添加如下依賴。

<!-- https://mvnrepository.com/artifact/p6spy/p6spy -->
<dependency>
    <groupId>p6spy</groupId>
    <artifactId>p6spy</artifactId>
    <version>3.8.2</version>
</dependency>

2.修改數據庫連接配置

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
#原來
#spring.datasource.url=jdbc:mysql://x.x.x.x:3306/table
#使用p6spy後需要修改成的樣子
spring.datasource.url=jdbc:p6spy:mysql://x.x.x.x:3306/table?
spring.datasource.username=username
spring.datasource.password=password
#原來
#spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#使用p6spy後需要修改成的樣子
spring.datasource.driver-class-name=com.p6spy.engine.spy.P6SpyDriver

從這裏我們能看到會使用p6spy的數據庫驅動。

3.添加spy.properties配置文件

位置在resources下即可（和application.properties同目錄）

module.log=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 使用日誌系統記錄sql
appender=com.p6spy.engine.spy.appender.Slf4JLogger
## 配置記錄Log例外
excludecategories=info,debug,result,batc,resultset
# 設置使用p6spy driver來做代理
deregisterdrivers=true
# 日期格式
dateformat=yyyy-MM-dd HH:mm:ss
# 實際驅動
driverlist=com.mysql.cj.jdbc.Driver
# 是否開啓慢SQL記錄
outagedetection=true
# 慢SQL記錄標準 秒
outagedetectioninterval=2

這裏我們能看到driverlist=com.mysql.cj.jdbc.Driver，結合上面2中修改數據庫驅動，能看出p6spy實際上是類似一種代理數據庫驅動，在我們訪問數據庫時會通過p6spy的驅動，然後p6spy再會去調用實際的數據庫驅動，這樣p6spy就能截獲數據庫操作了。

4.自定義日誌打印

這裏有兩種實現方式

1.實現MessageFormattingStrategy接口。

新建P6SpyLogger.java

public class P6SpyLogger implements MessageFormattingStrategy {
	/**
     *
     * @param connectionId 連接id
     * @param now 當前時間
     * @param elapsed 耗時
     * @param category 類型
     * @param prepared 聲明的sql語句
     * @param sql 有效的sql語句
     * @param datasource 連接屬性
     * @return
     */
    @Override
    public String formatMessage(int connectionId, String now, long elapsed, String category, String prepared, String sql,String datasource) {
        return !"".equals(sql.trim()) ? "[ " + LocalDateTime.now() + " ] --- | took "
                + elapsed + "ms | " + category + " | connection " + connectionId +"\n " + "datasource " + datasource +"\n "
                + sql + ";" : "";
    }
}

其中參數的大致意思我也註釋了。
然後在spy.properties中添加配置

# 自定義日誌打印（就是上面添加的P6SpyLogger.java）
#logMessageFormat=com.p6spy.demop6spy.conf.P6SpyLogger

運行效果

2.使用p6spy提供的logMessageFormat實現

這裏有兩種，都是在spy.properties中的配置
（1）com.p6spy.engine.spy.appender.SingleLineFormat這個就相當於把所有信息在單行裏全部顯示出來。

logMessageFormat=com.p6spy.engine.spy.appender.SingleLineFormat

大致效果（因爲太長截圖放不下）

（2）com.p6spy.engine.spy.appender.CustomLineFormat這個和（1）比起來就比較人性化，可以自定義

logMessageFormat=com.p6spy.engine.spy.appender.CustomLineFormat
customLogMessageFormat=%(currentTime) | SQL use time： %(executionTime) ms | connect info： %(category)-%(connectionId) | execute sql： %(sql)

效果

順便放一下spy.properties的配置詳細說明吧

# 指定應用的日誌攔截模塊,默認爲com.p6spy.engine.spy.P6SpyFactory 
#modulelist=com.p6spy.engine.spy.P6SpyFactory,com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory

# 真實JDBC driver , 多個以 逗號 分割 默認爲空
#driverlist=

# 是否自動刷新 默認 flase
#autoflush=false

# 配置SimpleDateFormat日期格式 默認爲空
#dateformat=

# 打印堆棧跟蹤信息 默認flase
#stacktrace=false

# 如果 stacktrace=true，則可以指定具體的類名來進行過濾。
#stacktraceclass=

# 監測屬性配置文件是否進行重新加載
#reloadproperties=false

# 屬性配置文件重新加載的時間間隔，單位:秒 默認60s
#reloadpropertiesinterval=60

# 指定 Log 的 appender，取值：
#appender=com.p6spy.engine.spy.appender.Slf4JLogger
#appender=com.p6spy.engine.spy.appender.StdoutLogger
#appender=com.p6spy.engine.spy.appender.FileLogger

# 指定 Log 的文件名 默認 spy.log
#logfile=spy.log

# 指定是否每次是增加 Log，設置爲 false 則每次都會先進行清空 默認true
#append=true

# 指定日誌輸出樣式  默認爲com.p6spy.engine.spy.appender.SingleLineFormat , 單行輸出 不格式化語句
#logMessageFormat=com.p6spy.engine.spy.appender.SingleLineFormat
# 也可以採用  com.p6spy.engine.spy.appender.CustomLineFormat 來自定義輸出樣式, 默認值是%(currentTime)|%(executionTime)|%(category)|connection%(connectionId)|%(sqlSingleLine)
# 可用的變量爲:
#   %(connectionId)            connection id
#   %(currentTime)             當前時間
#   %(executionTime)           執行耗時
#   %(category)                執行分組
#   %(effectiveSql)            提交的SQL 換行
#   %(effectiveSqlSingleLine)  提交的SQL 不換行顯示
#   %(sql)                     執行的真實SQL語句，已替換佔位
#   %(sqlSingleLine)           執行的真實SQL語句，已替換佔位 不換行顯示
#customLogMessageFormat=%(currentTime)|%(executionTime)|%(category)|connection%(connectionId)|%(sqlSingleLine)

# date類型字段記錄日誌時使用的日期格式 默認dd-MMM-yy
#databaseDialectDateFormat=dd-MMM-yy

# boolean類型字段記錄日誌時使用的日期格式 默認boolean 可選值numeric
#databaseDialectBooleanFormat=boolean

# 是否通過jmx暴露屬性 默認true
#jmx=true

# 如果jmx設置爲true 指定通過jmx暴露屬性時的前綴 默認爲空
# com.p6spy(.<jmxPrefix>)?:name=<optionsClassName>
#jmxPrefix=

# 是否顯示納秒 默認false
#useNanoTime=false

# 實際數據源 JNDI
#realdatasource=/RealMySqlDS
# 實際數據源 datasource class
#realdatasourceclass=com.mysql.jdbc.jdbc2.optional.MysqlDataSource

# 實際數據源所攜帶的配置參數 以 k=v 方式指定 以 分號 分割
#realdatasourceproperties=port;3306,serverName;myhost,databaseName;jbossdb,foo;bar

# jndi數據源配置 
# 設置 JNDI 數據源的 NamingContextFactory。 
#jndicontextfactory=org.jnp.interfaces.NamingContextFactory
# 設置 JNDI 數據源的提供者的 URL。 
#jndicontextproviderurl=localhost:1099
# 設置 JNDI 數據源的一些定製信息，以分號分隔。 
#jndicontextcustom=java.naming.factory.url.pkgs;org.jboss.naming:org.jnp.interfaces

# 是否開啓日誌過濾 默認false， 這項配置是否生效前提是配置了 include/exclude/sqlexpression
#filter=false

# 過濾 Log 時所包含的表名列表，以逗號分隔 默認爲空
#include=
# 過濾 Log 時所排除的表名列表，以逗號分隔 默認爲空
#exclude=

# 過濾 Log 時的 SQL 正則表達式名稱  默認爲空
#sqlexpression=

#顯示指定過濾 Log 時排隊的分類列表，取值: error, info, batch, debug, statement,
#commit, rollback, result and resultset are valid values
# (默認 info,debug,result,resultset,batch)
#excludecategories=info,debug,result,resultset,batch

# 是否過濾二進制字段
# (default is false)
#excludebinary=false

# P6Log 模塊執行時間設置，整數值 (以毫秒爲單位)，只有當超過這個時間才進行記錄 Log。 默認爲0
#executionThreshold=

# P6Outage 模塊是否記錄較長時間運行的語句 默認false
# outagedetection=true|false
# P6Outage 模塊執行時間設置，整數值 （以秒爲單位)），只有當超過這個時間才進行記錄 Log。 默認30s
# outagedetectioninterval=integer time (seconds)

5.總體項目結構