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

本文旨在指导开发者如何在 Spring Boot 3 项目中使用 JPA 时，正确配置日志，以便能够清晰地记录 SQL 查询语句以及对应的参数绑定。通过调整 Hibernate 的日志级别，可以帮助开发者更好地理解 JPA 生成的 SQL 语句，并进行调试和优化。

在 Spring Boot 3 中，记录 JPA 查询的 SQL 参数绑定需要对 Hibernate 的日志级别进行特定的配置。与之前的 Spring Boot 版本相比，配置方式有所不同。以下是如何正确配置以查看 SQL 语句及其参数绑定的步骤：

首先，在 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 对类型处理的追踪。它会输出 Hibernate 如何处理 Java 类型和 SQL 类型之间的映射关系。
• logging.level.org.hibernate.stat=debug: 这个配置项负责开启 Hibernate 统计信息的调试输出。虽然它不直接显示参数绑定，但可以提供有关查询执行的有用信息。

示例代码：

假设你有一个简单的 JPA 实体 User：

Quillbot

一款AI写作润色工具，QuillBot的人工智能改写工具将提高你的写作能力。

下载

@Entity
@Table(name = "users")
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;

    private String email;

    // Getters and setters
}

以及一个简单的 JPA 查询：

@Repository
public interface UserRepository extends JpaRepository {

    List findByName(String name);
}

当你调用 userRepository.findByName("John") 时，你将在控制台中看到类似以下的输出（如果配置正确）：

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

注意事项：

• 将日志级别设置为 trace 会产生大量的日志输出，可能会影响性能。建议仅在开发和调试阶段使用。在生产环境中，可以考虑使用较低的日志级别，如 debug 或 info，仅记录关键信息。
• 不同的数据库驱动程序可能对参数绑定的日志输出略有不同。
• 确保你的项目中包含了正确的 Hibernate 依赖。Spring Boot 通常会自动管理这些依赖，但如果遇到问题，请检查你的 pom.xml 或 build.gradle 文件。

总结：

通过正确配置 Hibernate 的日志级别，可以在 Spring Boot 3 项目中轻松地记录 JPA 查询的 SQL 参数绑定。这对于调试和优化 JPA 查询非常有帮助。记住，在生产环境中要谨慎使用 trace 级别，并根据实际情况调整日志级别。希望本教程能帮助你更好地理解和使用 Spring Boot 3 中的 JPA。