mybatis-Logging

Logging

 

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的環境， 而你又想用其餘的日誌框架，你能夠經過在MyBatis的配置文件mybatis-config.xml裏面添加一項setting（配置）來選擇一個不一樣的日誌實現。

<configuration>
  <settings>
    ...
    <setting name="logImpl" value="LOG4J"/>
    ...
  </settings>
</configuration>

logImpl可選的值有：SLF4J、LOG4J、LOG4J二、JDK_LOGGING、COMMONS_LOGGING、STDOUT_LOGGING、NO_LOGGING 或者是實現了接口org.apache.ibatis.logging.Log的類的徹底限定類名， 而且這個類的構造函數須要是以一個字符串（String類型）爲參數的。 （能夠參考org.apache.ibatis.logging.slf4j.Slf4jImpl.java的實現）

你根據須要調用以下的某一方法：

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 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的網站。不過，能夠簡單試一下看看，不一樣的配置 會產生什麼不同的效果。