Mybatis 的Log4j日志输出问题 - 以及有关日志的所有问题

水深无声 2022-07-14 03:24 106阅读 0赞

使用Mybatis的时候，有些时候能输出（主要是指sql，参数，结果）日志。有些时候就不能。

无法输出日志的时候，无论怎么配置log4j，不管是properties的还是xml的，都不起作用。

有些时候，我们没做什么配置就能输出日志....

这是一个让无数人烦躁的问题。其实解决问题很容易（我过了这么久才解决，以前都用拦截器输出）。

这是一个普大喜奔的日子，让我们一起来看看如何解决mybatis的日志问题。

为什么说这个问题很容易解决呢？因为mybatis的文档写的很清楚。

为什么我们都没找到解决办法呢？因为即使看过文档的人，也未必去看Logging这一节。但是这一节正是解决问题的关键。

已经等不及的小伙伴们可以直接去这里看文档：[http://mybatis.github.io/mybatis-3/zh/logging.html][http_mybatis.github.io_mybatis-3_zh_logging.html]

提醒最常用的方法不再这个链接中，但是这个文档提供了对log4j的详细配置。本文下面的内容大部分是这个文档的Copy。

**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的环境， 而你又想用其他的日志框架，你可以根据需要调用如下的某一方法：

**\[java\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  org.apache.ibatis.logging.LogFactory.useSlf4jLogging();  
2.  org.apache.ibatis.logging.LogFactory.useLog4JLogging();  
3.  org.apache.ibatis.logging.LogFactory.useJdkLogging();  
4.  org.apache.ibatis.logging.LogFactory.useCommonsLogging();  
5.  org.apache.ibatis.logging.LogFactory.useStdOutLogging();

**如果的确需要调用以上的某个方法，请在调用所有其他MyBatis方法前调用它**。另外，只有在相应日志实现存在 的前提下，调用对应的方法才是有意义的，否则MyBatis一概忽略。如你环境中并不存在Log4J，你却调用了 相应的方法，MyBatis就会忽略这一调用，代之默认的查找顺序查找日志实现。

例如使用log4j就需要在调用mybatis方法前，先执行代码：

**\[java\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  org.apache.ibatis.logging.LogFactory.useLog4JLogging();

**上面这是一种解决办法，但是有些情况你不知道何时执行这个方法。**

**mybatis还提供了另外一种（*推荐使用这种*）解决方法，继续看下面。**

另一种解决为，在mybatis-config.xml配置文件中：

**\[html\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  **<****configuration****>**  
2.      **<****settings****>**  
3.          **<****setting** name="logImpl" value="LOG4J"**/>**  
4.      **</****settings****>**  
5.  **</****configuration****>**

这里只写了关键的一部分配置信息，在你自己配置的基础上增加 <setting name="logImpl" value="LOG4J"/> 即可。这样一来log4j的配置信息就会起作用。

参数说明：

![20140404140931953][]

**Mybatis对Log4j的配置支持：**

**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接口的日志:

**\[java\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

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

只要在应用的classpath中创建一个名称为log4j.properties的文件， 文件的具体内容如下：

**\[plain\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  \# Global logging configuration  
2.  log4j.rootLogger=ERROR, stdout  
3.  \# MyBatis logging configuration...  
4.  log4j.logger.org.mybatis.example.BlogMapper=TRACE  
5.  \# Console output...  
6.  log4j.appender.stdout=org.apache.log4j.ConsoleAppender  
7.  log4j.appender.stdout.layout=org.apache.log4j.PatternLayout  
8.  log4j.appender.stdout.layout.ConversionPattern=%5p \[%t\] - %m%n

添加以上配置后，Log4J就会把 org.mybatis.example.BlogMapper 的详细执行日志记录下来，对于应用中的其它类则仅仅记录错误信息。

也可以将日志从整个mapper接口级别调整到到语句级别，从而实现更细粒度的控制。如下配置只记录 selectBlog语句的日志：

**\[plain\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

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

与此相对，可以对一组mapper接口记录日志，只要对mapper接口所在的包开启日志功能即可：

**\[plain\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  log4j.logger.org.mybatis.example=TRACE

某些查询可能会返回大量的数据，只想记录其执行的SQL语句该怎么办？为此，Mybatis中SQL语 句的日志级别被设为DEBUG（JDK Logging中为FINE），结果日志的级别为TRACE（JDK Logging中为FINER)。所以，只要将日志级别调整为DEBUG即可达到目的：

**\[plain\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  log4j.logger.org.mybatis.example=DEBUG

要记录日志的是类似下面的mapper文件而不是mapper接口又该怎么呢？

**\[html\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  **<?****xml** version="1.0" encoding="UTF-8" **?>**  
2.  <!DOCTYPE mapper  
3.    PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"  
4.    "http://mybatis.org/dtd/mybatis-3-mapper.dtd"**>**  
5.  **<****mapper** namespace="org.mybatis.example.BlogMapper"**>**  
6.    **<****select** id="selectBlog" resultType="Blog"**>**  
7.      select \* from Blog where id = \#\{id\}  
8.    **</****select****>**  
9.  **</****mapper****>**

对这个文件记录日志，只要对命名空间增加日志记录功能即可：

**\[plain\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

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

进一步，要记录具体语句的日志可以这样做：

**\[plain\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

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

看到了把，两种配置没差别！

配置文件log4j.properties的余下内容是针对日志格式的，这一内容已经超出本 文档范围。关于Log4J的更多内容，可以参考Log4J的网站。不过，可以简单试一下看看，不同的配置 会产生什么不一样的效果。

\#\# jar包环境，mybatis-3.2.3，mybatis-spring-1.2.2

mybatis-3.2.3以上才支持logImpl

mybatis-spring-1.2.2会导致sqlSessionFactoryBean在spring加载properties之前初始化，会报无法识别$\{jdbc.url\}之类的错误

解决方法是注释掉<property name="sqlSessionFactory" ref="sqlSessionFactory"/> 即可

[http_mybatis.github.io_mybatis-3_zh_logging.html]: http://mybatis.github.io/mybatis-3/zh/logging.html
[view plain]: http://blog.csdn.net/isea533/article/details/22931341#
[CODE]: https://code.csdn.net/assets/CODE_ico.png
[CODE_CODE]: https://code.csdn.net/snippets/274764
[ico_fork.svg]: https://code.csdn.net/assets/ico_fork.svg
[ico_fork.svg 1]: https://code.csdn.net/snippets/274764/fork
[20140404140931953]: /images/20220714/e899417b629d4d8db04517f73ef32896.png