Spring Boot中MyBatis SQL日志配置与优化

MyBatis作为Java企业级项目中常用的持久层框架，在开发和排查数据库问题时，SQL日志发挥着非常重要的作用。通过查看MyBatis执行的SQL语句、参数绑定情况以及执行耗时，开发人员可以快速定位查询异常、参数错误、慢SQL等问题。

Spring Boot整合MyBatis后，默认情况下不会直接输出完整SQL日志，需要进行额外配置。合理配置MyBatis SQL日志，不仅能够提升开发调试效率，还能帮助项目进行性能优化。

一、MyBatis SQL日志的作用

MyBatis SQL日志主要用于记录数据库交互过程中的关键信息，包括：

• Mapper接口执行的方法

• 实际生成的SQL语句

• SQL中的参数值

• 查询返回结果数量

• SQL执行耗时

例如，一个简单的数据查询：

Java
User user = userMapper.findById(1001);

通过SQL日志可以看到：

SQL
Preparing: select id, username, age from user where id = ?
Parameters: 1001(Integer)

开发人员可以直接确认SQL是否符合预期，参数是否正确传递。

SQL日志在以下场景中尤其有价值：

1. 排查接口返回数据异常；

2. 分析SQL执行效率；

3. 检查动态SQL生成结果；

4. 定位数据库连接问题；

5. 优化慢查询。

---

二、Spring Boot中开启MyBatis SQL日志

Spring Boot项目中配置MyBatis SQL日志主要有几种方式，根据项目规模和日志框架选择合适方案。

---

1. 使用application.yml配置日志级别

这是最常用的方法。

如果项目使用Spring Boot默认日志框架Logback，可以在application.yml中添加：

YAML
logging:
  level:
    com.example.mapper: debug

其中：

• com.example.mapper是Mapper接口所在包路径；

• debug级别会输出MyBatis执行SQL信息。

例如：

YAML
logging:
  level:
    com.demo.project.mapper: DEBUG

启动项目后，可以看到类似日志：

==> Preparing: select * from user where id=?
==> Parameters: 1(Integer)
<== Total: 1

这种方式推荐用于开发环境。

---

2. 配置MyBatis日志实现方式

MyBatis支持多种日志实现：

• SLF4J

• Log4j2

• Log4j

• JDK Logging

Spring Boot项目通常使用SLF4J。

可以在配置文件中指定：

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

完整示例：

YAML
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test
    username: root
    password: 123456

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

配置完成后，MyBatis会通过SLF4J输出SQL日志。

---

三、输出完整SQL与参数

很多开发人员发现MyBatis日志中只有：

SQL
select * from user where id = ?

却看不到实际参数。

原因是MyBatis默认采用预编译方式：

SQL
where id = ?

参数单独绑定：

Parameters: 10(Integer)

这是数据库安全机制，并不是SQL没有参数。

如果需要查看完整SQL，可以使用第三方SQL日志工具。

---

1. 使用MyBatis Plus SQL分析工具

如果项目使用MyBatis-Plus，可以开启SQL分析插件：

Java
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();

    interceptor.addInnerInterceptor(
        new IllegalSQLInnerInterceptor()
    );

    return interceptor;
}

它可以帮助检查：

• 全表查询；

• SQL规范问题；

• 潜在风险操作。

---

2. 使用P6Spy打印真实SQL

P6Spy是一种常见数据库SQL监控工具，可以将参数替换后的完整SQL输出。

添加依赖：

XML

    p6spy
    p6spy
    3.9.1

修改数据库驱动：

YAML
spring:
  datasource:
    driver-class-name: com.p6spy.engine.spy.P6SpyDriver

修改连接地址：

YAML
url: jdbc:p6spy:mysql://localhost:3306/test

配置：

properties
modulelist=log,filter
logMessageFormat=com.p6spy.engine.spy.appender.SingleLineFormat

日志效果：

SQL
select * from user where id = 1001;

相比MyBatis默认日志更加直观。

---

四、MyBatis日志配置最佳实践

SQL日志并不是越详细越好，需要根据环境合理控制。

开发环境

建议开启：

YAML
logging:
  level:
    mapper包路径: DEBUG

方便开发调试。

---

测试环境

可以开启部分SQL日志：

YAML
logging:
  level:
    com.demo.mapper: INFO

重点观察异常SQL。

---

生产环境

不建议长期开启详细SQL日志。

原因包括：

1. 增加日志文件大小；

2. 降低系统性能；

3. 可能暴露敏感数据。

生产环境建议：

• 仅记录慢SQL；

• 使用数据库监控工具；

• 设置日志采样；

• 对敏感字段脱敏。

---

五、MyBatis SQL日志性能优化

开启SQL日志虽然方便，但也会带来额外开销。

1. 避免生产环境DEBUG日志

DEBUG日志会执行字符串拼接和参数转换。

例如：

Java
logger.debug("SQL: {}", sql);

即使日志最终不输出，也可能产生一定性能损耗。

---

2. 控制日志范围

不要直接配置：

YAML
logging:
  level:
    org.mybatis: DEBUG

这样会输出大量框架内部日志。

推荐精确到Mapper包：

YAML
logging:
  level:
    com.company.project.mapper: DEBUG

---

3. 使用异步日志

高并发系统中，可以使用Logback异步Appender。

例如：

XML
 ref="ASYNC"/>

减少日志写入对业务线程的影响。

---

六、结合慢SQL进行性能分析

SQL日志不仅用于查看SQL，还可以辅助性能优化。

重点关注以下问题：

1. 查询字段过多

不推荐：

SQL
select * from user;

推荐：

SQL
select id, username from user;

减少无用字段传输。

---

2. 缺少索引

日志发现：

SQL
select * from order where user_id=100;

执行时间较长时，需要检查：

SQL
show index from order;

确认是否存在合适索引。

---

3. N+1查询问题

例如：

查询用户列表：

SQL
select * from user;

然后循环查询：

SQL
select * from order where user_id=?;

可能产生大量SQL。

优化方式：

• 使用联表查询；

• 批量查询；

• 合理设计Mapper方法。

---

七、常见SQL日志不生效问题

问题1：配置日志级别后没有SQL输出

检查：

1. Mapper包路径是否正确；

2. 日志级别是否为DEBUG；

3. 是否使用正确日志实现。

例如：

错误：

YAML
logging:
  level:
    com.demo.mapper.user: DEBUG

实际Mapper：

com.demo.mapper.UserMapper

应该配置：

YAML
logging:
  level:
    com.demo.mapper: DEBUG

---

问题2：只显示SQL，不显示参数

这是正常现象。

MyBatis默认日志：

Preparing:
Parameters:

参数和SQL分开打印。

需要完整SQL时，可以使用P6Spy。

---

问题3：日志乱码

通常与日志编码有关。

Logback配置：

XML

    UTF-8

确保日志文件采用UTF-8编码。

---

八、Spring Boot 3与MyBatis日志配置注意事项

Spring Boot 3通常基于：

• Java 17+

• Spring Framework 6

• SLF4J 2.x

建议使用：

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

避免使用过时日志实现。

同时升级MyBatis相关依赖时，需要注意版本兼容：

• MyBatis；

• MyBatis-Spring；

• MyBatis-Spring-Boot-Starter。

版本不匹配可能导致日志无法正常输出。

---

九、推荐的企业项目SQL日志方案

对于中大型项目，可以采用分层策略：

开发环境：

MyBatis DEBUG日志
+
IDE调试

测试环境：

SQL日志
+
慢SQL统计
+
接口监控

生产环境：

慢SQL监控
+
数据库执行计划分析
+
链路追踪

常见组合：

• MyBatis日志负责开发调试；

• P6Spy负责SQL审计；

• 数据库监控负责性能分析；

• SkyWalking等链路工具负责调用追踪。

---

总结

Spring Boot整合MyBatis后，合理配置SQL日志能够显著提升开发效率和问题定位能力。通过logging.level配置Mapper日志、指定MyBatis日志实现、结合P6Spy查看完整SQL，可以满足不同开发阶段的需求。

不过SQL日志也需要合理使用，开发环境可以开启详细日志，而生产环境应避免长期输出大量SQL内容。结合慢SQL分析、索引优化和链路监控，才能真正发挥MyBatis日志在系统性能优化中的价值。