Logging日誌資訊

標籤：blog   http   java   使用   檔案   資料   

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介紹已經超出本文檔的範圍。 不過，下面的例子可以作為一個快速入門。關於這些日誌架構的更多資訊，可以參考以下連結：

• Apache Commons Logging
• Apache Log4j
• JDK Logging API

Logging Configuration

MyBatis可以對包、類、命名空間和全限定的語句記錄日誌。

具體怎麼做，視使用的日誌架構而定，這裡以Log4J為例。配置日誌功能非常簡單：添加幾個設定檔， 如log4j.properties,再增加個jar包，如log4j.jar。下面是具體的例子，共兩個步驟：

步驟1： 增加Log4J jar包

因為採用Log4J，要確保在應用中對應的jar包是可用的。要滿足這一點，只要將jar包添加到應用的classpath中即可。 Log4J的jar包可以從上方的連結下載。

具體而言，對於web或公司專屬應用程式，需要將log4j.jar 添加到WEB-INF/lib 目錄； 對於獨立應用， 可以將它添加到jvm的 -classpath啟動參數中。

步驟2：配置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 configurationlog4j.rootLogger=ERROR, stdout# MyBatis logging configuration...log4j.logger.org.mybatis.example.BlogMapper=TRACE# Console output...log4j.appender.stdout=org.apache.log4j.ConsoleAppenderlog4j.appender.stdout.layout=org.apache.log4j.PatternLayoutlog4j.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的網站。不過，可以簡單試一下看看，不同的配置 會產生什麼不一樣的效果。