如何在 Spring Boot 3 中记录 JPA 查询的 SQL 参数绑定

本文旨在指导开发者如何在 spring Boot 3 项目中使用 JPA 时，配置日志以显示 sql 查询中的参数绑定。通过调整 hibernate 的日志级别，可以清晰地观察到预编译 SQL 语句中的具体参数值，从而方便调试和优化数据库操作。本文提供详细的配置方法，帮助开发者快速实现这一功能。

在 spring boot 3 中，记录 JPA 查询的 SQL 参数绑定与之前的版本略有不同。由于 Hibernate 版本的升级，相关的日志配置也发生了变化。要正确显示参数绑定，需要调整特定的 Hibernate 日志级别。以下是如何在 Spring Boot 3 中配置以记录 SQL 参数绑定的步骤：

配置 application.properties 或 application.yml 文件

在 Spring Boot 项目的 application.properties 或 application.yml 文件中，添加以下配置：

Logging.level.org.hibernate.orm.jdbc.bind=trace logging.level.org.hibernate.type=trace logging.level.org.hibernate.stat=debug

或者，使用 YAML 格式：

logging:   level:     org:       hibernate:         orm:           jdbc:             bind: trace         type: trace         stat: debug

配置项解释：

• logging.level.org.hibernate.orm.jdbc.bind=trace: 这个配置项控制 Hibernate 的 JDBC 绑定相关的日志级别。将其设置为 trace 将会输出所有绑定到预编译 SQL 语句的参数值。
• logging.level.org.hibernate.type=trace: 这个配置项控制 Hibernate 类型处理的日志级别。设置为 trace 可以提供更详细的类型转换信息，有助于理解参数如何被绑定。
• logging.level.org.hibernate.stat=debug: 这个配置项用于启用 Hibernate 的统计信息日志，设置为 debug 可以输出查询的执行时间等信息，有助于性能分析。

注意事项：

• trace 级别的日志会产生大量的输出，建议只在开发和调试阶段使用。在生产环境中，应将其设置为更高级别的日志，如 info 或 warn，以避免性能问题。
• 确保你的项目中已经包含了必要的 JPA 依赖，例如 spring-boot-starter-data-jpa。
• 如果使用了其他的数据库连接池，例如 HikariCP，可能需要配置连接池的日志级别，以便更好地监控数据库连接。

示例代码：

假设我们有一个简单的 JPA 实体 User 和一个对应的 Repository：

@Entity public class User {     @Id     @GeneratedValue(strategy = GenerationType.IDENTITY)     private Long id;     private String name;     private String email;      // Getters and setters }

public interface UserRepository extends JpaRepository<User, Long> {     List<User> findByName(String name); }

当我们调用 userRepository.findByName(“John”) 时，配置了上述日志级别后，控制台将会输出类似于以下的日志信息：

2023-10-27 10:00:00.000 TRACE [main] org.hibernate.orm.jdbc.bind.internal.BindLogHelper - binding parameter [1] as [VARCHAR] - [John] 2023-10-27 10:00:00.000 DEBUG [main] org.hibernate.stat.internal.StatisticsImpl - HHH000117: Second level cache miss: org.example.User Hibernate: select u from User u where u.name=?

从日志中可以清晰地看到参数 John 被绑定到 SQL 查询的第一个参数位置。

总结：

通过配置 logging.level.org.hibernate.orm.jdbc.bind=trace 和 logging.level.org.hibernate.type=trace，可以在 Spring Boot 3 项目中轻松地记录 JPA 查询的 SQL 参数绑定。这对于调试和优化数据库操作非常有帮助。记得在生产环境中调整日志级别，以避免不必要的性能开销。