Mybatis日志体系

　　承接上一篇关于spring 5.x的日志体系，本篇看看Mybatis的日志体系及实现，Mybatis版本基于3.x。

　　关于mybatis的官方文档比较友好，分门别类，各有论述，如mybatis官方文档详见https://mybatis.org/mybatis-3/#，mybatis与spring的官方文档详见http://mybatis.org/spring/index.html，与springboot相关的参见http://mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure/#，官方文档写的很完备，也适合初学者。

Mybatis环境搭建及日志展示

　　研究mybatis日志，有必要写一个demo，该有的数据库（Mysql）相关的jar包依赖都应该有，pom文件如下。

 <dependency>
     <groupId>org.mybatis</groupId>
     <artifactId>mybatis</artifactId>
     <version>3.4.6</version>
 </dependency>

 <dependency>
     <groupId>org.mybatis</groupId>
     <artifactId>mybatis-spring</artifactId>
     <version>1.3.2</version>
 </dependency>

 <dependency>
     <groupId>mysql</groupId>
     <artifactId>mysql-connector-java</artifactId>
     version>8.0.13</version>
 </dependency>

 <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>spring-jdbc</artifactId>
     <version>5.1.3.RELEASE</version>
 </dependency>

 <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>spring-context</artifactId>
     <version>5.1.3.RELEASE</version>
 </dependency>

　　配置mybatis环境：java config风格获取一个SqlSessionFactoryBean和动态动态注入一个数据源dataSource，连接本地的数据库company，表为user。

 @Configuration
 @ComponentScan("com.mystyle")
 @MapperScan("com.mystyle.dao")
 public class MybatisConfig {
     @Bean
     @Autowired
     public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) throws Exception {
         SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
         sqlSessionFactoryBean.setDataSource(dataSource);
 //        org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
 //        configuration.setLogImpl(Log4jImpl.class);
 //        sqlSessionFactoryBean.setConfiguration(configuration);
         return sqlSessionFactoryBean;
     }

     @Bean
     public DataSource dataSource() {
        DriverManagerDataSource driverManagerDataSource = new DriverManagerDataSource();
        driverManagerDataSource.setUsername("root");
        driverManagerDataSource.setPassword("12345678");
        driverManagerDataSource.setUrl("jdbc:mysql://localhost:3306/company?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC");
        driverManagerDataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");
        return driverManagerDataSource;

     }

 }

　　注：注释的代码请先忽略，后续会用到。

　写一个UserDao，查询出user表中的user信息

public interface UserDao {
    @Select("select * from user")
    List<Map<String,String>> queryUsers();
}

　　运行完成之后，可以看到console成功打印出了user的信息，但是除此之外，并未看到我们想要的打印出sql语句等信息。

Mybatis日志代码跟踪

　　在MybatisConfig的sqlSessionFactory方法中，new出了一个SqlSessionFactoryBean，在SqlSessionFactoryBean类中可以看到一个关于Logger的私有对象的声明并初始化。

public class SqlSessionFactoryBean implements FactoryBean<SqlSessionFactory>, InitializingBean, ApplicationListener<ApplicationEvent> {
  private static final Log LOGGER = LogFactory.getLog(SqlSessionFactoryBean.class);

　　在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 {
　　　　　//1.启动线程
     tryImplementation(new Runnable() {
       @Override
       public void run() {
　　　　　　　 //2。加载日志类，返回构造器
         useSlf4jLogging();
       }
     });
     tryImplementation(new Runnable() {
       @Override
       public void run() {
         useCommonsLogging();
       }
     });
     tryImplementation(new Runnable() {
       @Override
       public void run() {
         useLog4J2Logging();
       }
     });
     tryImplementation(new Runnable() {
       @Override
       public void run() {
         useLog4JLogging();
       }
     });
     tryImplementation(new Runnable() {
       @Override
       public void run() {
         useJdkLogging();
       }
     });
     tryImplementation(new Runnable() {
       @Override
       public void run() {
         useNoLogging();
       }
     });
   }

   private LogFactory() {
     // disable construction
   }

   public static Log getLog(Class<?> aClass) {
     return getLog(aClass.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);
     }
   }

   public static synchronized void useCustomLogging(Class<? extends Log> 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);
   }

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

   private static void setImplementation(Class<? extends Log> implClass) {
     try {
       Constructor<? extends Log> candidate = implClass.getConstructor(String.class);
　　　　　　//3. 试图去实例化一个实现类的日志对象
       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);
     }
   }

 }

　　 LogFactory在加载时，有一个静态代码块，会依次去加载各种日志产品的实现，请其中的顺序是 SLF4J > Apache Commons Logging > Log4j 2 > Log4j > JDK logging。

　　以SLF4J为例说明(其余类似)：

1. 执行tryImplementation方法：如果构造器logConstructor（LogFactory中的私有变量）不为空，启动一个线程去执行其中的run 方法。
2. 具体是去执行useSlf4jLogging方法中的setImplementation方法，该方法会传入SLF4J的日志实现类的class对象：class org.apache.ibatis.logging.slf4j.Slf4jImpl。
3. 试图去实例化一个实现类的日志对象，由于此时并未加入slf4j相关jar包依赖，所以会抛一个异常出去。

　　在默认情况下，即是用户未指定得情况下，class org.apache.ibatis.logging.commons.JakartaCommonsLoggingImpl也就是Apache Commons Logging会默认实例化成功，spring默认使用此日志实现，由于存在该实现依赖，所以会被实例化成功，并返回其构造器。SqlSessionFactoryBean中调用的getLog方法实际是返回了一个基于JCL实现的日志对象。

用户指定Mybatis日志实现类

　　假设用户需要使得Mybatis使用的日志是基于log4j的，同样，首先需要在pom中先添加基于log4j的相关依赖，log4j.properties配置文件添加，在sqlSessionFactoryBean实例化时通过configuration去手动指定logimpl为log4J。

 public void setLogImpl(Class<? extends Log> logImpl) {
     if (logImpl != null) {
       this.logImpl = logImpl;
       LogFactory.useCustomLogging(this.logImpl);
     }
   }

　　实际内部是去调用了LogFactory的useCustomLogging方法。

   public static synchronized void useCustomLogging(Class<? extends Log> clazz) {
     setImplementation(clazz);
   }

　　其余和上述流程一样，把factory中的日志实现类更新为用户所指定的实现类。

日志打印效果

 DEBUG - Logging initialized using 'class org.apache.ibatis.logging.log4j.Log4jImpl' adapter.
 DEBUG - Creating a new SqlSession
 DEBUG - SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@4716be8b] was not registered for synchronization because synchronization is not active
 DEBUG - JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@3faf2e7d] will not be managed by Spring
 DEBUG - ==>  Preparing: select * from user
 DEBUG - ==> Parameters:
 DEBUG - <==      Total: 7
 DEBUG - Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@4716be8b]
 [{eventId=1, count_num=1, name=tom, id=1}, {eventId=2, count_num=2, name=jack, id=2}, {eventId=7, count_num=2, name=david, id=3}, {eventId=3, count_num=2, name=david, id=4}, {eventId=4, count_num=0, name=david, id=5}, {eventId=5, count_num=1, name=david, id=6}, {eventId=6, count_num=0, name=lily, id=7}]
 Disconnected from the target VM, address: '127.0.0.1:53155', transport: 'socket'

　　可以看到日志打印出的格式以及内容都是我们所想要的。