SpringBoot3集成P6Spy实现SQL可视化调试

1. 项目概述：SpringBoot3下的SQL调试新范式

在传统Java开发中，调试SQL语句就像戴着墨镜找钥匙——明明知道问题在哪，却总是看不真切。我们习惯了在日志里翻找那些被问号替换的预编译SQL，再手动拼接参数值，这种低效的调试方式已经成为开发者的集体痛点。最近在SpringBoot3项目中，我实践出一套完整的SQL可视化调试方案，让SQL调试从"盲人摸象"变成"高清直播"。

这套方案的核心价值在于：

• 实时还原完整可执行的SQL语句
• 直观展示参数绑定前后的SQL形态
• 无缝集成MyBatis-Plus等主流ORM框架
• 零侵入现有业务代码

举个实际场景：当你在处理一个多表联查的复杂分页查询时，传统方式可能需要10分钟才能确认SQL是否正确拼接，而新方法让这个时间缩短到10秒。这不仅仅是效率的提升，更是开发体验的质变。

2. 技术选型与原理剖析

2.1 为什么选择P6Spy作为基础组件

在技术选型阶段，我对比了多种SQL拦截方案：

• HikariCP的日志输出：只能看到参数占位符
• Druid的SQL防火墙：功能过于重型
• P6Spy：轻量级且支持SQL改写

最终选择P6Spy 3.9.1版本，因为它具备以下优势：

1. 通过JDBC驱动包装机制实现无侵入拦截
2. 支持自定义SQL格式化输出
3. 与SpringBoot3的自动配置完美兼容
4. 性能损耗可控（实测增加约3%的查询耗时）

核心工作原理如图：

code复制应用代码 → P6Spy驱动 → 真实JDBC驱动 → 数据库
            ↑
        拦截并增强SQL

2.2 MyBatis-Plus的增强整合

对于使用MyBatis-Plus的项目，需要特别注意：

java复制@Configuration
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 必须关闭MP自带的SQL打印
        interceptor.setProperties(Collections.singletonMap("sqlParser", "false"));
        return interceptor;
    }
}

这个配置避免了与P6Spy的打印功能冲突。同时建议使用MyBatis-Plus 3.5.3+版本，其对SpringBoot3的支持最完善。

3. 完整实现步骤

3.1 基础环境搭建

首先在pom.xml中添加依赖：

xml复制<dependency>
    <groupId>com.github.gavlyukovskiy</groupId>
    <artifactId>p6spy-spring-boot-starter</artifactId>
    <version>1.9.0</version>
</dependency>

然后在application.yml中配置：

yaml复制spring:
  datasource:
    driver-class-name: com.p6spy.engine.spy.P6SpyDriver
    url: jdbc:p6spy:mysql://localhost:3306/demo

3.2 高级配置定制

创建spy.properties文件实现深度定制：

properties复制# 输出完整SQL（包含参数值）
p6spy.appender=com.p6spy.engine.logging.appender.StdoutLogger
# 日期格式
p6spy.dateformat=yyyy-MM-dd HH:mm:ss.SSS
# 实际执行SQL输出格式
p6spy.logMessageFormat=com.p6spy.engine.spy.appender.MultiLineFormat
# 显示执行耗时
p6spy.executionThreshold=10
# 排除特定表的监控（如系统表）
p6spy.exclude=mysql.*, information_schema.*

3.3 日志美化方案

默认输出可能不够直观，我们可以自定义LogMessageFormat：

java复制public class CustomSqlFormat implements MessageFormattingStrategy {
    @Override
    public String formatMessage(...) {
        return String.format("\n=== SQL执行监控 ===\n" +
               "耗时：%s ms\n" +
               "原始SQL：%s\n" +
               "最终SQL：%s\n" +
               "参数：%s\n",
               elapsed, sql, preparedSql, parameters);
    }
}

在spy.properties中启用：

properties复制p6spy.logMessageFormat=com.example.CustomSqlFormat

4. 生产环境最佳实践

4.1 性能优化方案

虽然P6Spy很轻量，但在高并发场景仍需注意：

1. 使用过滤规则排除健康检查等简单查询

   properties复制p6spy.filter=true
   p6spy.filter.include=select*,update*,insert*,delete*
   

2. 设置执行时间阈值，只记录慢查询

   properties复制p6spy.executionThreshold=100
   

3. 采用异步日志输出

   properties复制p6spy.appender=com.p6spy.engine.logging.appender.AsyncLogger
   

4.2 安全注意事项

SQL日志可能暴露敏感信息，建议：

1. 对特定字段进行脱敏处理

   java复制public String formatMessage(...) {
       return sql.replaceAll("password='.*?'", "password='***'");
   }
   

2. 生产环境关闭敏感SQL打印

   yaml复制spring:
     profiles: prod
     p6spy:
       enabled: false
   

5. 疑难问题解决方案

5.1 常见报错处理

问题1：启动时报"Unable to load driver class"

• 检查依赖冲突，确保没有其他数据源starter
• 确认url前缀为jdbc:p6spy:

问题2：SQL日志中出现两次打印

• 检查是否同时开启了MyBatis和P6Spy的日志
• 在logback.xml中排除相关logger：

  xml复制<logger name="org.mybatis" level="OFF"/>
  

5.2 高级调试技巧

对于复杂SQL优化，可以：

1. 使用执行计划标记

   properties复制p6spy.custom.logMessageFormat=com.p6spy.engine.spy.appender.ExplainFormat
   

2. 结合Arthas实时监控

   bash复制watch com.p6spy.engine.spy.P6SpyDriver * '{params,returnObj}' -x 3
   

6. 效果对比与性能数据

6.1 调试效率对比

6.2 性能影响测试

在4核8G的测试环境（TPS=1000）下：

这套方案在开发环境带来的效率提升远大于其微小的性能损耗。对于生产环境，建议通过条件化配置灵活启用。