mybatis源码解析之日志模块

我就是我 2022-08-29 05:59 249阅读 0赞

> 原创不易，转载请注明出处

### 文章目录 ###

*   *   *  前言
         *  1.mybatis日志接口定义
         *  2.mybatis是怎样适配各种各样的日志框架的
         *   *  2.1 LogFactory 日志工厂
             *  2. 适配slf4j日志框架
         *  总结

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

### 前言 ###

本文主要介绍了mybatis的日志模块，看看它是怎样与市面上各种各样的日志框架集成适配的，现在市面上的日志框架有很多，像log4j，log4j2，logback，slf4j，还有jdk自己带的日志模块，mybatis在编写框架打印日志的时候并没有指定使用某款日志框架，比如说我看你logback这个日志框架顺眼，我就用你吧，并没有，而是自己定义了一套日志接口，然后整了一堆各日志框架适配实现，采取你项目中有啥日志框架就用啥日志框架的策略。接下来我们就看看它的这套日志接口与各日志框架是怎样适配的。

### 1.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);
    }

很简单，就是定义了不同日志级别打印日志的方法。  
来看看实现它的实现类有多少  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70]  
可以看到，实现类有很多，每一个实现类都是适配某一款日志框架的，比如说这里Log4j2Impl ，就是适配log4j2日志框架的。

### 2.mybatis是怎样适配各种各样的日志框架的 ###

#### 2.1 LogFactory 日志工厂 ####

通过日志工厂获取日志对象。

public final class LogFactory { 
      /** * Marker to be used by logging implementations that support markers. */
      public static final String MARKER = "MYBATIS";
      private static Constructor<? extends Log> logConstructor;
      // 尝试看看哪个日志的管用
      static { 
        tryImplementation(LogFactory::useSlf4jLogging);
        tryImplementation(LogFactory::useCommonsLogging);
        tryImplementation(LogFactory::useLog4J2Logging);
        tryImplementation(LogFactory::useLog4JLogging);
        tryImplementation(LogFactory::useJdkLogging);
        tryImplementation(LogFactory::useNoLogging);
      }
      private LogFactory() { 
        // disable construction
      }
      public static Log getLog(Class<?> clazz) { 
        return getLog(clazz.getName());
      }
      public static Log getLog(String logger) { 
        try { 
          return logConstructor.newInstance(logger);
        } catch (Throwable t) { 
          throw new LogException("Error creating logger for logger " + logger + ". Cause: " + t, t);
        }
      }
    }

提供两个获取日志对象Log的静态方法getLog方法，这样看起来与我们平常使用的日志框架也没什么两样，都是LogFactory中获取Log日志对象，但是唯一不一样的就是选取哪个日志框架适配实现类作为日志对象，通俗来讲就是使用哪个日志框架来底层打印日志。  
我们可以看到它getLog方法最终是调用的`logConstructor.newInstance(logger);`这行代码，就是通过反射获取到具体的实现类，那么这个logConstructor 又是哪个实现类的呢。  
这里我们就要看下它的静态代码块了。  
tryImplementation(LogFactory::useSlf4jLogging);  
一堆调用tryImplementation方法的代码，这个方法就是尝试使用某个日志框架适配实现类的。就是尝试使用某个日志框架，如果这个日志框架在项目中没有的话，就使用看看一个有没有，以此类推。

private static void tryImplementation(Runnable runnable) { 
        if (logConstructor == null) { 
          try { 
            runnable.run();
          } catch (Throwable t) { 
            // ignore
          }
        }
      }

可以看到，如果logConstructor 是null的话，就执行LogFactory::useSlf4jLogging 方法或者是其他类似的方法。比如说我们LogFactory::useSlf4jLogging这个方法给logConstructor 赋上值的话，其他的就不会往下走了。  
我们这里就以useSlf4jLogging 看看怎样使用slf4j日志框架的。

public static synchronized void useSlf4jLogging() { 
       setImplementation(org.apache.ibatis.logging.slf4j.Slf4jImpl.class);
     }
    private static void setImplementation(Class<? extends Log> implClass) { 
      try { 
        Constructor<? extends Log> candidate = implClass.getConstructor(String.class);
        Log log = candidate.newInstance(LogFactory.class.getName());
        if (log.isDebugEnabled()) { 
          log.debug("Logging initialized using '" + implClass + "' adapter.");
        }
        logConstructor = candidate;
      } catch (Throwable t) { 
        throw new LogException("Error setting Log implementation. Cause: " + t, t);
      }
    }

setImplementation 这个方法就是 创建某个适配类对象，这里就是org.apache.ibatis.logging.slf4j.Slf4jImpl，如果能够创建成功的话，就给  
logConstructor 赋值，不成功也无所谓，继续下一个日志框架就好了。  
接下来我们看看 org.apache.ibatis.logging.slf4j.Slf4jImpl 类构造 以及mybatis是怎样适配的slf4j的。

#### 2. 适配slf4j日志框架 ####

public class Slf4jImpl implements Log

Slf4jImpl 实现 mybatis Log 接口。  
看看它的构造

public Slf4jImpl(String clazz) { 
        Logger logger = LoggerFactory.getLogger(clazz);
        if (logger instanceof LocationAwareLogger) { 
          try { 
            // check for slf4j >= 1.6 method signature
            logger.getClass().getMethod("log", Marker.class, String.class, int.class, String.class, Object[].class, Throwable.class);
            log = new Slf4jLocationAwareLoggerImpl((LocationAwareLogger) logger);
            return;
          } catch (SecurityException | NoSuchMethodException e) { 
            // fail-back to Slf4jLoggerImpl
          }
        }

这里就是使用LoggerFactory 获取log对象，需要注意的是Logger ， LoggerFactory都是slf4j自己的。

import org.apache.ibatis.logging.Log;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.slf4j.Marker;
    import org.slf4j.spi.LocationAwareLogger;

如果我们项目中没有slf4j的话，就会抛出异常的，然后setImplementation 就会捕获到，然后也就不会走赋值logConstructor 那行代码了。  
它这里稍微复杂一点点，判断了logger 是不是LocationAwareLogger 类型，如果是的话又把log 包了一层。其中Slf4jLocationAwareLoggerImpl也是实现mybatis Log接口的  
这里我们先看看Slf4jImpl 那些实现Log接口的方法。

@Override
      public boolean isDebugEnabled() { 
        return log.isDebugEnabled();
      }
      @Override
      public boolean isTraceEnabled() { 
        return log.isTraceEnabled();
      }
      @Override
      public void error(String s, Throwable e) { 
        log.error(s, e);
      }
      @Override
      public void error(String s) { 
        log.error(s);
      }

可以看到都是找的log 对象对应方法，这个log对象也就是Slf4jLocationAwareLoggerImpl 。  
我们再来看看Slf4jLocationAwareLoggerImpl 实现mybatis Log接口的方法。

@Override
      public boolean isDebugEnabled() { 
        return logger.isDebugEnabled();
      }
      @Override
      public boolean isTraceEnabled() { 
        return logger.isTraceEnabled();
      }
      @Override
      public void error(String s, Throwable e) { 
        logger.log(MARKER, FQCN, LocationAwareLogger.ERROR_INT, s, null, e);
      }
      @Override
      public void error(String s) { 
        logger.log(MARKER, FQCN, LocationAwareLogger.ERROR_INT, s, null, null);
      }

这里就是真正调用slf4j 日志框架的logger对象来输出日志的。

### 总结 ###

本文主要介绍了一下mybatis日志模块，mybatis日志模块使用适配器设计模式，通过统一日志接口适配各种日志框架打印实现。  
而mybatis选用哪款日志框架，要看你项目中有没有这个框架的依赖。采用挨个试的方式来选用日志框架，日志框架顺序是：slf4j ，apache common log ，log4j2，log4j，jdk logger。这些都没有的话就不打印日志了。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70]: /images/20220829/e9a31a4d59ea43f792f4d3ae5ecc7f85.png