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的方式才能記錄，這也是我們在捕獲異?；蛉之惓Ｌ幚恚?strong>要使用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)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
Druid(新版starter)在SpringBoot下的使用教程
Druid是Java語言中最好的數(shù)據(jù)庫連接池，Druid能夠提供強大的監(jiān)控和擴展功能，DruidDataSource支持的數(shù)據(jù)庫，這篇文章主要介紹了Druid(新版starter)在SpringBoot下的使用,需要的朋友可以參考下2023-05-05
SpringCloud服務注冊和發(fā)現(xiàn)組件Eureka
對于微服務的治理而言，其核心就是服務的注冊和發(fā)現(xiàn)。在SpringCloud 中提供了多種服務注冊與發(fā)現(xiàn)組件，官方推薦使用Eureka。本篇文章，我們來講解springcloud的服務注冊和發(fā)現(xiàn)組件，感興趣的可以了解一下2021-05-05
spring boot springMVC擴展配置實現(xiàn)解析
這篇文章主要介紹了spring boot springMVC擴展配置實現(xiàn)解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-08-08
SpringBoot日志配置SLF4J和Logback的方法實現(xiàn)
日志記錄是不可或缺的一部分,本文主要介紹了SpringBoot日志配置SLF4J和Logback的方法實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2025-04-04
Spring?Boot?MQTT?Too?many?publishes?in?progress錯誤的解決方
本文介紹Spring?Boot?MQTT?Too?many?publishes?in?progress錯誤的解決方案，文章圍繞主題展開詳細的內(nèi)容介紹，具有一定的參考價值，感興趣的小伙伴可以參考一下2022-07-07
這篇文章主要介紹了Java設計模式之備忘錄模式詳解,備忘錄模式在不破壞封裝性的前提下,捕獲一個對象的內(nèi)部狀態(tài)并在該對象之外保存這個狀態(tài),這樣以后就可以將該對象恢復到原先保存的狀態(tài),需要的朋友可以參考下2023-12-12
Maven在Java8下如何忽略Javadoc的編譯錯誤詳解
這篇文章主要給大家介紹了關于Maven在Java8下如何忽略Javadoc的編譯錯誤的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2018-08-08
SpringSecurity自定義登錄接口的實現(xiàn)
本文介紹了使用Spring Security實現(xiàn)自定義登錄接口,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2025-01-01
Java中的線程池ThreadPoolExecutor細致講解
這篇文章主要介紹了Java中的線程池ThreadPoolExecutor細致講解,線程池是一種基于池化思想管理線程的工具,經(jīng)常出現(xiàn)在多線程服務器中,如MySQL,線程過多會帶來額外的開銷,其中包括創(chuàng)建銷毀線程的開銷、調度線程的開銷等等,需要的朋友可以參考下2023-11-11
mybatis于xml方式和注解方式實現(xiàn)多表查詢的操作方法
在數(shù)據(jù)庫中,單表的操作是最簡單的,但是在實際業(yè)務中最少也有十幾張表,并且表與表之間常常相互間聯(lián)系,本文給大家介紹mybatis于xml方式和注解方式實現(xiàn)多表查詢的操作方法,感興趣的朋友一起看看吧2023-12-12