spring boot整合p6spy的最佳實踐

2022-02-24 19:02:08

前言

P6Spy是一個框架，它可以無縫地攔截和記錄資料庫活動，而無需更改現有應用程式的程式碼。一般我們使用的比較多的是使用p6spy列印我們最後執行的sql語句。常用的資料框架也會自帶列印sql的功能，比如jpa,mybatis等，但是一般都會有缺陷，比如列印的sql是不帶執行引數拼接的sql，這種sql不完整，不具有直接可執行性。所以，p6spy就派上用場了。常見整合p6spy的方式是在資源目錄下新增spy.properties組態檔，然後通過驅動裝載。這種方式已經非常簡單易用了，但是還有更簡單的方式，通過spring boot autoconfig的特性，可以做到自動裝配。博主已經封裝了一個自動裝配的spring boot starter專案並已開源，地址如下：

p6spy-spring-boot-starter專案地址：https://github.com/klboke/p6spy-spring-boot-starter

p6spy-spring-boot-starter快速整合

第一步：匯入依賴

jar包已上傳到maven中央倉庫，座標地址如下：

<dependency>
            <groupId>com.github.klboke</groupId>
            <artifactId>p6spy-spring-boot-starter</artifactId>
            <version>1.0</version>
</dependency>

第二步：設定application.properties

spring.datasource.url = jdbc:p6spy:mysql://xxx
spring.datasource.username = xxx
spring.datasource.password = xxx
spring.datasource.driver-class-name = com.p6spy.engine.spy.P6SpyDriver
p6spy.config.appender = com.p6spy.engine.spy.appender.Slf4JLogger
p6spy.config.logMessageFormat = com.p6spy.engine.spy.appender.CustomLineFormat
p6spy.config.customLogMessageFormat = executionTime:%(executionTime)| 執行sql:%(sqlSingleLine)

就是這麼簡單，我們已經整合完了，只需兩步即可。啟動專案就可以在控制檯看到執行的sql語句了

設定智慧提示

基於spring boot config meta特性，針對設定做了詳細的描述，而且在設定時IDEA會有比較好的提示，如：

相容原生所有設定項

p6spy-spring-boot-starter相容原生的所有設定。只需要加上p6spy.config.字首即可。這個和官方的system config設定風格是保持一致的，更多設定詳情如下：

# 指定應用的紀錄檔攔截模組,預設為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(.)?:name=#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)

關於P6spy更多內容，可存取官方倉庫瞭解,以上就是spring boot整合p6spy的最佳實踐的詳細內容，更多關於spring boot整合p6spy的資料請關注it145.com其它相關文章！