mybatis源码-基础支持层-日志模块

1. 整体了解一下

引用一段话:

无论在开发测试环境中，还是在线上生产环境中，日志在整个系统中的地位都是非常重要的。良好的日志功能可以帮助开发人员和测试人员快速定位 Bug 代码，也可以帮助运维人员快速定位性能瓶颈等问题。目前的 Java 世界中存在很多优秀的日志框架，例如 Log4j、 Log4j2、Slf4j 等。

mybatis这么优秀的框架, 肯定也会提供比较比较详细的日志输出信息, 其主要的功能由日志模块提供, mybatis日志模块主要做两件事.

• 集成常用的第三方日志框架
• 用jdk代理的实现来打印sql执行的日志

那现在就让我们来啃一下日志模块相关的源码, 首选我们看一下logging包的结构

image.png

通过看包的结构, 我们发现, 大部分的代码主要对我们常用的日志框架做适配集成, 如我们最常用的slf4j, log4j和log4j2, 而jdbc包主要提供处理sql执行时的日志打印.

然后我们大概看下这些类的关系:

image.png

---

2. LogFactory类

org.apache.ibatis.logging.LogFactory, Log的工厂类

2.1 类的构造方法

  //支持标记的日志实现将使用的标记
  public static final String MARKER = "MYBATIS";
 //日志实现的构造器, 用于创建Log接口的对象
  private static Constructor logConstructor;

  static {
    //逐个尝试, 看那个日志实现能初始化logConstructor的就直接选那个
    //初始化的时候会判断非空, 如果已经初始化了是不会重复初始化的
    tryImplementation(LogFactory::useSlf4jLogging);
    tryImplementation(LogFactory::useCommonsLogging);
    tryImplementation(LogFactory::useLog4J2Logging);
    tryImplementation(LogFactory::useLog4JLogging);
    tryImplementation(LogFactory::useJdkLogging);
    tryImplementation(LogFactory::useNoLogging);
  }

  private LogFactory() {
    // disable construction
  }

静态代码块会从上往下尝试将logConstructor变量初始化, 按照slf4j, commons-logging, log2j2, log4j, jdk-logging,no-logging的顺序尝试, 如果没有日志组件, 默认会用jdk的logging(jdk自带的, 不会少), 如果实在是jdk的logging都没有, 就不打日志

• tryImplementation(Runnable runnable)方法

private static void tryImplementation(Runnable runnable) {
    //判断如果logConstructor是空的情况下, 执行runnable的
    //这里保证了不会重复初始化
    if (logConstructor == null) {
      try {
        runnable.run();
      } catch (Throwable t) {
        // 忽略异常
      }
    }
  }

这里的Runnable是个函数接口, 可以接收jdk8的lamba表达式

• useSlf4jLogging() 方法

public static synchronized void useSlf4jLogging() {
    //调用setImplementation, 并传入slf4j的Log的实现类
    setImplementation(org.apache.ibatis.logging.slf4j.Slf4jImpl.class);
}

• 其他类同的方法, 这里就不多说了

public static synchronized void useCustomLogging(Class clazz) {
    setImplementation(clazz);
  }

  public static synchronized void useSlf4jLogging() {
    setImplementation(org.apache.ibatis.logging.slf4j.Slf4jImpl.class);
  }

  public static synchronized void useCommonsLogging() {
    setImplementation(org.apache.ibatis.logging.commons.JakartaCommonsLoggingImpl.class);
  }

  public static synchronized void useLog4JLogging() {
    setImplementation(org.apache.ibatis.logging.log4j.Log4jImpl.class);
  }

  public static synchronized void useLog4J2Logging() {
    setImplementation(org.apache.ibatis.logging.log4j2.Log4j2Impl.class);
  }

  public static synchronized void useJdkLogging() {
    setImplementation(org.apache.ibatis.logging.jdk14.Jdk14LoggingImpl.class);
  }

  public static synchronized void useStdOutLogging() {
    setImplementation(org.apache.ibatis.logging.stdout.StdOutImpl.class);
  }

  public static synchronized void useNoLogging() {
    setImplementation(org.apache.ibatis.logging.nologging.NoLoggingImpl.class);
  }

如果有自定义的日志实现, 调用useCustomLogging(Class clazz)来实现

• setImplementation(Class implClass) 方法

  private static void setImplementation(Class implClass) {
    try {
      //获取日志实现的构造方法, 构造方法带了一个字符串参数
      Constructor candidate = implClass.getConstructor(String.class);
      //尝试创建Log对象
      Log log = candidate.newInstance(LogFactory.class.getName());
      if (log.isDebugEnabled()) {
        log.debug("Logging initialized using '" + implClass + "' adapter.");
      }
      //如果创建成功, 初始化logConstructor变量
      logConstructor = candidate;
    } catch (Throwable t) {
      throw new LogException("Error setting Log implementation.  Cause: " + t, t);
    }
  }

2.2 getLog(String logger)方法

  public static Log getLog(String logger) {
    try {
      //用构造器创建Log的实例返回
      return logConstructor.newInstance(logger);
    } catch (Throwable t) {
      throw new LogException("Error creating logger for logger " + logger + ".  Cause: " + t, t);
    }
  }

2.3 getLog(Class aClass)方法

public static Log getLog(Class aClass) {
    //调用上面的```getLog(String logger)```
    return getLog(aClass.getName());
  }

---

3. Log接口

org.apache.ibatis.logging.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);
}

它的实现类比较多, 我们挑一个说一下, 其他类同

3.1 Slf4jImpl 类

public class Slf4jImpl implements Log {

  private Log log;

  public Slf4jImpl(String clazz) {
    Logger logger = LoggerFactory.getLogger(clazz);

    //如果logger 是 LocationAwareLogger
    if (logger instanceof LocationAwareLogger) {
      try {
        // check for slf4j >= 1.6 method signature
        //根据指定参数尝试获取log的方法, 如果不报错则可以创建Slf4jLocationAwareLoggerImpl
        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) {
        //如果创建不成功, 退回用Slf4jLoggerImpl
      }
    }

    // Logger is not LocationAwareLogger or slf4j version < 1.6
    log = new Slf4jLoggerImpl(logger);
  }

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

  @Override
  public void debug(String s) {
    log.debug(s);
  }

  @Override
  public void trace(String s) {
    log.trace(s);
  }

  @Override
  public void warn(String s) {
    log.warn(s);
  }

}

• 在构造方法里, 会根据不同的slf4j的版本来选择不同的实现接口

---

4 BaseJdbcLogger类

• 这个类是执行sql日志的基类, 通过它我们可以了解到mybatis是如何打印sql, 参数和返回值的

4.1 构造实现

/**
   * 缓存所有set方法的名称
   */
  protected static final Set SET_METHODS;
  /**
   * 存所有执行sql的方法
   */
  protected static final Set EXECUTE_METHODS = new HashSet<>();

  /**
   * 保存sql的参数名和参数值
   */
  private final Map columnMap = new HashMap<>();

  /**
   * 保存sql的参数名
   */
  private final List