MyBatis 如何兼容所有日志框架？

r囧r小猫 2021-09-02 07:36 293阅读 0赞

点击上方 [Java后端][Java]，选择 设为星标

优质文章，及时送达

--------------------

来源：blog.csdn.net/zwx900102/article/details/109025846

**目录**

*  前言
 *  MyBatis日志分类
 *   *  简单谈谈SLF4J
 *  MyBatis日志实现原理
 *   *  日志的解析
     *  LogFactory
     *  jdbc log
 *  总结

## **前言** ##

日志，在我们开发中是一个非常重要的话题，良好的日志打印可以帮助我们快速的定位问题，可能现在我们开发用到最多的日志框架就是slf4j了，但是日志还有其他很多优秀的框架，比如：Apache Common Log，Log4j，java.util.logging等。

MyBatis作为一款优秀的ORM框架，定义了一套统一的日志接口供应用层调用，而底层却利用适配器模式兼容了我们上面所列出来的常用日志框架。

## **MyBatis日志分类** ##

在介绍MyBatis的全局配置文件的时候，我们提到setting内有一个属性logImpl，可以配置的选项有：SLF4J，LOG4J，LOG4J2，JDK\_LOGGING，COMMONS\_LOGGING，STDOUT\_LOGGING，NO\_LOGGING。

这就说明MyBatis支持六种日志类型(NO\_LOGGING是不打印日志)。我们看一下MyBatis的日志模块也可以很明显的看出六种日志类型：

![format_png][]

它们的对应关系为：

> PS:需要注意的是，SLF4J并不是一个具体的日志框架，也就是我们不能单独只配置SLF4J而不引入其他任何具体的日志框架。

### 简单谈谈SLF4J ###

SLF4J：简单日记门面。(英文全称为simple logging Facade for Java)，这个是用来为各种日志框架提供一个简单的统一的接口，这样使得我们在切换日志框架的时候可以直接替换jar包就可以了，而无需修改源代码。

logback我想大家都用过，logback是一个实现了具体日志打印的框架，但是MyBatis上面列出来的分类并没有支持logback，它又为什么能够打印呢？这就是SLF4J的作用了，因为logback也实现了SLF4J提供的接口，所以我们需要将logback和SLF4J结合配置使用才行。而后面的介绍中也可以看到，MyBatis中如果我们不指定日志种类的时候，优先选择的就是SLF4J，这正是因为SLF4J可以和其他许多日志框架一起结合来使用。

**那么假如我们指定了日志类型为SLF4J，但是不引入其他任何实现呢？**

答案就是MyBatis不会打印任何日志出来，下图就是只配置了SLF4J而没有引入其他任何实现的警告信息：

![format_png 1][]

可以看到这里提示我们SLF4J没有任何实现，而后面的sql语句和参数这些信息也没有打印出来。

## **MyBatis日志实现原理** ##

### 日志的解析 ###

老规矩，我们还是先找到加载mybatis-config配置文件中的解析日志的源码：

![format_png 2][]

![format_png 3][]

这里首先会根据我们配置的属性作为别名去TypeAliasRegistry类中查找对应的类，如果不存在这个别名，那就会把我们配置的属性直接通过Class.forName去查找日志类，所以看到这里就明白我们可以自定义日志类，只要实现Log接口就行，然后配置我们自己的类名就行了。

虽然别名都存在TypeAliasRegistry类里面，但是我们前面介绍MyBatis配置文件的时候，列出了TypeAliasRegistry类中默认初始化的别名，并没有看到日志相关类的别名，那么日志的别名又是在哪里配置的呢？我们打开Configuration类：

![format_png 4][]

可以看到Configuration的构造方法里面也初始化了一些别名注册到TypeAliasRegistry类了。

接下来我们看看读取到日志类之后调用了setLogImpl做了什么事情：

![format_png 5][]

调用了LogFactory类的方法。

### LogFactory ###

LogFactory工厂是负责创建日志对象对应的适配器。

LogFactory的静态代码块内按顺序初始化了所有内置的日志

![format_png 6][]

再看一下tryImplementation方法，如果logConstructor不为空，说明当前还没有加载到日志适配器，那就继续执行run()方法，也就是继续执行useXXXLogging方法，而所有的useXXXLogging方法都是调用了setImplementation方法。

![format_png 7][]

下面这里如果加载成功之后就会对logConstructor进行赋值，那么后续的方法就不会再执行run()方法， 而如果抛出异常，因为已经被捕获了，所以就会继续往后执行静态代码块内的方法。

![format_png 8][]

从上面的LogFactory中我们可以看到，初始化的时候就会默认初始化一个日志适配器，所以如果我们引用了相关日志所需要的类，那么就会按照static代码块内的顺序进行选择一个合适的日志适配器。

继续回到上面的Configuration里面，这里拿到我们配置的日志信息之后，会直接调用useCustomLogging方法，也就是绕过了上面的logConstructor == null这个判断，而直接调用了setImplementation方法，所以假如我们配置了日志信息，那么会覆盖初始化的日志适配器。

PS：假如我们配置了一个不存在的日志类，那么调用setImplementation方法的时候异常就会被抛出来，因为捕获异常的方法是在tryImplementation而不是在setImplementation。

### jdbc log ###

MyBatis的日志包下面还有一个包时jdbc，这个我们还没有介绍，那么jdbc包下面的类又有什么用呢？我们先看一下类图关系：

![format_png 9][]

很明显，MyBatis将日志拆分成了ConnectionLogger，PreparedStatementLogger，ResultSetLogger，StatementLogger四种类型分开处理，它们都继承了BaseJdbcLogger类，而且实现了InvocationHandler接口，也很明显，这里用到了JDK动态代理。

任意点开ConnectionLogger可以发现，它是用来代理Connection对象的：

![format_png 10][]

其他三个那很明显，分别是用来代理PreparedStatement，ResultSet，Statement这三个对象的。也就是说MyBatis中日志最终的打印是通过JDK动态代理来实现的，而且不同的执行过程分成了四个对象来分别负责对应的日志打印。

我们继续看一下ConnectionLogger的invoke方法，可以看到，这里就是打印了一句日志：

![format_png 11][]

上面日志打印出来的效果就是我们下面红框中的日志：

![format_png 12][]

等等，差点被忽悠了，这代码里面并没有打印“==>”，打印出来的这个符号又是怎么来的呢？

那就需要进入debug方法里面继续看一看，这个debug方法是在抽象类BaseJdbcLogger里面实现的，所以我们还需要看看BaseJdbcLogger类的debug方法。

![format_png 13][]

可以看到这里打印的时候拼接了一个前缀：

![format_png 14][]

>   
> PS：queryStack是查询层数，如果没有嵌套查询则queryStack=1

## **总结** ##

本文主要分析了MyBatis日志的加载原理，并对LogFactory作为适配器对象工厂是如何选择日志适配器对象进行了分析。最后分析了MyBatis是如何通过动态代理将不同日志类型分为不同对象来实现日志打印功能的。

**- END -**

最近整理一份面试资料《Java技术栈学习手册》，覆盖了Java技术、面试题精选、Spring全家桶、Nginx、SSM、微服务、数据库、数据结构、架构等等。获取方式：点“ 在看，关注公众号 Java后端 并回复 777 领取，更多内容陆续奉上。推荐阅读 1. 5W 字详解分库分表之 Sharding-JDBC 中间件2. 网传一些著名互联网公司的实习工资3. TCP/IP 基础知识总结4. GET 和 POST 两种基本请求方法有什么区别5. 讨论：Service层需要接口吗？喜欢文章，点个在看

[Java]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0da17bf97a286df119047a25b7de51621fe542816673bb4aa3ebd8ab97b09a86ed7db2e2ee&idx=3&mid=2247489272&scene=21&sn=ce74938072fc73a808d83ccb474db46d#wechat_redirect
[format_png]: /images/20210730/6cb4a9f97bf241d2954ab0f80ba1ac0d.png
[format_png 1]: /images/20210730/5df91238257d4276a2edc5336d5caad6.png
[format_png 2]: /images/20210730/a792a09ad75f49e68a57f2d59d38a468.png
[format_png 3]: /images/20210730/926cf44dae034f01a6db0b0e57a5aaa6.png
[format_png 4]: /images/20210730/c0f8d21544894130a7fb68c0401c88ea.png
[format_png 5]: /images/20210730/964830ddc5254187a0372adc8500efe5.png
[format_png 6]: /images/20210730/23199d810d3248a087cdb182baff20d9.png
[format_png 7]: /images/20210730/c2b29f57b62b4cebb89707031f2bf5bb.png
[format_png 8]: /images/20210730/3c2575b753674864908c700025d8138b.png
[format_png 9]: /images/20210730/6e001e4ae2d84a21b36b1f5476f46113.png
[format_png 10]: /images/20210730/a86cde7ef8814e0aa42444d42264be14.png
[format_png 11]: /images/20210730/1f26c3e351914f7e982562391d246974.png
[format_png 12]: /images/20210730/d0e1538513464df6bc20ab96be650f9b.png
[format_png 13]: /images/20210730/c388773443d64895a7399f06199965bc.png
[format_png 14]: /images/20210730/57a71fb03b3d4ff3a13d8e2577ec70e5.png