告别MyBatis日志拼接：用p6spy-spring-boot-starter 1.9.0一键输出完整可执行SQL

告别MyBatis日志拼接：用p6spy-spring-boot-starter 1.9.0一键输出完整可执行SQL

调试SQL是每个Java后端开发者的日常必修课。当你在凌晨三点盯着控制台里MyBatis输出的Preparing:和Parameters:，试图在脑海中拼接出完整SQL时，是否想过——为什么2023年了，我们还要像考古学家拼接陶片一样手动组合SQL语句？

1. 为什么需要SQL完整输出工具

在典型的企业级Java应用中，数据库操作可能占到代码量的30%-40%。而调试这些操作时，开发者面临三大痛点：

1. 日志碎片化：MyBatis默认日志将SQL模板与参数分离，需要人工拼接
2. 格式混乱：多行SQL被拆分成单行日志，复杂查询难以阅读
3. 执行障碍：无法直接复制日志中的SQL到数据库客户端执行

以下是一个典型的MyBatis日志输出示例：

2023-07-20 14:30:15 DEBUG UserMapper.selectByCondition - ==> Preparing: SELECT * FROM users WHERE name LIKE ? AND status = ? 2023-07-20 14:30:15 DEBUG UserMapper.selectByCondition - ==> Parameters: %张%(String), 1(Integer)

p6spy的出现彻底改变了这种状况。作为数据库访问的动态监测框架，它能在不修改业务代码的情况下，拦截并记录完整的SQL语句。最新版的p6spy-spring-boot-starter 1.9.0更是通过Spring Boot自动配置机制，将集成成本降到最低。

2. 五分钟快速集成指南

2.1 依赖配置

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

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

注意：无需单独引入p6spy核心包，starter已包含所有必要依赖

2.2 数据源配置调整

修改application.yml中的数据库连接配置：

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

关键改动点：

• 在原JDBC URL前添加jdbc:p6spy:前缀
• 驱动类改为P6SpyDriver

2.3 基础配置示例

创建spy.properties文件：

# 启用MyBatis Plus的日志格式 logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger # 输出到控制台 appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger # 日期格式 dateformat=yyyy-MM-dd HH:mm:ss # 慢SQL阈值(毫秒) outagedetectioninterval=1000

启动应用后，你将看到格式化的完整SQL输出：

SELECT * FROM users WHERE name LIKE '%张%' AND status = 1

3. 高级定制技巧

3.1 自定义输出格式

实现MessageFormattingStrategy接口可以完全控制日志格式：

public class CustomSqlFormat implements MessageFormattingStrategy { @Override public String formatMessage(int connectionId, String now, long elapsed, String category, String prepared, String sql, String url) { return String.format("[%s] [%dms] %s", LocalTime.now().format(DateTimeFormatter.ISO_TIME), elapsed, sql.replaceAll("\\s+", " ")); } }

配置文件中指定自定义类：

logMessageFormat=com.example.CustomSqlFormat

3.2 多环境控制

通过Spring Profile实现环境隔离：

spring: profiles: dev datasource: url: jdbc:p6spy:mysql://localhost:3306/demo spring: profiles: prod datasource: url: jdbc:mysql://prod-db:3306/demo

3.3 性能优化建议

1. 生产环境注意事项：

   • 关闭非必要的日志类别：excludecategories=info,debug,batch
   • 增大慢SQL阈值：outagedetectioninterval=5000
   • 使用异步日志输出

2. 日志文件分离配置：

appender=com.p6spy.engine.spy.appender.FileLogger logfile=sql.log

4. 与其他方案的对比

实际项目中，我们团队在引入p6spy后，SQL调试效率提升了约60%。特别是在处理复杂动态SQL时，不再需要反复在IDE和数据库客户端之间切换。