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>
相关推荐
swg3213211 天前
Spring Boot 3.X Oauth2 认证服务与资源服务
java·spring boot·后端
gelald1 天前
SpringBoot - 自动配置原理
java·spring boot·后端
@yanyu6661 天前
07-引入element布局及spring boot完善后端
javascript·vue.js·spring boot
那个失眠的夜1 天前
Mybatis延迟加载策略
xml·java·数据库·maven·mybatis
Rick19931 天前
SQL 执行流程
数据库·sql
Y001112361 天前
MySQL-进阶
开发语言·数据库·sql·mysql
程序猿_极客1 天前
SpringBoot 三大参数注解详解:@RequestParam @RequestBody @PathVariable 区别及常用开发注解
java·spring boot·后端·面试八股文·springboot注释
小胖java1 天前
校园通衢公告枢纽系统
java·spring boot
身如柳絮随风扬1 天前
MyBatis 插件原理详解:从拦截器到动态代理,手写一个分页插件
java·mybatis
Hadoop_Liang1 天前
构建Spring Boot项目Docker镜像
spring boot·后端·docker