使用 mybatis 的时候,如果无法查看 sql 语句,这将非常不方便,因为出现错误无法调试程序。所以应该开启 mybatis 日志功能,在控制台打印 sql 方便调试程序。

mybatis 内置了日志工厂类,内置的日志工厂将日志输出交给以下其中一种工具作代理:

SLF4J
Apache Commons Logging
Log4j 2
Log4j
JDK logging

mybatis 内置日志工厂基于运行时自省机制选择合适的日志工具。它会使用第一个查找得到的工具(按上文列举的顺序查找)。如果一个都未找到,日志功能就会被禁用。

上文提到了“运行时自省机制”,那什么是运行时自省机制呢?简单的来说就是,你啥也不用改动,只需要把SLF4J或者Apache Commons Logging等日志工具的 jar 扔进去,mybatis 就可以通过反射机制,生成相应的具体日志工具,进而输出日志。

如果有人上述过程感兴趣,可以阅读一下 mybatis 的内部源码,这段代码并不难理解,静下心来认真读一下就可以了,如下所示:

static
{//静态代码块,静态代码块的作用大家应该都明白了,就是在初始化阶段预先实现配置项的生成
        tryImplementation(new Runnable() {//企图使用SLF4J
            @Override
            public void run()
            {
                useSlf4jLogging();
            }
        });

        tryImplementation(new Runnable() {//企图使用Apache Commons Logging
            @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();
            }
        });
}

通过阅读上面的代码,我们发现:mybatis 启动的时候,静态代码会在初始化阶段执行,分别启动多个线程,通过反射机制去生成对应的日志类。大家注意没有,好家伙,此处有这么多线程类,岂不是要乱套。其实,别急,请看下面的说明:

private static void tryImplementation(Runnable runnable)
{
        if (logConstructor == null)
        {//如果没有找到具体的日志代理类,则执行下面代码,否则runnable线程不会启动的。
            try
            {
                runnable.run();
            }
            catch (Throwable t)
            {
                // ignore
            }
        }
}

通过上面的代码可以看出来,这些线程类在启动之前,都会判断一下的,这样最终会使用第一个查找得到的工具。

既然你啥也不用改动,只需要把SLF4J或者Apache Commons Logging等日志工具的 jar 扔进去,mybatis 就可以通过反射机制,来生成相应的具体日志工具。

此时,如果你的应用部署在一个类路径已经包含 Commons Logging 的环境中,而你又想使用其它日志工具,这个时候,你需要怎么办呢?你可以通过在 MyBatis 配置文件 mybatis-config.xml 里面添加一项 setting 来选择别的日志工具。如下所示:

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

logImpl 可选的值有:SLF4J、LOG4J、LOG4J2、JDK_LOGGING、COMMONS_LOGGING、STDOUT_LOGGING、NO_LOGGING,或者是实现了接口 org.apache.ibatis.logging.Log 且构造方法是以字符串为参数的类的完全限定名。当然,敢于自己实现接口的人都是高手,具体可以参考 org.apache.ibatis.logging.slf4j.Slf4jImpl.java 的实现,只要做到比猫画虎就行了。

总之,mybatis 开启日志功能的过程十分简单,扔进一个日志工具的 jar 就行了。

标签: none

已有 3 条评论

  1. 1 1

    1

  2. 浮生55 浮生55

    大佬,第一个代码片段 应该是 “静态代码块”;第二个代码片段 应该是 “日志代理类”。不是挑事儿,请包涵。

    1. 谢谢你的提醒,已经修改。

添加新评论