Mybatis指定日志输出实现

10             Mybatis指定日志输出实现

         在程序开发过程中，为了调试方便、了解程序的运行过程，进行必要的日志输出总是免不了的。对于使用Mybatis而言，我们常见的需求是希望可以在日志中打印出Mybatis执行过程中进行数据库操作的SQL语句及其传递的参数。Mybatis的日志输出是统一管理的，它有自己的日志接口，然后在需要进行日志输出的时候使用统一的API进行日志输出。这个统一的接口是org.apache.ibatis.logging.Log。Mybatis分别基于常用的日志输出工具给出了对应的实现，比如LOG4J、SLF4J等。默认情况下Mybatis的org.apache.ibatis.logging.LogFactory会按照以下顺序依次判断当前程序下可以使用哪种日志实现，直到找到为止，如果一个实现都没有那就是最后的noLogging了，将采用NoLoggingImpl实现。

 

  static {

    tryImplementation(new Runnable() {

      @Override

      public void run() {

        useSlf4jLogging();

      }

    });

    tryImplementation(new Runnable() {

      @Override

      public void run() {

        useCommonsLogging();

      }

    });

    tryImplementation(new Runnable() {

      @Override

      public void run() {

        useLog4J2Logging();

      }

    });

    tryImplementation(new Runnable() {

      @Override

      public void run() {

        useLog4JLogging();

      }

    });

    tryImplementation(new Runnable() {

      @Override

      public void run() {

        useJdkLogging();

      }

    });

    tryImplementation(new Runnable() {

      @Override

      public void run() {

        useNoLogging();

      }

    });

  }

 

         上述的默认机制有的时候可能不能满足你的需求，比如有的时候可能你是想使用Commons-Logging，但是因为类路径中包含SLF4J的包，结果Mybatis就自动使用了SLF4J了，所以如果有自己明确想使用的日志实现时，我们应该自己来指定日志实现，这可以通过在Mybatis的全局配置文件中通过如下进行配置，这里的value是一个日志实现的别名，可选值有SLF4J、COMMONS_LOGGING、LOG4J、LOG4J2、JDK_LOGGING、STDOUT_LOGGING、NO_LOGGING，如果希望使用的日志输出实现是Mybatis自身没有实现的，我们也可以自己来实现，只需要自己定义一个类实现Mybatis的org.apache.ibatis.logging.Log接口，然后在下面的配置中把value属性改为自己的实现类的全路径名称即可。

      <setting name="logImpl" value="LOG4J"/>

         完整配置文件大概是如下这样。

<?xml version="1.0" encoding="UTF-8" ?> 

<!DOCTYPE configuration 

  PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 

  "http://mybatis.org/dtd/mybatis-3-config.dtd"> 

<configuration> 

    <properties resource="jdbc.properties"/> 

   <settings>

      <setting name="logImpl" value="LOG4J"/>

   </settings>

    <environments default="development"> 

        <environment id="development"> 

            <transactionManager type="JDBC" /> 

            <dataSource type="POOLED"> 

                <property name="driver" value="${jdbc.driver}" /> 

                <property name="url" value="${jdbc.url}" /> 

                <property name="username" value="${jdbc.username}" /> 

                <property name="password" value="${jdbc.password}" /> 

            </dataSource>   

        </environment> 

    </environments> 

    <mappers> 

 

    </mappers> 

</configuration> 

 

         Mybatis的日志输出可以输出数据库连接的获取、释放信息；可以输出执行的SQL语句及其传递的预编译参数信息；可以输出查询结果集信息（需要是trace输出级别，其它的是DEBUG级别）；Mybatis的日志输出实现是通过JDK的动态代理来实现的，针对Connection的日志输出提供了ConnectionLogger；针对Statement提供了StatementLogger；针对PreparedStatement提供了PreparedStatementLogger；针对ResultSet提供了ResultSetLogger，这些Logger类都是实现了JDK的InvocationHandler类的。

 

（注：本文是基于Mybatis3.3.1所写，写于2017年1月22日星期日）