MyBatis源码分析之日志logging详解

来源：jb51　　时间：2019/3/4 9:52:19　　对本文有异议

前言

本文介绍个人对 logging 包下源码的理解。分享出来供大家参考学习，下面话不多说了，来一起看看详细的介绍吧

logging 配置加载

我们先从日志的配置加载开始阅读， MyBatis 的各项配置的加载过程都可以从 XMLConfigBuilder 类中找到，我们定位到该类下的日志加载方法 loadCustomLogImpl：

private void loadCustomLogImpl(Properties props) {
 // 从 MyBatis 的 TypeAliasRegistry 中查找 logImpl 键所对应值的类对象
 // 这里 logImpl 对应的 value 值可以从 org.apache.ibatis.session.Configuration 的构造方法中找到
 // 注意 Log 类，这是 MyBatis 内部对日志对象的抽象
 Class<? extends Log> logImpl = resolveClass(props.getProperty("logImpl"));
 // 将查找到的 Class 对象设置到 Configuration 对象中
 configuration.setLogImpl(logImpl);
}

很简单的一个方法，每行都有注释，其中 configuration.setLogImpl() 里面调用了 LogFactory.useCustomLogging() ，这出现了新类 LogFactory 类，接下来我们就来聊聊这个类。

LogFactory

useCustomLogging()方法

LogFactory 是框架内部获取 Log 对象的手段，通过它的名字也能看出来。它有如下几类方法：

// 注意这个类型的方法都是同步方法
public synchronized static useXxxLogging(...);
 
public static Log getLog(...);
 
private static tryImplementation(Runnable);
 
private static setImplementation(Class);

刚刚我们看到被调用的方法 useCustomLogging() 方法，是用来设置内部使用的日志框架， MyBatis 自身已经适配了一些常见的日志框架，如 Slf4j 、 Commons Log 、 Log4j 等等。

useCustomLogging() 方法内部调用 setImplementation(Class) 方法，此方法代码如下，功能简单：

private static void setImplementation(Class<? extends Log> implClass) {
 try {
  // 获取 Log实现类的构造方法，它只有一个字符串作为参数
  Constructor<? extends Log> candidate = implClass.getConstructor(String.class);
 
  // 创建一个 Log 对象，打印 debug 日志
  Log log = candidate.newInstance(LogFactory.class.getName());
  if (log.isDebugEnabled()) {
   log.debug("Logging initialized using '" + implClass + "' adapter.");
  }
 
  // ...
  // 把 candidate 对象设置到 LogFactory 的静态变量 logConstructor，这个静态变量在 getLog() 方法
  // 中被用到
  logConstructor = candidate;
 } catch (Throwable t) {
  throw new LogException("Error setting Log implementation. Cause: " + t, t);
 }
}

Log 接口

刚刚我们接触到了 Log 这个类，它是一个接口，是 MyBatis 内部使用的日志对象的抽象，它是为了兼容市面上各种各样的日志框架，使用了适配器模式，通过 Log 接口来连接 MyBatis 和其他日志框架，通过实现 Log 接口连着 MyBatis 和需要适配的日志框架。

Log 接口代码如下，先试着发现该接口与其他常见的日志接口的区别：

public interface Log {
 
 boolean isDebugEnabled();
 
 boolean isTraceEnabled();
 
 void error(String s, Throwable e);
 
 void error(String s);
 
 void debug(String s);
 
 void trace(String s);
 
 void warn(String s);
 
}

可有发现？Log 接口缺少了 info 级别的日志输出方法，个人猜测应该是 MyBatis 内部不需要 info 级别的日志输出，毕竟 Log 接口设计之初就是为了内部使用，而框架使用者是不会采用 MyBatis 的日志作为系统的日志。注意一点：实现了 Log 接口的类必须拥有一个参数只有一个字符串的构造方法，MyBatis 就是通过这个构造方法创建日志对象的。

MyBatis 适配了许多常见的日志框架，这里就单单介绍 Log4jImpl 类，它代码非常简单：

public class Log4jImpl implements Log {
 
 private static final String FQCN = Log4jImpl.class.getName();
 
 // 这里包装了 Log4j 框架的日志对象，从而实现适配
 private final Logger log;
 
 public Log4jImpl(String clazz) {
 log = Logger.getLogger(clazz);
 }
 
 @Override
 public boolean isDebugEnabled() {
 return log.isDebugEnabled();
 }
 
 @Override
 public boolean isTraceEnabled() {
 return log.isTraceEnabled();
 }
 
 @Override
 public void error(String s, Throwable e) {
 log.log(FQCN, Level.ERROR, s, e);
 }
 
 @Override
 public void error(String s) {
 log.log(FQCN, Level.ERROR, s, null);
 }
 
 @Override
 public void debug(String s) {
 log.log(FQCN, Level.DEBUG, s, null);
 }
 
 @Override
 public void trace(String s) {
 log.log(FQCN, Level.TRACE, s, null);
 }
 
 @Override
 public void warn(String s) {
 log.log(FQCN, Level.WARN, s, null);
 }
 
}

tryImplementation() 方法

LogFactory 类再介绍一下被静态代码块使用的方法 tryImplementation(Runnable) 。静态代码块代码如下：

static {
 // 依次执行如下代码，当没有该类会抛 ClassNotFoundException ，然后继续执行
 tryImplementation(LogFactory::useSlf4jLogging);
 tryImplementation(LogFactory::useCommonsLogging);
 tryImplementation(LogFactory::useLog4J2Logging);
 tryImplementation(LogFactory::useLog4JLogging);
 tryImplementation(LogFactory::useJdkLogging);
 tryImplementation(LogFactory::useNoLogging);
}

这个方法有点迷惑性，因为它使用 Runnable 接口作为参数，而 useXxxLOgging() 方法又是同步方法，很容易联想到多线程，实际上这里并没有， Runnable 接口不结合 Thread 类使用它就是一个普通的函数接口。除去这些就没什么了，不过是调用了 Runnable 的 run() 方法而已。

getLog() 方法

getLog() 没什么多说的，就是通过反射创建 Log 接口实现类，这里没有使用到缓存，每次调用都是创建一个新的对象。

jdbc 包

这个包与其他包有些不同，它的职能是为各个阶段的流程提供日志打印，该包一共就五个类，它们的关系如下：