MyBatis-Plus 如何将执行SQL输出到Java日志？

Question

如何在Spring Boot项目中配置MyBatis-Plus，使其将执行的SQL语句输出到Java日志（如Logback或Log4j2），便于调试SQL执行情况？常见问题包括SQL未打印、参数未替换、日志级别设置无效等。需确保MyBatis-Plus的执行器正确配置，同时配合日志框架开启对应包路径（如`com.baomidou.mybatisplus`）的DEBUG级别日志。此外，使用`configuration.logImpl`指定日志实现类（如`StdOutImpl`）是否会影响生产环境？如何在不开启全局限制的前提下精准输出SQL？

Answer 1

一、MyBatis-Plus SQL日志输出配置详解

在Spring Boot项目中集成MyBatis-Plus后，开发者常需调试SQL执行情况。然而，由于日志配置不当，常出现SQL未打印、参数未替换、日志级别无效等问题。本文将从基础配置到高级优化，系统性地阐述如何实现精准的SQL日志输出。

1. 基础配置：启用MyBatis-Plus日志功能

MyBatis-Plus默认不开启SQL日志输出，需通过配置项显式启用。最常见的方式是通过application.yml文件配置MyBatis-Plus的执行器日志实现类。

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

上述配置使用StdOutImpl直接将SQL输出到控制台，适用于开发环境快速验证。但该方式绕过Java日志框架（如Logback），不利于日志统一管理。

2. 集成日志框架：使用Logback或Log4j2输出SQL

推荐使用标准日志框架进行SQL输出，便于分级管理和生产环境控制。需确保以下两点：

• 设置MyBatis-Plus使用日志框架的实现类
• 在日志配置中开启对应包路径的DEBUG级别

修改配置如下：

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.slf4j.Slf4jImpl

同时，在logback-spring.xml中添加：

<logger name="com.baomidou.mybatisplus" level="DEBUG"/>
<logger name="com.yourpackage.mapper" level="DEBUG"/>

3. 常见问题分析与解决方案

问题现象	可能原因	解决方案
SQL语句未输出	日志级别非DEBUG	检查logback.xml中包路径级别
参数显示为?而非实际值	未启用参数绑定日志	确保使用Slf4jImpl并开启TRACE级别
日志输出混乱	多日志实现冲突	排除冲突依赖，统一日志门面
生产环境误输出SQL	全局DEBUG开启	使用Profile隔离配置
Mapper接口无日志	未扫描到Mapper包	检查@MapperScan路径
分页插件SQL不完整	拦截器未正确配置	确认PaginationInterceptor注入
动态SQL未展开	MyBatis缓存已编译SQL	查看预编译前的日志
日志性能下降	频繁输出大SQL	按需开启，避免全量DEBUG
Log4j2不生效	缺少适配器依赖	引入log4j-slf4j-impl
条件构造器无日志	Wrapper未触发SQL生成	确认执行了数据库操作

4. 精准控制SQL日志输出策略

为避免生产环境因日志过多影响性能，应采用精细化控制策略。可通过Spring Profile实现环境隔离：

---
spring:
  profiles: dev
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.slf4j.Slf4jImpl
logging:
  level:
    com.baomidou.mybatisplus: DEBUG
    com.example.mapper: DEBUG
---
spring:
  profiles: prod
logging:
  level:
    com.baomidou.mybatisplus: WARN

此外，可结合AOP或自定义插件，仅对特定Mapper或方法开启日志，实现“按需打印”。

5. 使用MyBatis-Plus执行器与插件机制优化日志

MyBatis-Plus支持通过MybatisPlusInterceptor拦截SQL执行过程。可自定义插件，在执行前后记录SQL与参数：

@Component
public class SqlLogInterceptor implements Interceptor {
    private static final Logger logger = LoggerFactory.getLogger(SqlLogInterceptor.class);

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        StatementHandler statementHandler = PluginUtils.realTarget(invocation.getTarget());
        BoundSql boundSql = statementHandler.getBoundSql();
        String sql = boundSql.getSql();
        Object param = boundSql.getParameterObject();
        logger.debug("Executing SQL: \n{}\nWith Parameters: {}", sql, param);
        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
}

注册该插件：

@Configuration
public class MyBatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new SqlLogInterceptor());
        return interceptor;
    }
}

6. 流程图：SQL日志输出决策流程

graph TD
    A[应用启动] --> B{是否为开发环境?}
    B -- 是 --> C[启用Slf4jImpl日志]
    B -- 否 --> D[设置日志级别为WARN]
    C --> E[配置logback DEBUG级别]
    E --> F[输出SQL与参数]
    D --> G[仅记录错误日志]
    F --> H[开发者调试SQL]
    G --> I[保障生产性能]

该流程确保开发期可调试，生产期不泄露敏感信息且不影响性能。

7. 生产环境风险评估与最佳实践

使用configuration.logImpl=StdOutImpl会直接输出到控制台，无法被日志框架管理，存在以下风险：

• 日志格式不统一，难以解析
• 无法按级别过滤，可能暴露敏感数据
• 性能开销大，尤其高并发场景
• 不符合审计与安全规范

因此，生产环境严禁使用StdOutImpl。应始终使用Slf4jImpl并配合日志框架的条件输出机制。

可通过MDC（Mapped Diagnostic Context）为特定请求开启SQL日志，例如通过Header触发：

if ("true".equals(request.getHeader("X-Debug-SQL"))) {
    MDC.put("sql_debug", "enabled");
}

再在日志输出模板中判断是否输出详细SQL。