本文将深入解析Spring Boot中SQL语句打印的多种配置方案，从基础的日志级别设置到高级的格式化输出，帮助开发者快速定位数据库操作问题。通过TRAE IDE的智能调试功能，您可以更直观地分析SQL执行性能。
引言：为什么需要打印SQL语句？
在日常开发中，SQL语句的调试和优化是后端开发者的核心工作之一。无论是排查慢查询、验证ORM框架生成的SQL是否正确，还是进行性能调优，能够清晰地看到应用程序执行的SQL语句都是必不可少的技能。
Spring Boot作为目前最流行的Java开发框架，提供了多种方式来打印和格式化SQL语句。本文将从基础配置到高级技巧，全面解析Spring Boot中SQL打印的各种方案，并结合实际项目经验分享最佳实践。
01｜基础配置：快速开启SQL日志打印
1.1 使用application.properties配置
最基础的SQL打印配置是通过Spring Boot的配置文件实现的。在application.properties中添加以下配置：
# 显示SQL语句
spring.jpa.show-sql=true
# 格式化SQL语句
spring.jpa.properties.hibernate.format_sql=true
# 显示SQL参数
logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE
# 显示SQL查询结果
logging.level.org.hibernate.type.descriptor.sql.BasicExtractor=TRACE1.2 使用application.yml配置
如果你更喜欢YAML格式的配置，可以这样写：
spring:
jpa:
show-sql: true
properties:
hibernate:
format_sql: true
logging:
level:
org:
hibernate:
type:
descriptor:
sql:
BasicBinder: TRACE
BasicExtractor: TRACE💡 TRAE IDE智能提示：在TRAE IDE中编辑配置文件时，智能代码补全功能会自动提示可用的配置项，避免手动输入错误。同时，实时的语法检查可以帮助你及时发现配置问题。
02｜进阶配置：详细的SQL执行信息
2.1 配置完整的Hibernate日志
为了获取更详细的SQL执行信息，我们需要配置Hibernate的日志级别：
logging:
level:
org:
hibernate:
SQL: DEBUG # 打印SQL语句
type: TRACE # 打印参数和结果
springframework:
jdbc: DEBUG # 打印JDBC相关信息2.2 使用日志框架配置
Spring Boot默认使用Logback作为日志框架，我们可以在logback-spring.xml中进行更精细的配置：
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<!-- SQL日志单独输出 -->
<appender name="SQL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>logs/sql.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>logs/sql.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<!-- SQL日志配置 -->
<logger name="org.hibernate.SQL" level="DEBUG" additivity="false">
<appender-ref ref="SQL_FILE"/>
<appender-ref ref="STDOUT"/>
</logger>
<logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" additivity="false">
<appender-ref ref="SQL_FILE"/>
<appender-ref ref="STDOUT"/>
</logger>
<root level="INFO">
<appender-ref ref="STDOUT"/>
</root>
</configuration>2.3 MyBatis的SQL打印配置
如果你的项目使用的是MyBatis框架，配置方式略有不同：
# application.yml
mybatis:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
logging:
level:
com:
example:
mapper: DEBUG # 你的Mapper接口包路径或者使用XML配置：
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<settings>
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
</configuration>03｜实战技巧：优化SQL日志输出
3.1 使用P6Spy进行SQL性能监控
P6Spy是一个强大的SQL监控工具，可以提供详细的SQL执行统计信息：
<!-- pom.xml -->
<dependency>
<groupId>p6spy</groupId>
<artifactId>p6spy</artifactId>
<version>3.9.1</version>
</dependency>配置spy.properties：
module.log=com.p6spy.engine.spy.appender.Slf4JLogger
logMessageFormat=com.p6spy.engine.spy.appender.CustomLineFormat
customLogMessageFormat=%(currentTime) | %(executionTime) ms | %(category) | %(sqlSingleLine)
driverlist=com.mysql.cj.jdbc.Driver修改数据源配置：
spring:
datasource:
driver-class-name: com.p6spy.engine.spy.P6SpyDriver
url: jdbc:p6spy:mysql://localhost:3306/test?useSSL=false&serverTimezone=UTC3.2 自定义SQL日志格式
通过实现自定义的日志格式化器，可以让SQL输出更易读：
@Component
public class CustomSqlFormatter implements Formatter<SqlStatementInfo> {
@Override
public String format(SqlStatementInfo info) {
StringBuilder sb = new StringBuilder();
sb.append("\n========== SQL Execution ==========\n");
sb.append("Time: ").append(LocalDateTime.now()).append("\n");
sb.append("Duration: ").append(info.getTimeElapsed()).append(" ms\n");
sb.append("Statement:\n");
// 格式化SQL语句
String sql = info.getSql();
sql = sql.replaceAll("(?i)SELECT", "\nSELECT");
sql = sql.replaceAll("(?i)FROM", "\nFROM");
sql = sql.replaceAll("(?i)WHERE", "\nWHERE");
sql = sql.replaceAll("(?i)ORDER BY", "\nORDER BY");
sb.append(sql).append("\n");
sb.append("=====================================\n");
return sb.toString();
}
}3.3 条件性SQL打印
在生产环境中，我们通常不需要打印所有的SQL语句。可以通过配置实现条件性打印：
@Configuration
@Profile({"dev", "test"}) // 只在开发和测试环境启用
public class SqlLoggingConfig {
@Bean
public HibernatePropertiesCustomizer hibernatePropertiesCustomizer() {
return properties -> {
properties.put("hibernate.show_sql", true);
properties.put("hibernate.format_sql", true);
properties.put("hibernate.use_sql_comments", true);
};
}
}🔧 TRAE IDE调试功能：利用TRAE IDE的强大调试功能，你可以设置条件断点来捕获特定的SQL执行，比如只监控执行时间超过1秒的慢查询，这对于性能优化非常有帮助。
04｜性能优化：避免SQL日志影响应用性能
4.1 异步日志配置
SQL日志打印可能会影响应用性能，特别是在高并发场景下。使用异步日志可以最小化这种影响：
<appender name="ASYNC_SQL" class="ch.qos.logback.classic.AsyncAppender">
<queueSize>2048</queueSize>
<discardingThreshold>0</discardingThreshold>
<includeCallerData>false</includeCallerData>
<appender-ref ref="SQL_FILE"/>
</appender>4.2 日志级别动态调整
使用Spring Boot Actuator可以动态调整日志级别，无需重启应用：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>配置management endpoints：
management:
endpoints:
web:
exposure:
include: loggers
endpoint:
loggers:
enabled: true然后通过HTTP请求动态调整日志级别：
# 查看当前日志级别
curl http://localhost:8080/actuator/loggers/org.hibernate.SQL
# 修改日志级别为DEBUG
curl -X POST http://localhost:8080/actuator/loggers/org.hibernate.SQL \
-H "Content-Type: application/json" \
-d '{"configuredLevel": "DEBUG"}'05｜常见问题与解决方案
5.1 SQL参数显示为问号?
这是最常见的问题之一，通常是因为没有正确配置参数日志级别：
# 确保包含以下配置
logging:
level:
org:
hibernate:
type:
descriptor:
sql:
BasicBinder: TRACE5.2 日志输出过于冗长
如果SQL日志太多影响问题排查，可以：
- 使用包级别的日志配置，只打印特定包的SQL
- 配置日志过滤器，只记录执行时间超过阈值的SQL
- 使用MDC（Mapped Diagnostic Context）添加请求标识，便于追踪
@Component
public class SqlFilter implements Filter {
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
MDC.put("requestId", UUID.randomUUID().toString());
try {
chain.doFilter(request, response);
} finally {
MDC.clear();
}
}
}5.3 生产环境SQL日志安全
在生产环境中打印SQL日志需要注意安全问题：
@Component
public class SqlLogSanitizer implements HibernatePropertiesCustomizer {
@Override
public void customize(Map<String, Object> hibernateProperties) {
if (isProductionEnvironment()) {
// 生产环境禁用SQL参数打印
hibernateProperties.put("hibernate.show_sql", false);
hibernateProperties.put("hibernate.use_sql_comments", false);
}
}
private boolean isProductionEnvironment() {
return Arrays.asList(environment.getActiveProfiles()).contains("prod");
}
}06｜最佳实践总结
6.1 环境差异化配置
# application-dev.yml
spring:
jpa:
show-sql: true
properties:
hibernate:
format_sql: true
use_sql_comments: true
logging:
level:
org.hibernate.SQL: DEBUG
org.hibernate.type.descriptor.sql.BasicBinder: TRACE
---
# application-prod.yml
spring:
jpa:
show-sql: false
properties:
hibernate:
format_sql: false
use_sql_comments: false
logging:
level:
org.hibernate.SQL: WARN6.2 使用AOP记录SQL执行时间
@Aspect
@Component
public class SqlExecutionTimeAspect {
private static final Logger logger = LoggerFactory.getLogger(SqlExecutionTimeAspect.class);
@Around("@annotation(org.springframework.transaction.annotation.Transactional)")
public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {
long startTime = System.currentTimeMillis();
Object result = joinPoint.proceed();
long endTime = System.currentTimeMillis();
if (endTime - startTime > 1000) { // 记录慢查询
logger.warn("Slow query detected: {} took {} ms",
joinPoint.getSignature(), endTime - startTime);
}
return result;
}
}结语
掌握Spring Boot中SQL打印的各种技巧，对于提高开发效率和系统性能优化都有着重要意义。从基础的日志配置到高级的监控工具，每种方案都有其适用的场景。
🚀 TRAE IDE助力开发：TRAE IDE不仅提供了智能的代码补全和实时的语法检查，其内置的数据库工具插件还能直接查看SQL执行计划，帮助开发者全方位优化数据库性能。结合本文的配置技巧，你将能够更加高效地进行SQL调试和优化工作。
记住，SQL日志打印是一把双刃剑，在开发和测试环境中它是指路明灯，但在生产环境中需要谨慎使用，避免影响系统性能和安全。希望本文的分享能够帮助你在实际项目中更好地运用这些技术。
（此内容由 AI 辅助生成，仅供参考）