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)