快捷導(dǎo)航

MyBatis源碼分析之日志logging詳解

更新時(shí)間：2019年03月04日 08:37:34 作者：魏晉秋

這篇文章主要給大家介紹了關(guān)于MyBatis源碼分析之日志logging的相關(guān)資料，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

前言

本文介紹個(gè)人對(duì) logging 包下源碼的理解。分享出來(lái)供大家參考學(xué)習(xí)，下面話不多說(shuō)了，來(lái)一起看看詳細(xì)的介紹吧

logging 配置加載

我們先從日志的配置加載開始閱讀， MyBatis 的各項(xiàng)配置的加載過(guò)程都可以從 XMLConfigBuilder 類中找到，我們定位到該類下的日志加載方法 loadCustomLogImpl：

private void loadCustomLogImpl(Properties props) {
 // 從 MyBatis 的 TypeAliasRegistry 中查找 logImpl 鍵所對(duì)應(yīng)值的類對(duì)象
 // 這里 logImpl 對(duì)應(yīng)的 value 值可以從 org.apache.ibatis.session.Configuration 的構(gòu)造方法中找到
 // 注意 Log 類，這是 MyBatis 內(nèi)部對(duì)日志對(duì)象的抽象
 Class<? extends Log> logImpl = resolveClass(props.getProperty("logImpl"));
 // 將查找到的 Class 對(duì)象設(shè)置到 Configuration 對(duì)象中
 configuration.setLogImpl(logImpl);
}

很簡(jiǎn)單的一個(gè)方法，每行都有注釋，其中 configuration.setLogImpl() 里面調(diào)用了 LogFactory.useCustomLogging() ，這出現(xiàn)了新類 LogFactory 類，接下來(lái)我們就來(lái)聊聊這個(gè)類。

LogFactory

useCustomLogging()方法

LogFactory 是框架內(nèi)部獲取 Log 對(duì)象的手段，通過(guò)它的名字也能看出來(lái)。它有如下幾類方法：

// 注意這個(gè)類型的方法都是同步方法
public synchronized static useXxxLogging(...);

public static Log getLog(...);

private static tryImplementation(Runnable);

private static setImplementation(Class);

剛剛我們看到被調(diào)用的方法 useCustomLogging() 方法，是用來(lái)設(shè)置內(nèi)部使用的日志框架， MyBatis 自身已經(jīng)適配了一些常見的日志框架，如 Slf4j 、 Commons Log 、 Log4j 等等。

useCustomLogging() 方法內(nèi)部調(diào)用 setImplementation(Class) 方法，此方法代碼如下，功能簡(jiǎn)單：

private static void setImplementation(Class<? extends Log> implClass) {
 try {
  // 獲取 Log實(shí)現(xiàn)類的構(gòu)造方法，它只有一個(gè)字符串作為參數(shù)
  Constructor<? extends Log> candidate = implClass.getConstructor(String.class);

  // 創(chuàng)建一個(gè) Log 對(duì)象，打印 debug 日志
  Log log = candidate.newInstance(LogFactory.class.getName());
  if (log.isDebugEnabled()) {
   log.debug("Logging initialized using '" + implClass + "' adapter.");
  }

  // ...
  // 把 candidate 對(duì)象設(shè)置到 LogFactory 的靜態(tài)變量 logConstructor，這個(gè)靜態(tài)變量在 getLog() 方法
  // 中被用到
  logConstructor = candidate;
 } catch (Throwable t) {
  throw new LogException("Error setting Log implementation. Cause: " + t, t);
 }
}

Log 接口

剛剛我們接觸到了 Log 這個(gè)類，它是一個(gè)接口，是 MyBatis 內(nèi)部使用的日志對(duì)象的抽象，它是為了兼容市面上各種各樣的日志框架，使用了適配器模式，通過(guò) Log 接口來(lái)連接 MyBatis 和其他日志框架，通過(guò)實(shí)現(xiàn) Log 接口連著 MyBatis 和需要適配的日志框架。

Log 接口代碼如下，先試著發(fā)現(xiàn)該接口與其他常見的日志接口的區(qū)別：

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);

}

可有發(fā)現(xiàn)？Log 接口缺少了 info 級(jí)別的日志輸出方法，個(gè)人猜測(cè)應(yīng)該是 MyBatis 內(nèi)部不需要 info 級(jí)別的日志輸出，畢竟 Log 接口設(shè)計(jì)之初就是為了內(nèi)部使用，而框架使用者是不會(huì)采用 MyBatis 的日志作為系統(tǒng)的日志。注意一點(diǎn)：實(shí)現(xiàn)了 Log 接口的類必須擁有一個(gè)參數(shù)只有一個(gè)字符串的構(gòu)造方法，MyBatis 就是通過(guò)這個(gè)構(gòu)造方法創(chuàng)建日志對(duì)象的。

MyBatis 適配了許多常見的日志框架，這里就單單介紹 Log4jImpl 類，它代碼非常簡(jiǎn)單：

public class Log4jImpl implements Log {

 private static final String FQCN = Log4jImpl.class.getName();

 // 這里包裝了 Log4j 框架的日志對(duì)象，從而實(shí)現(xiàn)適配
 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 類再介紹一下被靜態(tài)代碼塊使用的方法 tryImplementation(Runnable) 。靜態(tài)代碼塊代碼如下：

static {
 // 依次執(zhí)行如下代碼，當(dāng)沒(méi)有該類會(huì)拋 ClassNotFoundException ，然后繼續(xù)執(zhí)行
 tryImplementation(LogFactory::useSlf4jLogging);
 tryImplementation(LogFactory::useCommonsLogging);
 tryImplementation(LogFactory::useLog4J2Logging);
 tryImplementation(LogFactory::useLog4JLogging);
 tryImplementation(LogFactory::useJdkLogging);
 tryImplementation(LogFactory::useNoLogging);
}

這個(gè)方法有點(diǎn)迷惑性，因?yàn)樗褂?Runnable 接口作為參數(shù)，而 useXxxLOgging() 方法又是同步方法，很容易聯(lián)想到多線程，實(shí)際上這里并沒(méi)有， Runnable 接口不結(jié)合 Thread 類使用它就是一個(gè)普通的函數(shù)接口。除去這些就沒(méi)什么了，不過(guò)是調(diào)用了 Runnable 的 run() 方法而已。

getLog() 方法

getLog() 沒(méi)什么多說(shuō)的，就是通過(guò)反射創(chuàng)建 Log 接口實(shí)現(xiàn)類，這里沒(méi)有使用到緩存，每次調(diào)用都是創(chuàng)建一個(gè)新的對(duì)象。

jdbc 包

這個(gè)包與其他包有些不同，它的職能是為各個(gè)階段的流程提供日志打印，該包一共就五個(gè)類，它們的關(guān)系如下：