mybatis打印的sql日志不寫入到log文件的問題及解決
問題描述
環(huán)境： java 1.8、spring boot 2.2.4、mybatis-spring-boot-starter 2.1.1
在一次上線調bug中，想看看執(zhí)行的sql語句，結果tail -100f這個日志文件發(fā)現(xiàn)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級別，所以這個配置文件是沒有問題的
然后發(fā)現(xiàn)到，console中打印的日志好像是被直接sout在上面的，不是logback打印的，所以肯定就不會輸出到上面配置的文件里面啦
現(xiàn)在很好奇這個sout是從哪里打印出來的
下面使用了arthas的redefine
關于arthas： Arthas 是阿里巴巴最近才開源出來的一款 Java 診斷利器。主要是針對線上環(huán)境，也就是生產(chǎn)環(huán)境
git地址： https://github.com/alibaba/arthas
由于字符串拼接基本都是通過StringBuilder來實現(xiàn)的，所以這里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成功之后，再去觸發(fā)sql打印
發(fā)現(xiàn)是從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接口實現(xiàn)，是從構造方法中傳入Log的實現(xiàn)類對象的
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接口的實現(xiàn)類就是我們常用的日志框架的日志門面類slf4j、log4j2等等，這些日志門面會找到具體的日志實現(xiàn)框架，目前的環(huán)境就是slf4j -> logback這種實現(xiàn)
接下來就在構造方法里打斷點debug
發(fā)現(xiàn)傳入的是一個StdOutImpl，一看就是sout的實現(xiàn)
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);
}
}所以問題出在這里了，根據(jù)分析，這里應該傳入Slf4jImpl這個實現(xiàn)才對，然后在spring boot的debug日志里輸出了很多信息，搜索這個StdOutImpl
發(fā)現(xiàn)已經(jīng)告訴了目前使用的是StdOutImpl，根據(jù)分析，問題很可能就出在了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的配置，發(fā)現(xiàn)了logImpl，stdout，應該就是在這里配置的
查文檔發(fā)現(xiàn)這里可以配置這么多，所以改成SLF4J就ok了
這個實現(xiàn)類就成功變成了Slf4jImpl，日志文件里面也有了sql打印
問題解決
修改mybatis配置文件中的
<setting name="logImpl" value="STDOUT_LOGGING" />
變?yōu)?/p>
<setting name="logImpl" value="SLF4J" />
或者刪掉也行
總結
sout輸出的是不會記錄在日志文件中的，必須使用log的方式才能記錄，這也是我們在捕獲異常或全局異常處理，要使用log.error("", e);替代e.printStackTrace();的原因
spring boot中mybatis的sql打印實際上就把logback配置修改為debug級別就可以了，
像mybatis配置logImpl，application.properties中寫logging.level.com.xxx.dao=debug都是不必要的，除非需要一些細粒度的控制
特別注意：mybatis如果要配置logImpl的話盡量不要使用STDOUT_LOGGING！
以上僅為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
這篇文章主要為大家詳細介紹了java使用Socket實現(xiàn)文件上傳功能，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-02-02
這篇文章主要介紹了Java中的List接口實現(xiàn)類解析，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-02-02
詳解如何實現(xiàn)OpenAPI開發(fā)動態(tài)處理接口的返回數(shù)據(jù)
這篇文章主要為大家介紹了OpenAPI開發(fā)動態(tài)處理接口的返回數(shù)據(jù)如何實現(xiàn)詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-04-04
spring-boot統(tǒng)一異常捕獲,異常時相對于return的一種退出機制,可以由系統(tǒng)觸發(fā),下面這篇文章主要給大家介紹了關于SpringBoot配置全局異常處理器捕獲異常的相關資料,需要的朋友可以參考下2023-04-04
Apache Flink 以其獨特的方式來處理數(shù)據(jù)類型以及序列化,這種方式包括它自身的類型描述符、泛型類型提取以及類型序列化框架.本文檔描述了它們背后的概念和基本原理,需要的朋友可以參考下2021-06-06
SpringBoot中@Transiactional注解沒有效果的解決
這篇文章主要介紹了SpringBoot中@Transiactional注解沒有效果的解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-08-08
多個SpringBoot項目采用redis實現(xiàn)Session共享功能
這篇文章主要介紹了多個SpringBoot項目采用redis實現(xiàn)Session共享,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-09-09
這篇文章主要為大家介紹了java面向對象設計原則之迪米特法則的示例分析詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，學有所得2021-10-10
在SpringBoot與Mybatis整合開發(fā)中,開啟控制臺SQL語句打印是一個常見需求,有助于調試與性能優(yōu)化,方法一：在Mybatis配置文件mybatis-config.xml中添加設置；方法二：在SpringBoot配置文件application.yml或properties中2024-11-11
下面小編就為大家?guī)硪黄猄pringMvc入門指南(必看)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2016-06-06