P6Spy 组件打印完整 SQL 语句及执行耗时：本地开发推荐，生产环境禁用配置详解

P6Spy 是一款优秀的数据库 SQL 监控和日志组件，能在不修改原有代码的情况下，完整记录应用程序执行的所有 SQL 语句、参数、执行耗时等信息。本文将详细介绍 P6Spy 的核心功能、配置方法、优势，以及如何在本地开发环境中安全使用，同时在生产环境中禁用打印。

1. P6Spy 到底是什么？

P6Spy 是一个开源的 SQL 监控工具，它通过 AOP（Aspect-Oriented Programming）技术，在 JDBC 驱动层对 SQL 执行进行拦截，并记录完整的执行日志。官方仓库：https://github.com/ganadist/p6spy

核心特性：

打印完整 SQL：记录原始 SQL 语句、参数值、执行时间等详细信息
数据库兼容：支持 MySQL、Oracle、PostgreSQL、SQL Server、SQLite 等主流数据库
零侵入式：无需修改业务代码，即可启用数据库访问日志
支持输出格式：支持 JSON、Text、JSONB等多种格式输出
性能监控：记录 SQL 执行耗时、执行次数等指标

它常用于排查 SQL 性能问题、SQL 注入检测、慢 SQL 监控等领域。

2. 为什么选择 P6Spy？

选择 P6Spy 有以下几个核心优势：

精准记录：能打印完整的 SQL 语句、参数值、参数类型、执行耗时等信息，比 logging.level.sql 更详细
零侵入：只需简单配置即可使用，不需要修改业务代码
生产友好：支持动态配置，在生产环境中可通过参数控制是否打印 SQL
多格式支持：支持输出到控制台、文件、JSON 等，方便日志分析
易于集成：与 Spring Boot、Spring 框架无缝集成
本地开发必备：特别适合开发人员排查复杂 SQL 问题

3. 如何安装与配置？

3.1 依赖引入

在 pom.xml 中添加以下依赖：

<dependency>
    <groupId>com.github.ganadist</groupId>
    <artifactId>p6spy-spring-boot-starter</artifactId>
    <version>1.6.0</version>
</dependency>

<!-- 推荐使用该版本，与 Spring Boot 3.x 兼容 -->

3.2 核心配置

在 application.yml（或 application-dev.yml）中添加以下配置：

p6spy:
  # 输出到控制台
  appender: com.github.ganadist.p6spy.output.StdoutLogger
  # 输出格式：TEXT | JSON | JSONB | CSV | TSV
  logging: com.github.ganadist.p6spy.format.FormattingLogger
  # SQL 执行阈值（毫秒），超过此值打印警告
  threshold: 1000
  # 记录到文件（可选）
  fileName: p6spy-%d{yyyy-MM-dd}.log
  # 输出到文件（可选）
  fileAppender: com.github.ganadist.p6spy.output.Slf4jLogger

3.3 完整配置示例

推荐使用 application-dev.yml 专门配置本地开发环境：

# 本地开发环境配置（推荐）
p6spy:
  appender: com.github.ganadist.p6spy.output.StdoutLogger
  logging: com.github.ganadist.p6spy.format.FormattingLogger
  threshold: 500   # 500ms 以上打印警告
  multiline: true  # 每条 SQL 单独输出一行

# 生产环境配置
p6spy:
  appender: com.github.ganadist.p6spy.output.NoOpLogger  # 禁止打印
  logging: com.github.ganadist.p6spy.format.FormattingLogger

3.4 动态开关配置（推荐生产环境使用）

在 application.yml 中添加以下配置，支持通过环境变量动态控制：

p6spy:
  appender: com.github.ganadist.p6spy.output.StdoutLogger   # 默认打印
  # 生产环境可通过参数 -Dp6spy.appender=com.github.ganadist.p6spy.output.NoOpLogger 动态禁用

4. 本地开发 vs 生产环境配置详解

4.1 本地开发环境配置（推荐）

创建 application-dev.yml 文件：

spring:
  profiles:
    active: dev

p6spy:
  appender: com.github.ganadist.p6spy.output.StdoutLogger
  logging: com.github.ganadist.p6spy.format.FormattingLogger
  threshold: 100   # 100ms 以上打印警告
  multiline: true

在启动时指定配置文件：

# 启动开发环境
java -jar app.jar --spring.profiles.active=dev

# 或通过参数动态禁用
java -jar app.jar -Dp6spy.appender=com.github.ganadist.p6spy.output.NoOpLogger

4.2 生产环境配置（严格禁用）

在 application-prod.yml 或 application.yml 中禁用打印：

p6spy:
  appender: com.github.ganadist.p6spy.output.NoOpLogger   # 生产环境禁止打印 SQL
  logging: com.github.ganadist.p6spy.format.FormattingLogger
  threshold: 10000  # 即使开启也无实际效果

重要提示：生产环境中始终禁止打印 SQL，防止敏感信息泄露。

5. 实战使用示例

5.1 查看 SQL 执行记录

启动应用后，在控制台或日志文件中可以看到类似以下输出：

2024-08-22 10:00:00.123  INFO [main] P6Spy - 2024-08-22 10:00:00,123 | 1 | com.mysql.cj.jdbc.Driver | 0.012s | SELECT * FROM users WHERE id = 1
2024-08-22 10:00:00.456  INFO [main] P6Spy - 2024-08-22 10:00:00,456 | 1 | com.mysql.cj.jdbc.Driver | 0.034s | SELECT * FROM orders WHERE user_id = 1

5.2 格式化输出示例（JSON）

若配置为输出 JSON 格式，日志会以结构化格式输出：

{
  "executionTime": 0.012,
  "sql": "SELECT * FROM users WHERE id = 1",
  "parameters": [1],
  "databaseType": "MySQL"
}

6. 使用注意事项与最佳实践

6.1 本地开发推荐配置

使用 application-dev.yml
设置阈值 100~500ms 打印警告
启用 multiline: true 使每条 SQL 单独输出
输出到控制台（控制台日志）

6.2 生产环境严格禁用

始终使用 NoOpLogger 禁用打印
避免生产环境开启 SQL 日志
建议通过环境变量或部署参数动态控制

6.3 性能注意事项

P6Spy 本身有一定性能损耗，在高并发场景下建议开启
建议在开发环境使用，生产环境禁用
可通过阈值设置，只打印慢 SQL

7. 总结

P6Spy 是一款优秀的数据库 SQL 监控组件，特别适合本地开发环境使用。通过简单配置即可打印完整的 SQL 语句、参数值和执行耗时信息，帮助开发者快速排查 SQL 性能问题和排查复杂业务逻辑。

在生产环境中，始终推荐禁用打印，避免数据泄露风险。

推荐阅读：

官方文档：https://github.com/ganadist/p6spy
GitHub 仓库：https://github.com/ganadist/p6spy

本文由 Clarity 学习台 AI 助手生成