SpringBoot 使用 p6spy 打印完整 SQL

发表于 分类于 ， Valine：

P6Spy 介绍

P6Spy 是一个可以用来在应用程序中拦截和修改数据操作语句的开源框架。

通过 P6Spy 我们可以对 SQL 语句进行拦截，相当于一个 SQL 语句的记录器，这样我们可以用它来作相关的分析，比如性能分析。

  • 文档：https://p6spy.readthedocs.io/
  • GitHub：https://github.com/p6spy/p6spy

依赖引入

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

P6Spy 参数

formatMessage 参数

  • connectionId：连接数据库的 ID
  • now：当前 time 的毫秒数
  • elapsed：操作完成所需的时间（以毫秒为单位）
  • category：操作的类别
  • prepared：将所有绑定变量替换为实际值的 SQL 语句
  • SQL：执行的 sql 语句
  • url：执行 sql 语句的数据库 URL

使用 P6Spy

  1. 引入 P6Spy 的依赖。

  2. 更换数据库连接驱动。

    数据库驱动将 com.mysql.jdbc.Driver 替换为 com.p6spy.engine.spy.P6SpyDriver，然后在 url 中的按下面的格式加入 p6spy 即可。

    # 更换前
spring.datasource.second.driverClassName=com.mysql.cj.jdbc.Driver
spring.datasource.second.jdbc-url=jdbc:mysql://127.0.0.1:3306/test?serverTimezone=UTC

# 更换后
spring.datasource.second.driverClassName=com.p6spy.engine.spy.P6SpyDriver
spring.datasource.second.jdbc-url=jdbc:p6spy:mysql://127.0.0.1:3306/test?serverTimezone=UTC

  3. 添加配置文件 spy.properties。

    # 单行日志
logMessageFormat=com.p6spy.engine.spy.appender.SingleLineFormat
# 使用Slf4J记录sql
appender=com.p6spy.engine.spy.appender.Slf4JLogger
# 是否开启慢SQL记录
outagedetection=true
# 慢SQL记录标准，单位秒
outagedetectioninterval=2
#日期格式
dateformat=yyyy-MM-dd HH:mm:ss

效果如下：

com.p6spy.engine.spy.appender.SingleLineFormat 单行日志：

2020-12-28 14:17:44.493  INFO 87484 --- [           main] p6spy                                    : 2020-12-28 14:17:44|11|statement|connection 19|url jdbc:p6spy:mysql://127.0.0.1:3306/test?serverTimezone=UTC|SELECT  id,author,description,title  FROM book     WHERE (author >= ?)|SELECT  id,author,description,title  FROM book     WHERE (author >= 'author0')

com.p6spy.engine.spy.appender.MultiLineFormat 多行日志：

2020-12-28 14:24:00.087  INFO 42092 --- [           main] p6spy                                    : #2020-12-28 14:24:00 | took 11ms | statement | connection 19| url jdbc:p6spy:mysql://127.0.0.1:3306/test?serverTimezone=UTC
SELECT  id,author,description,title  FROM book 
 
 WHERE (author >= ?)
SELECT  id,author,description,title  FROM book 
 
 WHERE (author >= 'author0');

自定义输出格式

自定义格式

appender=com.p6spy.engine.spy.appender.StdoutLogger
dateformat=yyyy-MM-dd HH:mm:ss
logMessageFormat=com.p6spy.engine.spy.appender.CustomLineFormat
customLogMessageFormat=%(currentTime) | %(executionTime) ms | %(sqlSingleLine)

自定义类

在 spy.properties 配置文件中进行配置：

# 自定义输出格式
logMessageFormat=com.jueee.config.P6SpyLogger

其中，P6SpyLogger 类的实现如下：

import com.p6spy.engine.spy.appender.MessageFormattingStrategy;

import java.text.SimpleDateFormat;
import java.util.Date;

public class P6SpyLogger implements MessageFormattingStrategy {

    private SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss:SSS");

    @Override
    public String formatMessage(int connectionId, String now, long elapsed, String category, String prepared, String sql, String url) {
        return !"".equals(sql.trim()) ? this.format.format(new Date()) + " | took " + elapsed + "ms | " + category + " | connection " + connectionId + "\n " + sql + ";" : "";
    }
}

执行结果如下：

2020-12-28 14:39:27.947  INFO 102272 --- [           main] p6spy                                    : 2020-12-28 14:39:27:947 | took 11ms | statement | connection 19
 SELECT  id,author,description,title  FROM book 
 
 WHERE (author >= 'author0');

支持配置项

# 指定应用的日志拦截模块,默认为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)
相关文章