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=223323@222.222.xxx.xxx, 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 语句、参数、结果的配置方法,

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

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持编程小技巧。

代码技巧

转载请关注公众号:代码技巧 回复:授权

本文链接地址:https://www.oudahe.com/p/47850/