MyBatis3用log4j在控制臺(tái)輸出SQL的方法示例

更新時(shí)間：2018年01月31日 08:38:09 作者：微wx笑

本篇文章主要介紹了MyBatis3用log4j在控制臺(tái)輸出SQL的方法示例，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

為什么要在控制臺(tái)輸出 SQL 呢？

當(dāng)然是為了開發(fā)調(diào)試的時(shí)候方便了。

如果一個(gè) 數(shù)據(jù)庫相關(guān)的操作出現(xiàn)了問題，我們可以根據(jù)輸出的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

輸出的內(nèi)容比較可怕，數(shù)據(jù)庫連接字符，用戶名密碼都輸出來了，一定要小心。

不過有一點(diǎn)不好的是SQL語句和參數(shù)是分開輸出的，想復(fù)制到查詢工具中調(diào)試的話還得自己填寫參數(shù)，比較麻煩。

我的項(xiàng)目環(huán)境

Spring 4.0.2 + Spring MVC 4.0.2 + MyBatis 3.2.6

方法一：使用標(biāo)準(zhǔn)日志輸出

此方法比較簡單，只需要配置 MyBatis 的配置文件 Configuration 中有相關(guān)屬性即可，不用再放一個(gè) 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>

關(guān)鍵語句：

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

指定 MyBatis 應(yīng)該使用哪個(gè)日志記錄實(shí)現(xiàn)。如果此設(shè)置不存在，則會(huì)自動(dòng)發(fā)現(xiàn)日志記錄實(shí)現(xiàn)。

方法二：使用log4j日志輸出

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

2、在mybatis.xml中，指定使用log4j為日志實(shí)現(xiàn)，這個(gè)我實(shí)際測(cè)試也不需要。

<?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> 
<!-- 實(shí)際測(cè)試這個(gè)文件有沒有都可以 -->

這里的value值可以是SLF4J、Apache Commons Logging、Log4J2、Log4J、JDK logging（除Log4J2、Log4J外，其他未驗(yàn)證），并會(huì)按順序查找

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

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

或者用下面的（未測(cè)試）

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

4、最后配置log4j.properties

### Log4j配置 ### 
### 與Spring結(jié)合需要在web.xml中指定此文件位置，并添加監(jiān)聽器 ### 
#定義log4j的輸出級(jí)別和輸出目的地（目的地可以自定義名稱，和后面的對(duì)應(yīng)） 
#[ level ] , appenderName1 , appenderName2 
log4j.rootLogger=DEBUG,console,file 
 
#-----------------------------------# 
#1 定義日志輸出目的地為控制臺(tái) 
log4j.appender.console = org.apache.log4j.ConsoleAppender 
log4j.appender.console.Target = System.out 
log4j.appender.console.Threshold=DEBUG 
####可以靈活地指定日志輸出格式，下面一行是指定具體的格式 ### 
#%c: 輸出日志信息所屬的類目，通常就是所在類的全名 
#%m: 輸出代碼中指定的消息,產(chǎn)生的日志具體信息  
#%n: 輸出一個(gè)回車換行符，Windows平臺(tái)為"/r/n"，Unix平臺(tái)為"/n"輸出日志信息換行 
log4j.appender.console.layout = org.apache.log4j.PatternLayout 
log4j.appender.console.layout.ConversionPattern=[%c]-%m%n 
 
#-----------------------------------# 
#2 文件大小到達(dá)指定尺寸的時(shí)候產(chǎn)生一個(gè)新的文件  
log4j.appender.file = org.apache.log4j.RollingFileAppender 
#日志文件輸出目錄 
log4j.appender.file.File=log/tibet.log 
#定義文件最大大小 
log4j.appender.file.MaxFileSize=10mb 
###輸出日志信息### 
#最低級(jí)別 
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、使用標(biāo)準(zhǔn)日志輸出配置簡單，使用log4j日志輸出配置相對(duì)復(fù)雜；

2、log4j功能強(qiáng)大，控制粒度比較細(xì)；

當(dāng)在配置文件中指定為“ STDOUT_LOGGING”時(shí)，實(shí)際使用的是哪一個(gè)日志實(shí)現(xiàn)？Apache Commons Logging 還是JDK logging ？

都不是，實(shí)際是 System.out.pringln.

2017-09-14更新

有小伙伴反饋按第二種方法配置后不輸出SQL 語句，請(qǐng)注意 log4j.properties 文件中的：