Mybatis使用之日志相關 · Mybatis從入門到精通

# Mybatis使用之日志相關 ### 一：簡介 Mybatis提供的日志功能可以幫助我們很只管的看到最后被執行的SQL語句、執行結果等信息。大大方便開發過程中的調試。下面主要摘自Mybatis官網。 ### 日志介紹 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就會忽略這一調用，代之默認的查找順序查找日志實現。關于SLF4J、Apache Commons Logging、Apache Log4J和JDK Logging的API介紹已經超出本文檔的范圍。不過，下面的例子可以作為一個快速入門。 ### 日志配置具體怎么做，視使用的日志框架而定，這里以Log4J為例。配置日志功能非常簡單：添加幾個配置文件，如log4j.properties,再增加個jar包，如log4j.jar。下面是具體的例子，共兩個步驟： ### 步驟一：增加log4j jar包因為采用Log4J，要確保在應用中對應的jar包是可用的。要滿足這一點，只要將jar包添加到應用的classpath中即可。 Log4J的jar包可以從上方的鏈接下載。具體而言，對于web或企業應用，需要將log4j.jar 添加到WEB-INF/lib 目錄；對于獨立應用，可以將它添加到jvm的 -classpath啟動參數中。 ### 步驟二：配置log4j 配置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接口級別調整到到語句級別，從而實現更細粒度 ~~~ 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 ~~~ ### 補充更多內容：[Mybatis 目錄](http://blog.csdn.net/crave_shy/article/details/45825599)