MyBatis3用log4j在控制台输出SQL的方法示例

为什么要在控制台输出 sql 呢？

当然是为了开发调试的时候方便了。

如果一个 数据库相关的操作出现了问题，我们可以根据输出的sql语句快速排查问题。

输出的信息：

[org.mybatis.spring.sqlsessionutils]-creating a new sqlsession 
[org.mybatis.spring.sqlsessionutils]-sqlsession [org.apache.ibatis.session.defaults.defaultsqlsession@33290f98] was not registered for synchronization because synchronization is not active 
[org.springframework.jdbc.datasource.datasourceutils]-fetching jdbc connection from datasource 
[org.mybatis.spring.transaction.springmanagedtransaction]-jdbc connection [jdbc:mysql://rds.aliyuncs.com:3306/yyyy?useunicode=true&characterencoding=utf-8&zerodatetimebehavior=converttonull, username=[e-mail], mysql connector java] will not be managed by spring 
[datenumber.pageselect]-==>  preparing: select x.id, date_format(x.`date`, '%y%m%d') `datestr`, x.befor_num, x.after_num, x.physician_id, y.department_id, y.clinic_id, y.true_name, y.avatar, y.title, y.telephone from datenumber x right join physician y on x.physician_id=y.id and ( x.`date` >= ? and x.`date` <= ? ) where 1=1 and y.clinic_id = ? order by x.date asc  
[datenumber.pageselect]-==> parameters: 2017-3-28(string), 2017-4-4(string), 1(long) 
[datenumber.pageselect]-<==      total: 19 

输出的内容比较可怕，数据库连接字符，用户名密码都输出来了，一定要小心。

不过有一点不好的是sql语句和参数是分开输出的，想复制到查询工具中调试的话还得自己填写参数，比较麻烦。

我的项目环境

spring 4.0.2 + spring mvc 4.0.2 + mybatis 3.2.6

方法一：使用标准日志输出

此方法比较简单，只需要配置 mybatis 的配置文件 configuration 中有相关属性即可，不用再放一个 log4j.properties 文件。

<?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> 
  <settings> 
    <setting name="logimpl" value="stdout_logging"/> 
  </settings> 
</configuration> 

关键语句：

<setting name="logimpl" value="stdout_logging"/> 

指定 mybatis 应该使用哪个日志记录实现。如果此设置不存在，则会自动发现日志记录实现。

方法二：使用log4j日志输出

1、spring-mybatis.xml 文件不需要修改；

2、在mybatis.xml中，指定使用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> 
  <settings> 
    <setting name="logimpl" value="log4j"/> 
  </settings> 
</configuration> 
<!-- 实际测试这个文件有没有都可以 --> 

这里的value值可以是slf4j、apache commons logging、log4j2、log4j、jdk logging（除log4j2、log4j外，其他未验证），并会按顺序查找

3、在web.xml中也需要配置

<listener> 
   <listener-class>org.springframework.web.util.log4jconfiglistener</listener-class> 
 </listener> 

或者用下面的（未测试）

<listener> 
    <listener-class>org.apache.logging.log4j.web.log4jservletcontextlistener</listener-class> 
  </listener> 

4、最后配置log4j.properties

### log4j配置 ### 
### 与spring结合需要在web.xml中指定此文件位置，并添加监听器 ### 
#定义log4j的输出级别和输出目的地（目的地可以自定义名称，和后面的对应） 
#[ level ] , appendername1 , appendername2 
log4j.rootlogger=debug,console,file 
 
#-----------------------------------# 
#1 定义日志输出目的地为控制台 
log4j.appender.console = org.apache.log4j.consoleappender 
log4j.appender.console.target = system.out 
log4j.appender.console.threshold=debug 
####可以灵活地指定日志输出格式，下面一行是指定具体的格式 ### 
#%c: 输出日志信息所属的类目，通常就是所在类的全名 
#%m: 输出代码中指定的消息,产生的日志具体信息  
#%n: 输出一个回车换行符，windows平台为"/r/n"，unix平台为"/n"输出日志信息换行 
log4j.appender.console.layout = org.apache.log4j.patternlayout 
log4j.appender.console.layout.conversionpattern=[%c]-%m%n 
 
#-----------------------------------# 
#2 文件大小到达指定尺寸的时候产生一个新的文件  
log4j.appender.file = org.apache.log4j.rollingfileappender 
#日志文件输出目录 
log4j.appender.file.file=log/tibet.log 
#定义文件最大大小 
log4j.appender.file.maxfilesize=10mb 
###输出日志信息### 
#最低级别 
log4j.appender.file.threshold=error 
log4j.appender.file.layout=org.apache.log4j.patternlayout 
log4j.appender.file.layout.conversionpattern=[%p][%d{yy-mm-dd}][%c]%m%n 
 
#-----------------------------------# 
#3 druid 
log4j.logger.druid.sql=info 
log4j.logger.druid.sql.datasource=info 
log4j.logger.druid.sql.connection=info 
log4j.logger.druid.sql.statement=info 
log4j.logger.druid.sql.resultset=info 
  
#4 mybatis 显示sql语句部分 
log4j.logger.org.mybatis=debug 
#log4j.logger.cn.tibet.cas.dao=debug 
#log4j.logger.org.mybatis.common.jdbc.simpledatasource=debug 
#log4j.logger.org.mybatis.common.jdbc.scriptrunner=debug 
#log4j.logger.org.mybatis.sqlmap.engine.impl.sqlmapclientdelegate=debug 
#log4j.logger.java.sql.connection=debug 
log4j.logger.java.sql=debug 
log4j.logger.java.sql.statement=debug 
log4j.logger.java.sql.resultset=debug 
log4j.logger.java.sql.preparedstatement=debug 

两种方式比较

1、使用标准日志输出配置简单，使用log4j日志输出配置相对复杂；

2、log4j功能强大，控制粒度比较细；

当在配置文件中指定为“ stdout_logging”时，实际使用的是哪一个日志实现？apache commons logging 还是jdk logging ？

都不是，实际是 system.out.pringln.

2017-09-14更新

有小伙伴反馈按第二种方法配置后不输出sql 语句，请注意 log4j.properties 文件中的：

log4j.appender.console.threshold=debug 

是否与本例一致！

请注意细节，刚开始学习的朋友可以先完全使用本例提供的配置，得到正确的输出后再做个性定制。
另外，按照我上面的配置会输出大量 sql 语句之外的信息，一位朋友尝试出只输出 sql 语句、参数、结果的配置方法，

在此表示感谢并分享给大家：

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。