Mybatis打印SQL日志

2020-07-08

1.支持日志框架

mybatis支持使用多种日志框架来打印sql，包括：slf4j、commons-logging、log4j、log4j2、jdk logging、stdout、no logging等。因此在打印日志时，我们首要确定自己使用的日志框架是什么，然后进行相应的配置。

默认情况下，mybatis按照如下方式检测需要使用的日志框架实现：

slf4j-->commons-logging-->log4j2-->log4j-->jdk logging(jul)-->no logging

在3.5.5 mybatis的org.Apache.ibatis.logging.LogFactory类的源码中体现：

mybatis日志工厂

其中slf4j，commons-logging都是facade设计模式的实现，底层需要依赖具体的日志框架，如log4j、log4j2、logback等。并且还要引入相应的桥接jar包依赖。

对于日志框架jar包依赖缺少或者冲突的情况，mybatis提供了一个终极解决方案，通过logImpl配置来强制指定使用哪个日志框架，使用方式如下所示：

<settings>
        <setting name="logImpl" value="LOG4J"/>
 </settings>

其中，STDOUT_LOGGING表示打印日志到控制台。NO_LOGGING表示不打印日志。

下面这张图列表出了slf4j在和各种底层日志框架如何整合，以及相应的需要引入的桥接jar包，详见slf4j官网：http://www.slf4j.org/manual.html

slf4j日志框架整合

2.打印日志案例

本案例以log4jdbc + log4j来打印mybatis日志。

pom.xml引入以下依赖：

        <!--log4jdbc-->
        <dependency>
            <groupId>org.bgee.log4jdbc-log4j2</groupId>
            <artifactId>log4jdbc-log4j2-jdbc4.1</artifactId>
            <version>1.16</version>
        </dependency>
        <!--slf4j-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.30</version>
        </dependency>
        <!--桥接,依赖log4j坐标-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.7.30</version>
        </dependency>

mybatis-config.xml添加日志配置：

  <settings>
    <setting name="logImpl" value="LOG4J"/>
  </settings>

jdbc.properties进行数据库连接配置：

jdbc.driver=net.sf.log4jdbc.sql.jdbcapi.DriverSpy
jdbc.url=jdbc:log4jdbc:MySQL://127.0.0.1:3306/cms?useUnicode=true&characterEncoding=utf8&useSSL=false
jdbc.username=root
jdbc.password=root

log4j.properties进行日志配置：

log4j.rootLogger=INFO,Console
    
#Console    
log4j.Appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Target=System.out
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
  
log4j.logger.org.apache=ERROR
log4j.logger.org.mybatis=ERROR
log4j.logger.mybatis=DEBUG
log4j.logger.log4jdbc.debug=ERROR
  
log4j.logger.jdbc.audit=ERROR
log4j.logger.jdbc.resultset=OFF
log4j.logger.jdbc.sqlonly=DEBUG
log4j.logger.jdbc.sqltiming=ERROR
log4j.logger.jdbc.connection=FATAL
log4j.logger.jdbc.resultsettable=INFO

log4jdbc.log4j2.properties进行配置：

log4jdbc.spylogdelegator.name=net.sf.log4jdbc.log.slf4j.Slf4jSpyLogDelegator

junit测试代码如下：

    @Test
    void getList() {
        User user = User.builder().id(1).build();
        List<User> userList = userDao.getList(user);
//        userList.forEach(x -> log.info("===>{}",x));
        assertNotNull(userList);
    }

控制台打印效果如下：

控制台SQL语句

3.日志最佳实践

一般在生产环境中应用系统，日志级别调整为INFO或者WARN以避免过多的输出日志。但某些时候，需要跟踪具体问题，那么就得打开DEBUG日志。但是如果设置root logger为DEBUG级别，则需要的信息就会淹没在日志的海洋中。

此时，需要单独指定某个或者某些logger(如mybatis打印sql的logger)的日志级别为DEBUG，而root logger保持INFO或WARN不变。