log4j打印mybatis執行sql，將占位符換成真實的參數輸出

背景：

在我日常碼代碼的時候，由於對mybatis的動態sql，比較依賴，並且有時候需求復雜，導致sql較長，而且參數眾多，當出現問題是，需要將sql，放到navicat里面去執行查看結果，但是對於復雜的sql來說，眾多的參數，一個一個替換。當真很麻煩，於是萌生出可不可以將sql直接輸出，不在出線sql和參數分開的情況，可以減少很多麻煩，在我找度娘，一次又一次的嘗試，我還是沒有發現，在log4j的配置文件里面。有這個功能，所以最后萌生出改寫源碼的想法，之后我也會嘗試繼續尋找，有沒有官方的API提供，本文講述我自己改寫源代碼實現的方案

一、針對DEMO搭建SSM項目（略）

二、采用的log4j的版本(這里由於log的眾多實現，有可能出線log4j的沖突，而且我也沒有濾的特別清楚，所以貼出自己使用的log4j的版本，采用maven提供)

<span style="white-space:pre;">         </span><!-- log4j 日志 -->
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>${log4j-version}</version>
            </dependency>

三、首先實現輸出mybatis輸出sql

1、引入jar包（同上）

2、配置mybatis輸出sql的配置項

<span style="white-space:pre;"> </span><settings>
        <setting name="logImpl" value="LOG4J" />
    </settings>

3、添加logj4j.properties文件

#logFile
log4j.rootLogger=DEBUG,Console
#Console
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=INFO
log4j.appender.console.ImmediateFlush=true
log4j.appender.Console.Target=System.out
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%-5p %d{yyyy-MM-dd HH:mm:ss}[%t] %l: %x%m%n

# 日志文件(logFile)
log4j.appender.logFile=org.apache.log4j.FileAppender
log4j.appender.logFile.Threshold=DEBUG
# 立即輸出
#log4j.appender.logFile.ImmediateFlush=true
#log4j.appender.logFile.Append=true
#log4j.appender.logFile.File=D:/logs/log.log4j
#log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
#log4j.appender.logFile.layout.ConversionPattern=%-5p %d{yyyy-MM-dd HH:mm:ss}[%t] %l: %x%m%n

log4j.logger.org.apache=ERROR
log4j.logger.org.mybatis=ERROR
log4j.logger.org.springframework=ERROR
#這個需要
log4j.logger.log4jdbc.debug=ERROR

log4j.logger.jdbc.audit=ERROR
log4j.logger.jdbc.resultset=ERROR
#這個打印SQL語句非常重要
log4j.logger.jdbc.sqlonly=DEBUG
log4j.logger.jdbc.sqltiming=ERROR
log4j.logger.jdbc.connection=FATAL

4、測試結果

==>  Preparing: select u.id as id ,u.name as name , u.pwd as pwd from user u where u.pwd = ? and u.id = ?;
==> Parameters: 123(String), 1(String)
<==      Total: 0

顯然：參數和sql是分離的，現在要實現將參數嵌套進sql中，實現上面的想法

 

通過源碼的分析最后我決定動（org.apache.ibatis.logging.jdbc.BaseJdbcLogger）這個類，它的作用是輸出最后的sql

 

方法步驟：

 

1、找到這個類的全路徑，找到源碼

2、在src下創建一個同路徑下的BaseJdbcLogger類，並且將源碼原封不動的貼近剛創建的類，

3、找到需要修改的方法，我貼一下我准備修改的方法

protected void debug(String text, boolean input) {
   if (statementLog.isDebugEnabled()) {
     statementLog.debug(prefix(input) + text);
   }
 }

目前的這個是BaseJdbcLogger.debug的源碼，其中（text:是需要打印的文本，input:表示前面的“==>”的方向）

經過我的修改：

/* 打印的sql */
private static String sql = "";
protected void debug(String text, boolean input) {
    text = text.trim();
    if (statementLog.isDebugEnabled()) {
    if(text.startsWith("Preparing:")){
      sql = text.substring(text.indexOf(":")+1);
      return ;
    }
    if(text.startsWith("Parameters:")){
      String temp = text.substring(text.indexOf(":")+1);
      String[] split = temp.split(",");
      if(split != null & split.length > 0){
          for (String string2 : split) {
        String s = string2.trim();
        sql = sql.replaceFirst("\\?", s.substring(0, s.indexOf("(")));
    }
      }
      text = "Preparing:"+ sql ;
      sql = "";
    }
    statementLog.debug(prefix(input) + text);
  }
}

最終輸出結果：

==> Preparing: select u.id as id ,u.name as name , u.pwd as pwd from user u where u.pwd = 123 and u.id = 1;
<== Total: 0

到到最終目的

（雖然不是最好的方法，mybatis應該分裝相應的配置，但是我沒有發現，如果有碼友發現了，請告知我，謝謝）