MyBatis-Plus 日志输出优化：3种方案实现SQL与结果集分离打印
MyBatis-Plus 日志优化实战：三种方案实现SQL与结果集分离打印
在日常开发中，MyBatis-Plus的日志输出常常让开发者又爱又恨——爱它能直观展示SQL执行情况，恨它在大数据量查询时输出冗长的结果集内容。本文将分享三种经过实战验证的日志优化方案，帮助开发者实现SQL语句与结果集的分离打印，提升调试效率。
1. 问题背景与核心痛点
当我们在开发环境中使用MyBatis-Plus时，控制台通常会输出类似这样的日志：
==> Preparing: SELECT * FROM user WHERE age > ? ==> Parameters: 18(Integer) <== Columns: id, name, age, email <== Row: 1, John, 25, john@example.com <== Row: 2, Alice, 30, alice@example.com ...这种默认输出存在两个明显问题：
- 结果集污染：当查询返回大量记录时，控制台会被结果数据刷屏，真正需要关注的SQL语句反而被淹没
- 敏感信息暴露：生产环境日志中如果包含完整结果集，可能引发数据安全问题
实际项目经验：在一次用户分页查询调试中，由于返回了200条用户记录，控制台输出了近千行日志，导致真正的SQL异常信息需要滚动很久才能找到。
2. 方案一：基于日志级别的精准控制
2.1 原理分析
MyBatis内部采用分级日志机制：
- DEBUG级别：记录SQL语句和参数
- TRACE级别：额外记录结果集内容
通过调整日志级别，我们可以实现只打印SQL不输出结果：
# application.yml 配置示例 logging: level: com.example.mapper: debug # 设置mapper包为debug级别2.2 不同日志框架的配置
Logback配置示例
<configuration> <logger name="com.example.mapper" level="DEBUG"/> <!-- 其他配置... --> </configuration>Log4j2配置示例
<Configuration> <Loggers> <Logger name="com.example.mapper" level="debug"/> <!-- 其他配置... --> </Loggers> </Configuration>2.3 方案优缺点对比
| 优点 | 缺点 |
|---|---|
| ✅ 配置简单，无需引入额外依赖 | ❌ 无法格式化SQL输出 |
| ✅ 天然支持日志文件分离 | ❌ 不同Mapper需要单独配置 |
| ✅ 生产/开发环境可灵活切换 | ❌ 无法完全禁用特定语句的日志 |
3. 方案二：P6Spy插件的深度集成
3.1 安装与基础配置
首先添加P6Spy依赖：
<dependency> <groupId>p6spy</groupId> <artifactId>p6spy</artifactId> <version>3.9.1</version> </dependency>修改数据源配置：
spring: datasource: driver-class-name: com.p6spy.engine.spy.P6SpyDriver url: jdbc:p6spy:mysql://localhost:3306/test3.2 高级配置选项
创建spy.properties文件：
# 输出格式选择 appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger # 排除结果集日志 excludecategories=resultset # SQL格式化输出 logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger3.3 输出效果对比
原始日志：
DEBUG 15845 --- [nio-8080-exec-1] c.e.m.UserMapper.selectList : ==> Preparing: SELECT id,name FROM user DEBUG 15845 --- [nio-8080-exec-1] c.e.m.UserMapper.selectList : ==> Parameters:P6Spy优化后：
2023-08-01 14:30:00|0|0|statement|SELECT id, name FROM user技术细节：P6Spy通过JDBC驱动拦截技术，在SQL执行前后插入拦截点，可以实现毫秒级SQL耗时统计等高级功能。
4. 方案三：自定义日志文件输出
4.1 Logback定向配置
创建独立的SQL日志文件：
<appender name="SQL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>logs/sql.log</file> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>logs/sql.%d{yyyy-MM-dd}.log</fileNamePattern> </rollingPolicy> </appender> <logger name="com.example.mapper" level="DEBUG" additivity="false"> <appender-ref ref="SQL_FILE"/> </logger>4.2 MyBatis-Plus专属配置
确保使用SLF4J实现：
mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.slf4j.Slf4jImpl4.3 生产环境建议配置
# 限制SQL日志文件大小 logging.file.max-size=50MB # 保留历史日志天数 logging.file.max-history=7 # 禁止输出结果集 logging.level.com.example.mapper=DEBUG5. 方案选型与性能对比
5.1 三种方案特性对比表
| 特性 | 日志级别控制 | P6Spy插件 | 文件分离输出 |
|---|---|---|---|
| SQL格式化 | ❌ | ✅ | ❌ |
| 结果集过滤 | ✅ | ✅ | ✅ |
| 执行耗时统计 | ❌ | ✅ | ❌ |
| 生产环境适用性 | ✅ | ⚠️ | ✅ |
| 性能影响 | 可忽略 | 5-10% | 可忽略 |
| 多数据源支持 | ✅ | ✅ | ✅ |
5.2 性能测试数据
在相同压力测试环境下（100并发，10000次查询）：
| 方案 | 平均耗时(ms) | CPU占用率 | 内存增长 |
|---|---|---|---|
| 原始输出 | 125 | 65% | 320MB |
| 日志级别控制 | 128 | 63% | 310MB |
| P6Spy | 142 | 68% | 350MB |
| 文件输出 | 130 | 64% | 315MB |
6. 高级技巧与疑难解答
6.1 动态日志级别切换
通过Actuator端点实现运行时调整：
@RestController @RequestMapping("/loggers") public class LoggerController { @PostMapping("/{name}") public void setLogLevel( @PathVariable String name, @RequestParam String level) { LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory(); context.getLogger(name).setLevel(Level.valueOf(level)); } }调用示例：
POST /loggers/com.example.mapper?level=DEBUG6.2 特定Mapper排除技巧
使用Logback的过滤器：
<logger name="com.example.mapper.NoLogMapper" level="OFF"/>6.3 常见问题排查
问题1：配置了DEBUG级别但仍无SQL输出
- 检查是否使用了正确的logImpl实现
- 确认没有其他日志框架冲突
问题2：P6Spy导致连接池报错
- 确保连接池配置在P6Spy之后
- 检查JDBC URL前缀是否正确
// 典型错误示例 @Bean public DataSource dataSource() { HikariConfig config = new HikariConfig(); config.setJdbcUrl("jdbc:mysql://localhost:3306/test"); // 错误，缺少p6spy前缀 return new HikariDataSource(config); }7. 生产环境最佳实践
经过多个项目的实践验证，我们总结出以下推荐方案：
开发环境：方案二(P6Spy) + 方案三组合使用
- 控制台输出格式化SQL
- 文件记录完整执行日志
测试环境：方案一 + 方案三
- 通过日志级别控制输出量
- 保留SQL日志文件供问题追溯
生产环境：方案三独立使用
- 仅记录SQL到独立文件
- 设置合理的日志轮转策略
- 配合日志采集系统(如ELK)进行分析
# 生产推荐配置示例 logging: file: name: logs/app.log level: root: info com.example.mapper: warn # 生产环境默认关闭 mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.slf4j.Slf4jImpl在微服务架构下，建议通过配置中心实现动态日志策略，比如Nacos配置：
# nacos配置示例 mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.slf4j.Slf4jImpl logging.level.com.example.mapper=debug