Mybatis源码分析(一)

准备

在阅读源码前,需要先clone源码 地址:https://github.com/mybatis/my...

Mybatis框架使用大量常见的设计模式,学习Mybatis源码我们主要学习以下几点:

• 学习大佬们的编码思想及规范
• 学习一些传承下来的设计模式
• 实践java基础理论

带着问题阅读源码

• 问题1:源码中用了哪些设计模式？为什么要用这些设计模式？
• 问题2.Mybatis打开调试模式之后，能打印sql语句等信息，这是怎么实现的？实现过程中使用了什么设计模式？假如有多个日志实现,加载顺序是什么?

带着这些个问题 我们去源码中找寻答案
首先我们先来看看源码包功能模块图

Mybatis框架提供了一个顶层接口SqlSession ,核心处理层,基础支撑层 这里使用了一个常见的设计模式:外观模式/门面模式
今天我们主要讲解基础支撑层中日志模块内部是如何处理的.

源码-logging

打开源码项目,可以看到有20个目录,这里我们先不深入去看,把目光聚焦到logging目录

那么有那么多日志实现,他的加载顺序是什么呢.到这里我们会想到刚刚看到的LogFactory类,大叫都知道工厂方法就是用来获取实例的既然要获取实例那么他的处理也肯定在工厂内部处理完毕了(这里使用了简单工厂模式) 那么我们打开LogFactory类来看看他的加载顺序到底是怎么实现的:

import java.lang.reflect.Constructor;


public final class LogFactory {


  public static final String MARKER = "MYBATIS";

  private static Constructor logConstructor; //定义logConstructor 他继承于Constructor

  static {    //加载顺序在这里.初始化时必定按照这个顺序执行,可以发现下面这一排排就是我们刚刚看到的各个适配器
    tryImplementation(LogFactory::useSlf4jLogging);
    tryImplementation(LogFactory::useCommonsLogging);
    tryImplementation(LogFactory::useLog4J2Logging);
    tryImplementation(LogFactory::useLog4JLogging);
    tryImplementation(LogFactory::useJdkLogging);
    tryImplementation(LogFactory::useNoLogging);
  }

  private LogFactory() {
    // 在这里私有化构造器 就不能通过new来创建实例了
  }

  public static Log getLog(Class clazz) {//第一步.如果我们需要一个Log 那么我们就调用这个方法,传入需要的类即可
    return getLog(clazz.getName());
  }

  public static Log getLog(String logger) {//第二步.根据类的名字获取Log实现.如果获取不到会报错,这个logConstructor就是我们上面的,他内部在初始化时已经通过static的静态代码块进行了处理,所以会处理为对应的日志实现,
    try {
      return logConstructor.newInstance(logger);
    } catch (Throwable t) {
      throw new LogException("Error creating logger for logger " + logger + ".  Cause: " + t, t);
    }
  }

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

  public static synchronized void useSlf4jLogging() {//每个静态同步方法都是去调用setImplementation
    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);
  }

  private static void tryImplementation(Runnable runnable) {//将传入的代码块执行,注意这里是.run 不是.start 
    if (logConstructor == null) {//如果还没有实现才执行
      try {
        runnable.run();
      } catch (Throwable t) {//如果加载这个实现出现了异常,如:ClassNotFoundException 这个时候直接忽略,等待下一个实现调用
        // ignore
      }
    }
  }
        //在获取到一个实现成功后 会调用这个方法来初始化Log
  private static void setImplementation(Class implClass) {
    try {
      Constructor 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);
    }
  }

}

回顾一下问题:源码中用了哪些设计模式？
到目前我们看到Mybatis使用了 1.外观模式/门面模式 2.适配器模式 3简单工厂模式
到这里我们已经拿到了Log的实例不管他是通过log4j还是slf4j的实现,那他是怎么实现对日志进行增强的呢 怎么打印出来的SQL语句和参数以及结果计数的?
如果想要输出这些信息,那么首先肯定要获取到这些信息.
下面我们就去看这块,看看他是怎么获取和存贮这些信息的.

public abstract class BaseJdbcLogger {

  protected static final Set SET_METHODS;//set方法容器
  protected static final Set EXECUTE_METHODS = new HashSet<>();//执行方法容器

  private final Map columnMap = new HashMap<>();//列的键值对

  private final List