mybatis打印的sql日誌不寫入到log文件問題解決

問題描述

環境： java 1.8、spring boot 2.2.4、mybatis-spring-boot-starter 2.1.1

在一次上線調bug中，想看看執行的sql語句，結果tail -100f這個日誌文件發現sql語句沒有輸出到這個文件裏面，然後在本地運行從console中又能看到有sql打印。

問題分析

第一時間想到會不會是logback配置不對

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    ​
    <!-- 配置獲取spring應用名稱-->
    <springProperty scope="context" name="springAppName" source="spring.application.name"/>

    <!-- 日誌輸出文件的命名及地址-->
    <property name="LOG_FILE" value="logs/${springAppName}-%d{yyyy-MM-dd}.log"/>​

    <!-- 控制檯輸出日誌格式 -->
    <property name="CONSOLE_LOG_PATTERN"
              value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"/>

    <!-- 控制檯輸出級別及格式等 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
    </appender>

    <!-- 平臺文件的輸出配置：輸出文件命名、輸出級別等 -->​
    <appender name="flatfile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_FILE}.gz</fileNamePattern>
            <maxHistory>3</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
    </appender>

    <!-- 配置日誌輸出級別 -->
    <root level="DEBUG">
        <appender-ref ref="console"/>
        <appender-ref ref="flatfile"/>
    </root>

</configuration>

logback配置如上，就是兩個appender，一個輸console一個輸file，都是debug級別，所以這個配置文件是沒有問題的

然後發現到，console中打印的日誌好像是被直接sout在上面的，不是logback打印的，所以肯定就不會輸出到上面配置的文件裏面啦

現在很好奇這個sout是從哪裏打印出來的
下面使用了arthas的redefine
關於arthas： Arthas 是阿里巴巴最近纔開源出來的一款 Java 診斷利器。主要是針對線上環境，也就是生產環境
git地址： https://github.com/alibaba/arthas
由於字符串拼接基本都是通過StringBuilder來實現的，所以這裏redefine StringBuilder

    @Override
    public String toString() {
        // Create a copy, don't share the array
	    	String result = new String(value, 0, count);
	    	if(result.contains("Preparing:")) {
	    		System.err.println(result);
	    		new Throwable().printStackTrace();
	    	}
        return result;

    }

這裏將StringBuilder的toString方法加了點料，將preparing就是打印sql的地方，把堆棧打印了出來，javac編譯後，然後redefine StringBuilder.class

redefine成功之後，再去觸發sql打印

發現是從BaseJdbcLogger這裏調用的

    protected void debug(String text, boolean input) {
        if (this.statementLog.isDebugEnabled()) {
            this.statementLog.debug(this.prefix(input) + text);
        }

    }

就是這個地方調用的debug，是statementLog這個對象的方法

public abstract class BaseJdbcLogger {
    protected static final Set<String> SET_METHODS = new HashSet();
    protected static final Set<String> EXECUTE_METHODS = new HashSet();
    private final Map<Object, Object> columnMap = new HashMap();
    private final List<Object> columnNames = new ArrayList();
    private final List<Object> columnValues = new ArrayList();
    protected Log statementLog;
    protected int queryStack;
    
    public BaseJdbcLogger(Log log, int queryStack) {
        this.statementLog = log;
        if (queryStack == 0) {
            this.queryStack = 1;
        } else {
            this.queryStack = queryStack;
        }

    }
    ……
}

注意到這個statementLog和構造方法，statementLog是一個Log接口實現，是從構造方法中傳入Log的實現類對象的

package org.apache.ibatis.logging;

public interface Log {
    boolean isDebugEnabled();

    boolean isTraceEnabled();

    void error(String var1, Throwable var2);

    void error(String var1);

    void debug(String var1);

    void trace(String var1);

    void warn(String var1);
}

它包含了四種日誌級別，以及debug、trace開關

Log接口的實現類就是我們常用的日誌框架的日誌門面類slf4j、log4j2等等，這些日誌門面會找到具體的日誌實現框架，目前的環境就是slf4j -> logback這種實現

接下來就在構造方法裏打斷點debug

發現傳入的是一個StdOutImpl，一看就是sout的實現

package org.apache.ibatis.logging.stdout;

import org.apache.ibatis.logging.Log;

public class StdOutImpl implements Log {
    public StdOutImpl(String clazz) {
    }

    public boolean isDebugEnabled() {
        return true;
    }

    public boolean isTraceEnabled() {
        return true;
    }

    public void error(String s, Throwable e) {
        System.err.println(s);
        e.printStackTrace(System.err);
    }

    public void error(String s) {
        System.err.println(s);
    }

    public void debug(String s) {
        System.out.println(s);
    }

    public void trace(String s) {
        System.out.println(s);
    }

    public void warn(String s) {
        System.out.println(s);
    }
}

所以問題出在這裏了，根據分析，這裏應該傳入Slf4jImpl這個實現纔對，然後在spring boot的debug日誌裏輸出了很多信息，搜索這個StdOutImpl

發現已經告訴了目前使用的是StdOutImpl，根據分析，問題很可能就出在了mybatis配置上

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <setting name="cacheEnabled" value="true" />
        <setting name="lazyLoadingEnabled" value="true" />
        <setting name="multipleResultSetsEnabled" value="true" />
        <setting name="useColumnLabel" value="true" />
        <setting name="defaultExecutorType" value="REUSE" />
        <setting name="defaultStatementTimeout" value="25000" />
        <setting name="logImpl" value="STDOUT_LOGGING" />
        <!-- 開啓駝峯命名轉換：Table(create_time) -> Entity(createTime)  -->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>
</configuration>

這就是該項目使用的mybatis的配置，發現了logImpl，stdout，應該就是在這裏配置的

查文檔發現這裏可以配置這麼多，所以改成SLF4J就ok了

這個實現類就成功變成了Slf4jImpl，日誌文件裏面也有了sql打印

問題解決

修改mybatis配置文件中的

<setting name="logImpl" value="STDOUT_LOGGING" />

變爲

<setting name="logImpl" value="SLF4J" />

或者刪掉也行

總結：
spring boot中mybatis的sql打印實際上就把logback配置修改爲debug級別就可以了，
像mybatis配置logImpl，application.properties中寫logging.level.com.xxx.dao=debug都是不必要的，除非需要一些細粒度的控制
特別注意:mybatis如果要配置logImpl的話儘量不要使用STDOUT_LOGGING！