本文旨在解决spring boot应用结合`spring-boot-data-source-decorator`和p6spy时，p6spy无法记录insert语句的问题。通过在应用启动前设置p6spy的系统属性`p6spy.config.excludecategories`，可以有效确保包括批量更新在内的所有sql语句被正确记录，从而实现全面的数据库操作日志追踪。
P6Spy与Spring Boot数据源装饰器日志问题解析
在使用P6Spy结合Spring Boot的spring-boot-data-source-decorator进行SQL语句日志记录时，开发者可能会遇到一个常见问题：P6Spy的日志文件（例如spy.log）中仅显示SELECT语句和事务提交（COMMIT）信息，而INSERT、UPDATE等数据修改语句，特别是通过Hibernate等ORM框架执行的批量更新操作，却未能被记录。这给调试和审计数据库操作带来了不便。
P6Spy通过拦截JDBC操作来记录SQL语句。spring-boot-data-source-decorator提供了一种方便的方式在Spring Boot应用中集成P6Spy。通常，我们会通过application.properties或application.yml配置P6Spy的行为，例如启用日志、设置日志格式和输出文件等。
# 启用P6Spy日志 decorator.datasource.p6spy.enable-logging=true # 使用多行格式 decorator.datasource.p6spy.multiline=true # 日志输出到文件 decorator.datasource.p6spy.logging=file # 指定日志文件路径 decorator.datasource.p6spy.log-file=spy.log # 报告包含参数值的SQL字符串 decorator.datasource.p6spy.tracing.include-parameter-values=true
尽管这些配置看起来很全面，但它们可能无法覆盖P6Spy的所有底层行为，特别是与日志类别（categories）相关的过滤规则。P6Spy根据操作类型将日志事件归类，例如statement（普通SQL语句）、batch（批量SQL语句）、commit（事务提交）、result（结果集处理）、info、debug等。如果某些关键类别被默认排除，那么相应的SQL语句就不会被记录。对于批量更新操作，P6Spy通常将其归类到batch类别。
解决方案：通过系统属性配置P6Spy日志类别
问题的根源在于P6Spy可能默认排除了某些包含INSERT语句的日志类别，尤其是当涉及批量更新时。虽然spring-boot-data-source-decorator提供了许多P6Spy的配置选项，但目前它并不直接支持通过application.properties配置P6Spy的excludecategories属性。
解决此问题的有效方法是在Spring Boot应用启动之前，通过Java系统属性明确设置P6Spy的p6spy.config.excludecategories。这将覆盖P6Spy可能存在的默认排除规则，确保包含INSERT语句在内的所有相关SQL操作都被记录。
实施步骤
在您的Spring Boot应用程序的main方法或任何在P6Spy初始化之前执行的代码块中，添加以下系统属性设置：
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class YourApplication {
public static void main(String[] args) {
// 在Spring Boot应用启动前设置P6Spy的排除类别
// 确保 'statement' 和 'batch' 等包含SQL的类别不被排除
System.setProperty("p6spy.config.excludecategories", "info,debug,result");
SpringApplication.run(YourApplication.class, args);
}
}原理解析
p6spy.config.excludecategories属性用于指定P6Spy在日志记录时应排除的事件类别。通过将其设置为"info,debug,result"，我们明确告诉P6Spy：
- 只排除 info、debug和result这三个类别。
- 默认包含所有其他类别，尤其是statement（用于普通SQL语句，包括非批量INSERT/UPDATE）和batch（用于批量SQL语句，如Hibernate的批量更新）。
这样设置后，P6Spy将不再因为默认或隐式地排除了statement或batch类别而遗漏INSERT或批量更新语句的日志。
注意事项与建议
- 执行时机： System.setProperty()必须在P6Spy初始化之前执行。将它放在Spring Boot应用主类的main方法开头是一个可靠的做法。
- “丑陋”的解决方案： 这种通过系统属性强制设置的方式，确实不如直接在application.properties中配置优雅。这是因为spring-boot-data-source-decorator在当前版本中尚未提供直接配置excludecategories的属性。
- 影响范围： 排除info、debug和result类别通常不会影响核心SQL语句的记录。info和debug通常包含P6Spy自身的内部信息，而result则与结果集处理相关，对于追踪SQL执行本身不是必需的。
- 未来展望： 建议关注spring-boot-data-source-decorator项目的更新，未来版本可能会直接支持excludecategories的配置，届时可以切换到更标准的配置方式。
- 日志级别： 确保您的日志框架（如Logback/Log4j2）的日志级别配置允许P6Spy的输出被写入。例如，如果P6Spy配置为输出到文件，请检查文件权限和日志文件的路径。
总结
当P6Spy在Spring Boot应用中未能记录INSERT语句，特别是批量更新时，很可能是由于P6Spy的日志类别过滤机制导致。通过在应用启动前，使用System.setProperty("p6spy.config.excludecategories", "info,debug,result")来明确配置P6Spy的排除类别，可以有效解决此问题，确保所有关键的SQL操作都被正确记录。尽管这是一个临时的解决方案，但在spring-boot-data-source-decorator提供更完善的配置选项之前，它是一个行之有效的方法。
