p6spy 完整 SQL 打印

前言

P6Spy 是一个框架，无需对现有应用程序进行任何代码更改，即可无缝拦截和记录数据库数据。通过 P6Spy 我们可以对 SQL 语句进行拦截，相当于一个 SQL 语句的记录器，这样我们可以用它来作相关的分析。

一、实现原理

P6Spy 将应用的数据源给劫持了，应用操作数据库其实在调用p6spy的数据源，P6Spy 劫持到需要执行的sql或者hql之类的语句之后，他自己去调用一个 realDatasource，再去操作数据库。

二、p6spy 使用

① 引入依赖

<dependency>
	<groupId>p6spy</groupId>
	<artifactId>p6spy</artifactId>
	<version>3.9.1</version>
</dependency>

② 修改 application.properties

spring:
  datasource:
    driver-class-name: com.p6spy.engine.spy.P6SpyDriver
    type: com.zaxxer.hikari.HikariDataSource
    url: jdbc:p6spy:mysql://xxxx:3306/jw_user?useUnicode=true&characterEncoding=utf-8
    username: xxxx
    password: xxxx

③ 创建 spy.properties

module.log=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 自定义日志打印，路径
logMessageFormat=com.sitech.ep.appinfo.P6SpyLogger.P6spyLogFormat
# 使用日志系统记录sql
appender=com.sitech.ep.appinfo.P6SpyLogger.P6spyLogger
## 配置记录Log例外
excludecategories=info,debug,result,batc,resultset
# 设置使用p6spy driver来做代理
deregisterdrivers=true
# 日期格式
dateformat=yyyy-MM-dd HH:mm:ss
# 实际驱动
driverlist=com.mysql.jdbc.Driver
# 是否开启慢SQL记录
outagedetection=true
# 慢SQL记录标准 秒
outagedetectioninterval=2

④ 创建 spy.properties 的 logMessageFormat 和 appender 对应的类

P6spyLogFormat

package com.sitech.ep.appinfo.P6SpyLogger;

import com.p6spy.engine.spy.appender.MessageFormattingStrategy;
import org.shade.apache.commons.lang3.StringUtils;

public class P6spyLogFormat implements MessageFormattingStrategy {

    /**
     * Sql日志格式化
     *
     * @param connectionId: 连接ID
     * @param now:          当前时间
     * @param elapsed:      花费时间
     * @param category:     类别
     * @param prepared:     预编译SQL
     * @param sql:          最终执行的SQL
     * @param url:          数据库连接地址
     * @return 格式化日志结果
     */
    @Override
    public String formatMessage(int connectionId, String now, long elapsed, String category, String prepared,
        String sql, String url) {
        return StringUtils.isNotBlank(sql) ? " 耗时：" + elapsed + " ms " + now +
                "\n执行SQL: " + sql.replaceAll("[\\s]+", " ") : "";
    }
}

P6spyLogger

package com.sitech.ep.appinfo.P6SpyLogger;

import com.p6spy.engine.logging.Category;
import com.p6spy.engine.spy.appender.FormattedLogger;
import lombok.extern.slf4j.Slf4j;
import org.shade.apache.commons.lang3.StringUtils;

@Slf4j
public class P6spyLogger extends FormattedLogger {

    @Override
    public void logException(Exception e) {
        log.info("", e);
    }

    @Override
    public void logText(String text) {
        log.info(text);
    }

    @Override
    public void logSQL(int connectionId, String now, long elapsed, Category category, String prepared, String sql,
        String url) {
        final String msg = strategy.formatMessage(connectionId, now, elapsed, category.toString(), prepared, sql, url);
        if (StringUtils.isEmpty(msg)) {
            return;
        }
        if (Category.ERROR.equals(category)) {
            log.error(msg);
        } else if (Category.WARN.equals(category)) {
            log.warn(msg);
        } else if (Category.DEBUG.equals(category)) {
            log.debug(msg);
        } else {
            log.info(msg);
        }
    }

    @Override
    public boolean isCategoryEnabled(Category category) {
        if (Category.ERROR.equals(category)) {
            return log.isErrorEnabled();
        } else if (Category.WARN.equals(category)) {
            return log.isWarnEnabled();
        } else if (Category.DEBUG.equals(category)) {
            return log.isDebugEnabled();
        } else {
            return log.isInfoEnabled();
        }
    }
}