Mybatis使用之日志相关
最后更新于：2022-04-01 16:29:58
# Mybatis使用之日志相关
### 一：简介
Mybatis提供的日志功能可以帮助我们很只管的看到最后被执行的SQL语句、执行结果等信息。大大方便开发过程中的调试。下面主要摘自Mybatis官网。
### 日志介绍
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介绍已经超出本文档的范围。 不过，下面的例子可以作为一个快速入门。
### 日志配置
具体怎么做，视使用的日志框架而定，这里以Log4J为例。配置日志功能非常简单：添加几个配置文件， 如log4j.properties,再增加个jar包，如log4j.jar。下面是具体的例子，共两个步骤：
### 步骤一：增加log4j jar包
因为采用Log4J，要确保在应用中对应的jar包是可用的。要满足这一点，只要将jar包添加到应用的classpath中即可。 Log4J的jar包可以从上方的链接下载。
具体而言，对于web或企业应用，需要将log4j.jar 添加到WEB-INF/lib 目录； 对于独立应用， 可以将它添加到jvm的 -classpath启动参数中。
### 步骤二：配置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接口级别调整到到语句级别，从而实现更细粒度
~~~
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
~~~
### 补充
更多内容：[Mybatis 目录](http://blog.csdn.net/crave_shy/article/details/45825599)