MyBatis3 用log4j在控制台输出 SQL

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

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

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

输出的信息：

[]-Creating a new SqlSession
[]-SqlSession [@33290f98] was not registered for synchronization because synchronization is not active
[]-Fetching JDBC Connection from DataSource
[]-JDBC Connection [jdbc:mysql://:3306/yyyy?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull, UserName=223323@222.222., MySQL Connector Java] will not be managed by Spring
[]-==>  Preparing: SELECT , 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, , ,  FROM datenumber x right join physician y on x.physician_id= AND ( x.`Date` >= ? AND x.`Date` <= ? ) Where 1=1 AND y.clinic_id = ? ORDER BY x.Date ASC 
[]-==> Parameters: 2017-3-28(String), 2017-4-4(String), 1(Long)
[]-<==      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 "-////DTD Config 3.0//EN"



        "/dtd/">



<configuration>



    <settings>




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




    </settings>




</configuration>

关键语句：

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

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

方法二：使用log4j日志输出

1、文件不需要修改；

2、在中，指定使用log4j为日志实现，这个我实际测试也不需要。




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



<!DOCTYPE configuration PUBLIC "-////DTD Config 3.0//EN"



        "/dtd/">



<configuration>



    <settings>




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




    </settings>




</configuration>



<!-- 实际测试这个文件有没有都可以 -->

这里的value值可以是SLF4J、Apache Commons Logging、Log4J2、Log4J、JDK logging（除Log4J2、Log4J外，其他未验证），并会按顺序查找
3、在中也需要配置




<listener>



     <listener-class>.Log4jConfigListener</listener-class>




 </listener>

或者用下面的（未测试）




<listener>



        <listener-class>..Log4jServletContextListener</listener-class>




    </listener>

4、最后配置

### Log4j配置 ###
### 与Spring结合需要在中指定此文件位置，并添加监听器 ###
#定义log4j的输出级别和输出目的地（目的地可以自定义名称，和后面的对应）
#[ level ] , appenderName1 , appenderName2
log4=DEBUG,console,file

#-----------------------------------#
#1 定义日志输出目的地为控制台
log4 = 4
log4 = 
log4=DEBUG
####可以灵活地指定日志输出格式，下面一行是指定具体的格式 ###
#%c: 输出日志信息所属的类目，通常就是所在类的全名
#%m: 输出代码中指定的消息,产生的日志具体信息 
#%n: 输出一个回车换行符，Windows平台为"/r/n"，Unix平台为"/n"输出日志信息换行
log4 = 4
log4=[%c]-%m%n

#-----------------------------------#
#2 文件大小到达指定尺寸的时候产生一个新的文件 
log4.file = 4
#日志文件输出目录
log4.file.File=log/
#定义文件最大大小
log4.file.MaxFileSize=10mb
###输出日志信息###
#最低级别
log4.file.Threshold=ERROR
log4.file.layout=4
log4.file.=[%p][%d{yy-MM-dd}][%c]%m%n

#-----------------------------------#
#3 druid
log4=INFO
log4=info
log4=info
log4=info
log4=info
 
#4 mybatis 显示SQL语句部分
log4=DEBUG
#log4=DEBUG
#log4.common.=DEBUG
#log4.common.=DEBUG
#log4=DEBUG
#log4=DEBUG
log4=DEBUG
log4=DEBUG
log4=DEBUG
log4=DEBUG

两种方式比较

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

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

当在配置文件中指定为“ STDOUT_LOGGING”时，实际使用的是哪一个日志实现？Apache Commons Logging 还是JDK logging ？

都不是，实际是 .

2017-09-14更新

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

log4=DEBUG

是否与本例一致！

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

======================文档信息========================

署名(BY) ：testcs_dn(微wx笑)

文章出处：[无知人生，记录点滴](.NET/testcs_dn)

==============欢迎关注我的个人微信订阅号（微wx笑）============

秒客网