spring boot集成p6spy的最佳實踐

Posted on by

前言

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的資料請關註WalkonNet其它相關文章！

推薦閱讀：