Mybatis 源码-异常

Mybatis 源码-异常

异常模块结构

包结构

异常类继承树

IbatisException 类是顶层类，但是已经被加上 @Deprecated ，说明废弃掉了而 PersistenceException 类则是 IbatisException 的继承者，其他的异常类都只是用于业务区分，大同小异

异常工厂 ExceptionFactory

职责：把普通异常包装成mybatis自己的PersistenceException

使用例子

ErrorContext

正如其名，ErrorContext 记录本次执行过程的相关上下文信息，待发生异常的时候，其他组件就可以从本类实例中获取到相关上下文

内部结构

其内部维护了一个 ThreadLocal 和 6 个存储异常信息的成员变量来存储当前执行SQL的线程的信息

这些异常信息归结起来就是：谁，在哪个文件，做什么，执行什么SQL，而产生异常

• resource：异常所处资源文件

• activity：触发异常的操作

• object：触发异常的对象

• message：异常信息的概况

• sql：产生异常的SQL

• cause：详细的Java异常日志

另外 ErrorContext 提供了一个一次性打印所有异常信息的 toString() 方法

对照异常打印的信息

rest() 方法

既然使用了 ThreadLocal 那么必然需要在用完的时候清空掉它，Mybatis会在每次操作后使用 try-catch-finally 机制来确保ThreadLocal 被重置

这个方法主要在以下三个类中调用

• DefaultSqlSession

• DefaultSqlSessionFactory

• SqlSessionFactoryBuilder

store() 和 recall()

store() 用于将当前 ErrorContext 存储到 stored，然后 new 一个新的 ErrorContext 到 ThreadLocal

recall() 用于从当前 ErrorContext 的 stored 取出之前存的 ErrorContext 然后放入 ThreadLocal

这两个方法只在一处地方调用：BaseStatementHandler

TODO：这两个方法的具体用处，待探究

总结

Mybatis 通过将所有业务异常类继承到 PersistenceException 下，再通过 ExceptionFactory 异常工厂类来统一生产异常信息。

这么多异常类，如果各自的业务自己抛出，那么势必会导致日志乱序不容易查看。作者的做法很聪明，在 ErrorContext 中维护一个ThreadLocal 和 6 个异常的关键信息私有成员变量，然后对外提供链式编程的 set 方法，以及一个可以直接打印所有异常信息的 toString()方法，从而把当前线程所执行SQL过程的异常信息，归集并打印，日志内容简单明了，帮助开发者可以很快速的定位问题的产生。