前言
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是一个JDBC Driver的包装工具,p6spy通过对JDBC Driver的封装以达到对SQL语句的监听和分析,以达到各种目的。
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://xxxspring.datasource.username = xxxspring.datasource.password = xxxspring.datasource.driver-class-name = com.p6spy.engine.spy.P6SpyDriverp6spy.config.appender = com.p6spy.engine.spy.appender.Slf4JLoggerp6spy.config.logMessageFormat = com.p6spy.engine.spy.appender.CustomLineFormatp6spy.config.customLogMessageFormat = executionTime:%(executionTime)| 执行sql:%(sqlSingleLine)
就是这么简单,我们已经集成完了,只需两步即可。启动项目就可以在控制台看到执行的sql语句了
配置智能提示
基于spring boot config meta特性,针对配置做了详细的描述,而且在配置时IDEA会有比较好的提示,如:
兼容原生所有配置项
p6spy-spring-boot-starter兼容原生的所有配置。只需要加上p6spy.config.前缀即可。这个和官方的system config配置风格是保持一致的,更多配置详情如下:
附录: 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)
