Spring boot中 限制 Mybatis SQL日志的大字段输出

由于现有的项目框架中,针对MyBatis的SQL日志,会完整的输出sql语句及参数内容。

存在对longtext、clob等大字段,在执行INSERT、UPDATA语句中,导致控制台输出问题:

  • 日志文件迅速膨胀
  • JVM内存异常

通过 LogbackLog4j2 的自定义 ConverterFilter,对 MyBatis 打印的 PreparedStatement 参数进行截断或脱敏。

可以直接通修改定日志级别,限制Debug级别

1、创建自定义转换器

复制代码
import ch.qos.logback.classic.pattern.ClassicConverter;
import ch.qos.logback.classic.spi.ILoggingEvent;

/***
 *
 * @author xuancg
 * @date 2025/9/30
 */
public class SqlParamMaskingConverter extends ClassicConverter {
    private static final int MAX_LENGTH = 400;
    private static final String MASK = "...[MASKED: too long to show]";

    @Override
    public String convert(ILoggingEvent event) {
        String message = event.getFormattedMessage();

        // 匹配 PreparedStatement 的参数设置日志,如:? column1 = 'value'
        if (message.startsWith("==> Parameters:") || message.startsWith("Parameters:")) {
            return maskLongStrings(message);
        }
        return message;
    }

    private String maskLongStrings(String msg) {
        // 简单处理:对单引号包裹的长字符串进行截断
        if(msg.length() > MAX_LENGTH){
            return msg.substring(0, MAX_LENGTH) + MASK;
        }
        return msg;
    }
}

2、注册到 logback.xml

主要修改内容:

复制代码
<conversionRule conversionWord="maskedMsg" converterClass="com.xx.SqlParamMaskingConverter"/>

<!-- 日志输出格式 -->
<property name="log.pattern" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %maskedMsg%n" />
复制代码
<configuration>
    <!-- 注册自定义转换器 -->
    <conversionRule conversionWord="maskedMsg" converterClass="com.xx.SqlParamMaskingConverter"/>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %maskedMsg%n</pattern>
        </encoder>
    </appender>

    <!-- 只对 MyBatis 的 SQL 日志启用 -->
    <logger name="org.apache.ibatis.logging.jdbc.PreparedStatementLogger" level="DEBUG">
        <appender-ref ref="STDOUT"/>
    </logger>

    <root level="INFO">
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>
相关推荐
彭于晏Yan7 小时前
MyBatis-Plus使用动态表名分表查询
java·开发语言·mybatis
caibixyy12 小时前
Spring Boot 整合 Redisson 实现分布式锁:实战指南
spring boot·分布式·后端
sheji341613 小时前
【开题答辩全过程】以 springboot高校社团管理系统的设计与实现为例,包含答辩的问题和答案
java·spring boot·后端
Terio_my13 小时前
Spring Boot 集成 Redis 缓存解决方案
spring boot·redis·缓存
相与还13 小时前
IDEA+SpringBoot实现远程DEBUG到本机
java·spring boot·intellij-idea
Terio_my14 小时前
Spring Boot 缓存技术详解
spring boot·后端·缓存
caibixyy14 小时前
Spring Boot 集成 Kafka 详解
spring boot·kafka
Terio_my16 小时前
Spring Boot 整合 Elasticsearch
spring boot·后端·elasticsearch
哈利路亚胡辣汤17 小时前
spring多数据源配置
java·spring·mybatis