个人名片

🎓作者简介：java领域优质创作者
🌐个人主页：码农阿豪
📞工作室：新空间代码工作室（提供各种软件服务）
💌个人邮箱：[2435024119@qq.com]
📱个人微信：15279484656
🌐个人导航网站：www.forff.top
💡座右铭：总有人要赢。为什么不能是我呢？

• 专栏导航：

码农阿豪系列专栏导航
面试专栏：收集了java相关高频面试题，面试实战总结🍻🎉🖥️
Spring5系列专栏：整理了Spring5重要知识点与实战演练，有案例可直接使用🚀🔧💻
Redis专栏：Redis从零到一学习分享，经验总结，案例实战💐📝💡
全栈系列专栏：海纳百川有容乃大，可能你想要的东西里面都有🤸🌱🚀

如何避免日志中打印SQL语句：完整解决方案

在日常的 Java 开发中，日志是我们调试、排查问题的重要工具。然而，有时候在日志中我们会看到大量的 SQL 语句，这些日志不仅会增加日志文件的体积，还可能泄露敏感信息或者占用不必要的资源。因此，在某些情况下，我们希望能够屏蔽这些 SQL 语句。那么如何做到这一点呢？本文将为大家详细介绍几种避免日志中打印 SQL 语句的方法，以及这些方法的具体实现步骤。

一、为什么要避免 SQL 日志

在探讨具体解决方案之前，我们先来看看为什么有时候我们不希望看到 SQL 日志：

1. 日志污染：SQL 日志通常很长，会让日志文件变得混乱，不容易找到真正有用的信息。
2. 性能问题：记录 SQL 语句，尤其是在大量请求的情况下，会显著增加 I/O 开销，对性能有负面影响。
3. 安全性：某些 SQL 语句中可能包含敏感数据（如用户 ID、密码等），将这些信息记录在日志中可能会带来安全风险。

针对以上问题，我们可以通过配置日志框架、调整数据源设置等方式来禁用或屏蔽 SQL 日志。

二、禁用 SQL 日志的几种方法

1. 通过修改日志框架配置

大多数 Java 应用程序使用的日志框架都是 Logback、Log4j 或其他 SLF4J 兼容的日志框架。这些框架允许我们对特定的日志源进行配置，从而控制日志的输出内容。如果你使用的是 Spring Boot，那么默认的日志实现是 Logback。下面我们来看看如何通过修改日志框架配置来禁用 SQL 日志。

1.1 修改 Logback 配置

假设我们使用的是 Logback 日志框架，可以在项目中添加或修改 logback-spring.xml 文件，并将 SQL 相关的日志级别设置为 OFF。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 针对 JDBC 操作禁用 SQL 日志 -->
    <logger name="java.sql" level="OFF" />
    <logger name="org.hibernate.SQL" level="OFF" />
    <logger name="org.mybatis" level="OFF" /> <!-- 如果使用 MyBatis，可以禁用其 SQL 日志 -->

    <root level="INFO">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

在这个配置中，我们通过将 java.sql、org.hibernate.SQL 以及 org.mybatis 等与 SQL 相关的包的日志级别设置为 OFF，确保 SQL 语句不会被记录到日志中。这种方式简单高效，适用于大多数情况。

1.2 修改日志级别

如果不想完全禁用 SQL 日志，而是只在出现异常时记录日志，可以调整 SQL 日志的级别。通常，将日志级别设置为 WARN 或 ERROR 是一个合理的选择，这样只有在 SQL 发生错误时才会打印日志：

# application.yml 中配置
logging:
  level:
    java.sql: ERROR
    org.hibernate.SQL: ERROR  # 对于 Hibernate SQL 日志设置为 ERROR

2. 禁用 Hibernate 或 JPA 的 SQL 日志

如果你的项目使用了 JPA（如 Hibernate），通常默认情况下会打印 SQL 日志。我们可以通过 JPA 的配置来禁用 SQL 日志输出：

spring:
  jpa:
    show-sql: false
    properties:
      hibernate:
        format_sql: false
        use_sql_comments: false
        generate_statistics: false

这些配置项确保 Hibernate 不会输出 SQL 语句到日志中，同时也减少了日志的冗余信息。

3. 通过数据库连接池配置禁用 SQL 日志

在使用数据库连接池（如 HikariCP、Druid、C3P0 等）时，这些连接池通常也会输出 SQL 日志。可以通过配置连接池来禁用 SQL 相关日志：

3.1 HikariCP 配置示例

spring:
  datasource:
    hikari:
      pool-name: myHikariPool
      leak-detection-threshold: 2000

HikariCP 自身的 SQL 日志通常可以通过控制连接池泄露检测等机制来控制其输出。

3.2 Druid 配置示例

spring.datasource.druid.filter.stat.log-enabled=false

Druid 提供了 SQL 统计日志的开关，可以直接通过 log-enabled 参数来关闭相关日志输出。

4. 修改代码中的日志逻辑

在某些情况下，我们可能无法完全依赖配置文件来禁用 SQL 日志输出。此时，可以在代码中手动控制 SQL 执行的日志记录，确保只记录自己想要的信息。例如：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class DatabaseService {
    private static final Logger logger = LoggerFactory.getLogger(DatabaseService.class);

    public void executeQuery(String sql) {
        try (Statement statement = connection.createStatement();
             ResultSet resultSet = statement.executeQuery(sql)) {

            // 手动记录 SQL 语句
            if (logger.isInfoEnabled()) {
                logger.info("Executing SQL: {}", sql);
            }

            // 处理 ResultSet ...
        } catch (SQLException e) {
            logger.error("Error executing SQL: {}", sql, e);
        }
    }
}

通过这种方式，可以精细控制 SQL 语句的日志记录。你可以选择在某些场景记录 SQL（如开发环境），而在其他环境（如生产环境）禁用这些日志。

5. 使用日志管理平台进行过滤

如果你的日志已经接入了集中式日志管理平台（如 ELK、Graylog 或 Grafana Loki 等），你还可以通过日志平台自定义日志过滤规则。在这些平台中，可以根据日志的特征（如包含 “SELECT”、“UPDATE” 等关键字）进行过滤，从而确保 SQL 日志不会被显示出来。

这种方法需要有完善的日志管理平台支持，但它有很高的灵活性和可操作性，适用于大规模应用的集中日志管理场景。

三、如何选择最适合的方案？

避免 SQL 日志的输出有多种方式，那么在实际项目中该如何选择呢？

1. 针对全局的日志禁用：如果你希望在整个项目中完全禁用 SQL 日志，那么修改日志框架的配置（如 Logback 配置）是最直接的方法。这种方式简单高效，可以快速实现效果。

2. 针对特定包或类的日志禁用：如果你只希望在特定模块或类中禁用 SQL 日志，可以通过调整日志级别或在代码中手动记录日志来实现。这样可以更加精细地控制日志的输出。

3. 结合日志管理平台过滤：如果你使用了集中式日志管理平台，并且希望灵活管理日志输出，建议在平台上设置日志过滤规则。这种方式可以应对复杂的应用场景，并且不需要修改代码或配置文件。

四、总结

在 Java 应用程序中，日志记录是不可或缺的调试工具，但并非所有日志都是有用的。对于 SQL 日志，特别是在生产环境中，我们往往不希望看到大量的 SQL 执行信息。通过调整日志框架配置、修改数据库连接池设置或手动控制日志输出，我们可以有效屏蔽 SQL 日志，从而保持日志的整洁、提高应用性能。

希望本文的介绍能帮助大家根据项目实际情况选择最合适的方案，有效避免 SQL 日志的输出。通过合理的日志配置，你可以在保证安全性和性能的同时，更加高效地管理系统日志。