使用Mybatis的時候,有些時候能輸出(主要是指sql,參數,結果)日誌。有些時候就不能。
無法輸出日誌的時候,無論怎麼配置log4j,不管是properties的還是xml的,都不起作用。
有些時候,我們沒做什麼配置就能輸出日誌....
這是一個讓無數人煩躁的問題。其實解決問題很容易(我過了這麼久才解決,以前都用攔截器輸出)。
這是一個普大喜奔的日子,讓我們一起來看看如何解決mybatis的日誌問題。
爲什麼說這個問題很容易解決呢?因爲mybatis的文檔寫的很清楚。
爲什麼我們都沒找到解決辦法呢?因爲即使看過文檔的人,也未必去看Logging這一節。但是這一節正是解決問題的關鍵。
已經等不及的小夥伴們可以直接去這裏看文檔:http://mybatis.github.io/mybatis-3/zh/logging.html
提醒最常用的方法不再這個鏈接中,但是這個文檔提供了對log4j的詳細配置。本文下面的內容大部分是這個文檔的Copy。
Mybatis內置的日誌工廠提供日誌功能,具體的日誌實現有以下幾種方式:
- SLF4J
- Apache Commons Logging
- Log4j 2
- Log4j
- JDK logging
具體選擇哪個日誌實現由MyBatis的內置日誌工廠確定。它會使用最先找到的(按上文列舉的順序查找)。 如果一個都未找到,日誌功能就會被禁用。
不少應用服務器的classpath中已經包含Commons Logging,如Tomcat和WebShpere, 所以MyBatis會把它作爲具體的日誌實現。
記住這點非常重要。這意味着,在諸如 WebSphere的環境中——WebSphere提供了Commons Logging的私有實現,你的Log4J配置將被忽略。
這種做法不免讓人悲摧,MyBatis怎麼能忽略你的配置呢?事實上,因Commons Logging已經存 在,按優先級Log4J自然就被忽略了!
不過,如果你的應用部署在一個包含Commons Logging的環境, 而你又想用其他的日誌框架,你可以根據需要調用如下的某一方法:
- org.apache.ibatis.logging.LogFactory.useSlf4jLogging();
- org.apache.ibatis.logging.LogFactory.useLog4JLogging();
- org.apache.ibatis.logging.LogFactory.useJdkLogging();
- org.apache.ibatis.logging.LogFactory.useCommonsLogging();
- org.apache.ibatis.logging.LogFactory.useStdOutLogging();
如果的確需要調用以上的某個方法,請在調用所有其他MyBatis方法前調用它。另外,只有在相應日誌實現存在 的前提下,調用對應的方法纔是有意義的,否則MyBatis一概忽略。如你環境中並不存在Log4J,你卻調用了 相應的方法,MyBatis就會忽略這一調用,代之默認的查找順序查找日誌實現。
例如使用log4j就需要在調用mybatis方法前,先執行代碼:
- org.apache.ibatis.logging.LogFactory.useLog4JLogging();
上面這是一種解決辦法,但是有些情況你不知道何時執行這個方法。
mybatis還提供了另外一種(推薦使用這種)解決方法,繼續看下面。
另一種解決爲,在mybatis-config.xml配置文件中:
- <configuration>
- <settings>
- <setting name="logImpl" value="LOG4J"/>
- </settings>
- </configuration>
這裏只寫了關鍵的一部分配置信息,在你自己配置的基礎上增加<setting name="logImpl" value="LOG4J"/>即可。這樣一來log4j的配置信息就會起作用。
參數說明:
Mybatis對Log4j的配置支持:
MyBatis可以對包、類、命名空間和全限定的語句記錄日誌。
具體怎麼做,視使用的日誌框架而定,這裏以Log4J爲例。配置日誌功能非常簡單:添加幾個配置文件, 如log4j.properties,再增加個jar包,如log4j.jar。下面是具體的例子,共兩個步驟:
因爲採用Log4J,要確保在應用中對應的jar包是可用的。要滿足這一點,只要將jar包添加到應用的classpath中即可。 Log4J的jar包可以從上方的鏈接下載。
具體而言,對於web或企業應用,需要將log4j.jar 添加到WEB-INF/lib 目錄; 對於獨立應用, 可以將它添加到jvm的-classpath啓動參數中。
配置Log4J比較簡單, 比如需要記錄這個mapper接口的日誌:
- package org.mybatis.example;
- public interface BlogMapper {
- @Select("SELECT * FROM blog WHERE id = #{id}")
- Blog selectBlog(int id);
- }
只要在應用的classpath中創建一個名稱爲log4j.properties的文件, 文件的具體內容如下:
- # Global logging configuration
- log4j.rootLogger=ERROR, stdout
- # MyBatis logging configuration...
- log4j.logger.org.mybatis.example.BlogMapper=TRACE
- # Console output...
- log4j.appender.stdout=org.apache.log4j.ConsoleAppender
- log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
- log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
添加以上配置後,Log4J就會把 org.mybatis.example.BlogMapper 的詳細執行日誌記錄下來,對於應用中的其它類則僅僅記錄錯誤信息。
也可以將日誌從整個mapper接口級別調整到到語句級別,從而實現更細粒度的控制。如下配置只記錄 selectBlog語句的日誌:
- log4j.logger.org.mybatis.example.BlogMapper.selectBlog=TRACE
與此相對,可以對一組mapper接口記錄日誌,只要對mapper接口所在的包開啓日誌功能即可:
- log4j.logger.org.mybatis.example=TRACE
某些查詢可能會返回大量的數據,只想記錄其執行的SQL語句該怎麼辦?爲此,Mybatis中SQL語 句的日誌級別被設爲DEBUG(JDK Logging中爲FINE),結果日誌的級別爲TRACE(JDK Logging中爲FINER)。所以,只要將日誌級別調整爲DEBUG即可達到目的:
- log4j.logger.org.mybatis.example=DEBUG
要記錄日誌的是類似下面的mapper文件而不是mapper接口又該怎麼呢?
- <?xml version="1.0" encoding="UTF-8" ?>
- <!DOCTYPE mapper
- PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
- "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
- <mapper namespace="org.mybatis.example.BlogMapper">
- <select id="selectBlog" resultType="Blog">
- select * from Blog where id = #{id}
- </select>
- </mapper>
對這個文件記錄日誌,只要對命名空間增加日誌記錄功能即可:
- log4j.logger.org.mybatis.example.BlogMapper=TRACE
進一步,要記錄具體語句的日誌可以這樣做:
- log4j.logger.org.mybatis.example.BlogMapper.selectBlog=TRACE
看到了把,兩種配置沒差別!
配置文件log4j.properties的餘下內容是針對日誌格式的,這一內容已經超出本 文檔範圍。關於Log4J的更多內容,可以參考Log4J的網站。不過,可以簡單試一下看看,不同的配置 會產生什麼不一樣的效果。
## jar包環境,mybatis-3.2.3,mybatis-spring-1.2.2
mybatis-3.2.3以上才支持logImpl
mybatis-spring-1.2.2會導致sqlSessionFactoryBean在spring加載properties之前初始化,會報無法識別${jdbc.url}之類的錯誤
解決方法是註釋掉<property name="sqlSessionFactory" ref="sqlSessionFactory"/> 即可