MyBatis 日志

Logging

Mybatis內(nèi)置的日志工廠提供日志功能，具體的日志實現(xiàn)有以下幾種工具：

• SLF4J
• Apache Commons Logging
• Log4j 2
• Log4j
• JDK logging

具體選擇哪個日志實現(xiàn)工具由MyBatis的內(nèi)置日志工廠確定。它會使用最先找到的（按上文列舉的順序查找）。 如果一個都未找到，日志功能就會被禁用。

不少應(yīng)用服務(wù)器的classpath中已經(jīng)包含Commons Logging，如Tomcat和WebShpere， 所以MyBatis會把它作為具體的日志實現(xiàn)。記住這點非常重要。這將意味著，在諸如 WebSphere的環(huán)境中——WebSphere提供了Commons Logging的私有實現(xiàn)，你的Log4J配置將被忽略。 這種做法不免讓人悲催，MyBatis怎么能忽略你的配置呢？事實上，因Commons Logging已經(jīng)存 在了，按照優(yōu)先級順序，Log4J自然就被忽略了！不過，如果你的應(yīng)用部署在一個包含Commons Logging的環(huán)境， 而你又想用其他的日志框架，你可以根據(jù)需要調(diào)用如下的某一方法：

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();

如果的確需要調(diào)用以上的某個方法，請在其他所有MyBatis方法之前調(diào)用它。另外，只有在相應(yīng)日志實現(xiàn)中存在 的前提下，調(diào)用對應(yīng)的方法才是有意義的，否則MyBatis一概忽略。如你環(huán)境中并不存在Log4J，你卻調(diào)用了 相應(yīng)的方法，MyBatis就會忽略這一調(diào)用，代之默認(rèn)的查找順序查找日志實現(xiàn)。

關(guān)于SLF4J、Apache Commons Logging、Apache Log4J和JDK Logging的API介紹已經(jīng)超出本文檔的范圍。 不過，下面的例子可以作為一個快速入門。關(guān)于這些日志框架的更多信息，可以參考以下鏈接：

• Apache Commons Logging
• Apache Log4j
• JDK Logging API

Logging Configuration

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

具體怎么做，視使用的日志框架而定，這里以Log4J為例。配置日志功能非常簡單：添加幾個配置文件， 如log4j.properties,再添加個jar包，如log4j.jar。下面是具體的例子，共兩個步驟：

步驟1： 添加 Log4J 的 jar 包

因為采用Log4J，要確保在應(yīng)用中對應(yīng)的jar包是可用的。要滿足這一點，只要將jar包添加到應(yīng)用的classpath中即可。 Log4J的jar包可以從上面的鏈接中下載。

具體而言，對于web或企業(yè)應(yīng)用，需要將log4j.jar 添加到WEB-INF/lib 目錄； 對于獨立應(yīng)用， 可以將它添加到j(luò)vm的 -classpath啟動參數(shù)中。

步驟2：配置Log4J

配置Log4J比較簡單， 比如需要記錄這個mapper接口的日志:

    package org.mybatis.example;
    public interface BlogMapper {
      @Select("SELECT * FROM blog WHERE id = #{id}")
      Blog selectBlog(int id);
    }

只要在應(yīng)用的classpath中創(chuàng)建一個名稱為log4j.properties的文件， 文件的具體內(nèi)容如下：

    # 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 的詳細(xì)執(zhí)行日志記錄下來，對于應(yīng)用中的其它類則僅僅記錄錯誤信息。

也可以將日志從整個mapper接口級別調(diào)整到到語句級別，從而實現(xiàn)更細(xì)粒度的控制。如下配置只記錄 selectBlog 語句的日志：

log4j.logger.org.mybatis.example.BlogMapper.selectBlog=TRACE

與此相對，可以對一組mapper接口記錄日志，只要對mapper接口所在的包開啟日志功能即可：

    log4j.logger.org.mybatis.example=TRACE

某些查詢可能會返回大量的數(shù)據(jù)，只想記錄其執(zhí)行的SQL語句該怎么辦？為此，Mybatis中SQL語 句的日志級別被設(shè)為DEBUG（JDK Logging中為FINE），結(jié)果日志的級別為TRACE（JDK Logging中為FINER)。所以，只要將日志級別調(diào)整為DEBUG即可達(dá)到目的：

    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

進(jìn)一步，要記錄具體語句的日志可以這樣做：

log4j.logger.org.mybatis.example.BlogMapper.selectBlog=TRACE

看到了吧，兩種配置沒差別！

配置文件log4j.properties的余下內(nèi)容是針對日志格式的，這一內(nèi)容已經(jīng)超出本 文檔范圍。關(guān)于Log4J的更多內(nèi)容，可以參考Log4J的網(wǎng)站。不過，可以簡單試一下看看，不同的配置 會產(chǎn)生什么不一樣的效果。