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>
logImpl的取值范圍:SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING
其中,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不變。