当前位置: 首页 > news >正文

MyBatis实战指南(八)MyBatis日志

MyBatis实战指南(八)MyBatis日志

  • 前言
  • 一、为什么需要日志?
  • 二、日志框架怎么选?
    • 1. 手把手教你集成(以最常用的SLF4J+Logback为例)
    • 步骤1:添加依赖(Maven项目)
    • 步骤2:在MyBatis配置文件中开启日志
    • 步骤3:配置Logback日志文件
  • 三、配置方式详解
    • 1. MyBatis自身的日志配置
    • 2. 日志级别控制
    • 3. Spring Boot中怎么配?
  • 四、源码解析:搞懂MyBatis日志底层逻辑
    • 1. 日志接口 Log
    • 2. 日志工厂LogFactory
    • 3. 自动检测机制


前言

  • 在上一篇博客中,我们深入剖析了 MyBatis 的缓存机制原理与实战应用
  • 作为 MyBatis 框架中另一重要的基础设施,日志系统在项目开发、调试及运维阶段承担着关键作用 —— 它不仅能帮助开发者追踪 SQL 执行流程、定位异常问题,还能通过日志级别控制实现不同环境下的调试信息输出管理
  • 从本文开始,我们将围绕 MyBatis 日志模块展开系统讲解,涵盖 日志框架集成(Log4j/SLF4J 等)、配置方式、源码解析及性能优化 等核心内容,帮助读者全面掌握 MyBatis 日志体系的技术细节与最佳实践

我的个人主页,欢迎来阅读我的其他文章
https://blog.csdn.net/2402_83322742?spm=1011.2415.3001.5343
我的MyBatis实战指南知识文章专栏
欢迎来阅读指出不足
https://blog.csdn.net/2402_83322742/category_12969707.html?spm=1001.2014.3001.5482


一、为什么需要日志?

举个生活中的例子:你网购收到商品发现有问题,打电话给客服时,客服需要查看订单记录(日志)才能定位问题。MyBatis的日志也是一样的道理

  • 开发阶段:打印SQL语句和参数,帮你确认写的SQL是否正确(比如有没有拼错表名、where条件是否正确)
  • 调试阶段:记录异常信息(比如数据库连接失败、参数类型错误),快速定位报错位置
  • 生产阶段:通过控制日志级别,只记录重要信息(比如错误日志),避免无关信息干扰

最常用的场景:当你发现查询结果不对时,第一时间打开日志看看实际执行的SQL是什么,90%的问题都能通过对比SQL找到原因

二、日志框架怎么选?

MyBatis本身不自带日志实现,需要集成第三方日志框架

  • 常见的框架有这几种。
框架名称优点缺点适合场景
SLF4J统一日志接口,支持多种实现(如Logback)不能单独使用,必须搭配具体实现新项目首选,推荐搭配Logback
Log4j老牌框架,配置简单性能一般,新版本Log4j2已发布兼容旧项目
Log4j2性能更好,支持异步日志配置比Log4j复杂一点对性能要求高的项目
Java自带JUL无需额外依赖功能简单,配置不够灵活极简项目或临时调试

1. 手把手教你集成(以最常用的SLF4J+Logback为例)

步骤1:添加依赖(Maven项目)

<!-- SLF4J接口 -->
<dependency><groupId>org.slf4j</groupId><artifactId>slf4j-api</artifactId><version>2.0.7</version>
</dependency>
<!-- Logback实现 -->
<dependency><groupId>ch.qos.logback</groupId><artifactId>logback-classic</artifactId><version>1.4.13</version>
</dependency>

步骤2:在MyBatis配置文件中开启日志

mybatis-config.xml中添加:

<settings><!-- 设置日志工厂为SLF4J --><setting name="logImpl" value="SLF4J"/>
</settings>

步骤3:配置Logback日志文件

src/main/resources目录下新建logback.xml,核心配置如下(重点看注释):

<configuration><!-- 定义日志输出格式 --><pattern name="simplePattern">%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</pattern><!-- 控制台输出 --><appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>${simplePattern}</pattern></encoder></appender><!-- 重点:配置MyBatis日志输出 --><logger name="org.apache.ibatis" level="DEBUG"/> <!-- 输出MyBatis自身日志 --><logger name="com.yourcompany.mapper" level="DEBUG"/> <!-- 输出你的Mapper接口日志 --><root level="INFO"> <!-- 全局日志级别,优先级低于上面的logger --><appender-ref ref="CONSOLE"/></root>
</configuration>

三、配置方式详解

1. MyBatis自身的日志配置

mybatis-config.xml中,通过<settings>标签配置:

  • logImpl:指定使用的日志框架(可选值:SLF4J、LOG4J、LOG4J2、JUL、STDOUT_LOGGING、NO_LOGGING)
    <!-- 示例:使用Log4j2 -->
    <setting name="logImpl" value="LOG4J2"/>
    
  • lazyLoadingEnabledaggressiveLazyLoading:这两个和延迟加载相关的日志,新手暂时不用管,保持默认即可。

2. 日志级别控制

日志级别从低到高依次是:DEBUG < INFO < WARN < ERROR,级别越高,输出的内容越少。

  • 开发阶段:建议设为DEBUG,能看到完整的SQL语句和参数(比如:==> Preparing: SELECT * FROM user WHERE id=?
  • 生产阶段:设为ERRORWARN,只记录错误和警告,避免日志文件过大

3. Spring Boot中怎么配?

如果你用Spring Boot,不需要单独写MyBatis配置文件,直接在application.properties中配置:

# 开启MyBatis日志
mybatis.configuration.log-impl=org.apache.ibatis.logging.slf4j.Slf4jImpl# 配置具体Mapper的日志级别(比如只打印UserMapper的DEBUG日志)
logging.level.com.yourcompany.mapper.UserMapper=DEBUG

四、源码解析:搞懂MyBatis日志底层逻辑

如果你对底层原理好奇,可以简单了解这几个核心类,不用记代码,知道它们的关系就行:

1. 日志接口 Log

MyBatis定义了一个统一的日志接口Log,所有日志框架都要实现这个接口。比如Slf4jImpl就是SLF4J的实现类,Log4jImpl是Log4j的实现类。

2. 日志工厂LogFactory

它就像一个"工厂",根据你配置的logImpl,生产对应的日志对象。比如你配置了SLF4J,它就会创建Slf4jImpl对象。

3. 自动检测机制

如果你的项目中同时存在多个日志框架(比如同时有Log4j和SLF4J),MyBatis会按以下顺序自动选择:

SLF4J → LOG4J2 → LOG4J → JUL → STDOUT(控制台输出)→ NO_LOGGING(无日志)

所以建议只保留一个日志框架,避免冲突。


以上就是这篇博客的全部内容,下一篇我们将继续探索MyBatis的更多精彩内容。

我的个人主页,欢迎来阅读我的其他文章
https://blog.csdn.net/2402_83322742?spm=1011.2415.3001.5343
我的MyBatis实战指南知识文章专栏
欢迎来阅读指出不足
https://blog.csdn.net/2402_83322742/category_12969707.html?spm=1001.2014.3001.5482

非常感谢您的阅读,喜欢的话记得三连哦

在这里插入图片描述

相关文章:

  • 热传导方程能量分析与边界条件研究
  • HarmonyOS实战:自定义表情键盘
  • < OS 有关 4 台 Ubuntu VPSs 正在被攻击:nginx 之三> 记录、分析、防护的过程 配置 ufw Fail2Ban 保护网络上的主机
  • 个人计算机系统安全、网络安全、数字加密与认证
  • Github 2025-06-29php开源项目日报 Top10
  • RK3588集群服务器性能优化案例:电网巡检集群、云手机集群、工业质检集群
  • Mac电脑手动安装原版Stable Diffusion,开启本地API调用生成图片
  • 基于云的平板挠度模拟:动画与建模-AI云计算数值分析和代码验证
  • Linux中部署Nacos保姆级教程
  • Wpf布局之WrapPanel面板!
  • Java面试宝典:基础二
  • JSON + 存储过程:SaaS 架构下的统一接口与租户定制之道
  • 2025年渗透测试面试题总结-2025年HW(护网面试) 19(题目+回答)
  • OpenCV读取照片和可视化详解和代码示例
  • Java 数据结构 泛型
  • Hive SQL 快速入门指南
  • 线性相关和线性无关
  • 【记录】服务器多用户共享Conda环境——Ubuntu24.04
  • HarmonyOS NEXT仓颉开发语言实战案例:健身App
  • HarmonyOS NEXT仓颉开发语言实战案例:小而美的旅行App