Spring Boot 打印SQL日志常见问题有哪些？

Question

**问题：Spring Boot 中如何正确配置打印 SQL 日志？** 在使用 Spring Boot 开发时，开发者常常需要查看执行的 SQL 语句以进行调试或优化。然而，很多开发者在配置打印 SQL 日志时会遇到问题，例如日志不输出、日志格式不完整、或仅打印语句不打印参数等。常见的问题包括：未正确配置日志框架（如 Logback 或 Log4j2）、未启用 JPA 的 SQL 输出、未格式化 SQL 语句、或使用了错误的日志级别（如 info 误写成 debug）。此外，当使用连接池（如 HikariCP）或 MyBatis 等 ORM 框架时，还需额外配置相关属性。如何正确配置 Spring Boot 以完整、清晰地打印 SQL 日志，是开发调试过程中常见的技术问题。

Answer 1

一、问题背景与重要性

在使用 Spring Boot 开发数据库相关的应用时，查看执行的 SQL 语句是调试和性能优化的重要手段。然而，在实际开发中，很多开发者常常遇到日志不输出、SQL 语句格式混乱、参数未打印等问题。这些问题往往源于日志框架配置不当、SQL 输出未启用、或 ORM 框架（如 JPA、MyBatis）配置缺失。

正确配置 SQL 日志输出，不仅有助于排查问题，还能提升代码质量与性能优化效率。本文将从基础配置到高级技巧，逐步深入探讨如何在 Spring Boot 中正确配置 SQL 日志输出。

• 日志框架的正确选择与配置（Logback / Log4j2）
• JPA / Hibernate 的 SQL 输出配置
• MyBatis 的 SQL 日志配置
• 连接池（如 HikariCP）与日志的协同配置
• SQL 参数的打印与格式化

二、日志框架的选择与配置

Spring Boot 默认使用 Logback 作为日志框架。若需使用 Log4j2，需排除默认依赖并引入相应依赖。

<!-- Maven 配置示例：使用 Log4j2 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

Logback 配置文件示例：

<configuration>
    <logger name="org.hibernate.SQL" level="DEBUG"/>
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE"/>
</configuration>

三、JPA / Hibernate 的 SQL 输出配置

在 Spring Boot 中启用 JPA 的 SQL 输出，需在 application.properties 或 application.yml 中进行如下配置：

配置项	说明
spring.jpa.show-sql=true	启用 SQL 输出
spring.jpa.properties.hibernate.format_sql=true	格式化 SQL 输出
logging.level.org.hibernate.SQL=DEBUG	设置日志级别为 DEBUG
logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE	打印 SQL 参数值

YAML 配置示例：

spring:
  jpa:
    show-sql: true
    properties:
      hibernate:
        format_sql: true
logging:
  level:
    org.hibernate.SQL: DEBUG
    org.hibernate.type.descriptor.sql.BasicBinder: TRACE

四、MyBatis 的 SQL 输出配置

对于使用 MyBatis 的项目，需配置 MyBatis 自带的日志插件或集成日志框架。

mybatis:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

也可以使用 Logback 或 Log4j2 来输出日志：

logging.level.com.example.mapper=DEBUG

其中 com.example.mapper 是你的 Mapper 包路径。MyBatis 支持通过日志框架输出完整的 SQL 语句及参数。

五、连接池配置与 SQL 日志的关系

虽然连接池（如 HikariCP）本身不负责 SQL 输出，但某些连接池提供了日志拦截功能。例如，HikariCP 可以结合 P6Log 或 log4jdbc 实现 SQL 拦截。

spring:
  datasource:
    url: jdbc:p6spy:postgresql://localhost:5432/mydb
    driver-class-name: com.p6spy.engine.spy.P6SpyDriver

同时需配置 P6Spy 的配置文件 p6spy.properties：

module.log=com.p6spy.engine.logging.P6LogFactory
module.outage=com.p6spy.engine.outage.P6OutageFactory
appender=com.p6spy.engine.spy.appender.StdoutLogger

六、SQL 参数打印与格式化

仅打印 SQL 语句而不打印参数，无法有效调试。Hibernate 中通过 BasicBinder 打印参数，MyBatis 则可通过日志级别控制。

logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE

输出示例：

Hibernate: 
    select
        user0_.id as id1_0_,
        user0_.name as name2_0_
    from
        users user0_
    where
        user0_.id=?
TRACE  o.h.t.d.s.BasicBinder - binding parameter [1] as [BIGINT] - [1]

七、总结与进阶建议

本章介绍了 Spring Boot 中如何正确配置 SQL 日志输出，涵盖 Logback、Log4j2、JPA、MyBatis 及连接池的配置方式。对于中高级开发者，建议结合日志分析工具（如 ELK Stack、Graylog）集中管理 SQL 日志。

此外，生产环境中应避免开启 TRACE 级别日志，以免影响性能。可使用日志开关动态控制日志级别。