解决Spring Boot与P6Spy集成时INSERT语句不记录的问题

本文旨在解决spring boot应用结合`spring-boot-data-source-decorator`和p6spy时，p6spy无法记录`insert`语句，尤其是批量操作的问题。核心解决方案是通过设置java系统属性`p6spy.config.excludecategories`来覆盖p6spy的默认日志排除类别，从而确保所有sql操作（包括`insert`）都能被正确捕获并记录。文章将提供详细的配置步骤和注意事项。

P6Spy在Spring Boot中不记录INSERT语句的排查与解决

在使用P6Spy与Spring Boot及spring-boot-data-source-decorator进行数据源日志记录时，开发者可能会遇到一个常见问题：P6Spy无法记录INSERT语句，尤其是当应用程序执行批量插入操作时。日志中可能只出现SELECT语句或事务提交（COMMIT）记录，而关键的INSERT语句却缺失。

问题分析

P6Spy作为一个SQL日志工具，其行为高度依赖于其内部配置。当它与spring-boot-data-source-decorator结合使用时，P6Spy的某些默认配置可能会导致特定类别的SQL事件被排除在日志之外。经验表明，批量更新操作（包括批量插入）通常被P6Spy归类到某些默认被排除的日志类别中，例如info、debug或result。由于spring-boot-data-source-decorator在当前版本中可能没有直接暴露配置P6Spy的excludecategories的选项，因此需要一种间接的方式来覆盖这些默认设置。

解决方案

解决此问题的核心思路是在P6Spy初始化之前，通过Java系统属性明确指定不排除任何日志类别，或者至少不排除可能包含INSERT语句的类别。

具体操作是在应用程序启动时，设置p6spy.config.excludecategories系统属性。

System.setProperty("p6spy.config.excludecategories", ""); // 不排除任何类别
// 或者，如果只想排除特定的，例如 "info,debug,result"
// System.setProperty("p6spy.config.excludecategories", "info,debug,result");

关键点： 这行代码必须在P6Spy的配置被加载和初始化之前执行。最可靠的位置通常是Spring Boot应用程序的main方法的最开始，或者在任何P6Spy相关的配置类被加载之前。

示例：在Spring Boot主类中设置

AI建筑知识问答

用人工智能ChatGPT帮你解答所有建筑问题

22

查看详情

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {

    public static void main(String[] args) {
        // 在SpringApplication.run()之前设置P6Spy系统属性
        System.setProperty("p6spy.config.excludecategories", ""); 
        // 或者根据需要设置："info,debug,result" 等，确保不排除 INSERT 相关的类别

        SpringApplication.run(MyApplication.class, args);
    }
}

通过将p6spy.config.excludecategories设置为空字符串，我们指示P6Spy不要排除任何默认的日志类别。如果P6Spy的默认行为是排除info、debug、result等类别，而这些类别又包含了批量更新事件，那么设置为空字符串将允许这些事件被记录。

P6Spy与spring-boot-data-source-decorator配置示例

为了确保P6Spy能够正确地将日志输出到文件，您还需要在application.properties或application.yml中进行相应的配置。以下是一个典型的application.properties配置示例：

# 启用 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

# 如果需要自定义日志格式或过滤器，可以配置以下项
# decorator.datasource.p6spy.log-format=
# decorator.datasource.p6spy.log-filter.pattern=

通过上述配置，P6Spy会将SQL日志输出到spy.log文件。结合之前设置的系统属性，INSERT语句现在应该能够被正确记录。

注意事项与总结

1. 系统属性的优先级： System.setProperty设置的属性通常具有较高的优先级，能够在P6Spy内部配置加载之前生效，从而覆盖其默认行为。
2. “丑陋”的解决方案： 这种通过系统属性覆盖的方式，在一定程度上可以被视为一种“权宜之计”或“不够优雅”的解决方案，因为它绕过了spring-boot-data-source-decorator可能没有直接提供的P6Spy配置选项。理想情况下，spring-boot-data-source-decorator应该提供更完善的P6Spy配置入口。
3. 性能考量： 强制记录所有SQL类别可能会增加日志量，尤其是在高并发或大量数据操作的生产环境中。这可能对应用程序的性能和磁盘I/O产生轻微影响。在生产环境部署时，请根据实际需求权衡日志的详细程度和性能开销。
4. P6Spy官方文档： 建议定期查阅P6Spy的官方文档，了解其最新的配置选项和最佳实践。随着库的更新，可能会有更直接、更优雅的配置方式出现。
5. 验证： 在实施此解决方案后，务必运行应用程序并检查spy.log文件，确认INSERT语句是否已正确记录。

通过理解P6Spy的日志分类机制以及如何在Spring Boot环境中有效地干预其配置，可以解决SQL语句（特别是INSERT）不被记录的问题，从而为开发和调试提供更全面的SQL操作视图。

以上就是解决Spring Boot与P6Spy集成时INSERT语句不记录的问题的详细内容，更多请关注php中文网其它相关文章！