Mybatis系列十一：SQL及执行结果日志输出

Mybatis系列十五：SQL及执行结果日志输出

概述

每个MappedStatement创建一个日志对象，可以控制每个运行时SQL语句的打印以及执行结果的打印。
日志Debug级别打印SQL语句：PreparedStatement(prepareStatement、prepareCall)创建时打印SQL语句，执行时打印参数值。Statement执行时打印SQL语句。
日志Trace级别打印执行结果。

一、MappedStatement

1.1 构建MappedStatement时指定日志

public Builder(Configuration configuration, String id, SqlSource sqlSource, SqlCommandType sqlCommandType) {
     mappedStatement.configuration = configuration;
     // 命名空间.statementId即Mapper接口完全限定名.方法名
     mappedStatement.id = id;
     mappedStatement.sqlSource = sqlSource;
     mappedStatement.statementType = StatementType.PREPARED;
     mappedStatement.parameterMap = new ParameterMap.Builder(configuration, “defaultParameterMap”, null, new ArrayList()).build();
     mappedStatement.resultMaps = new ArrayList();
     mappedStatement.sqlCommandType = sqlCommandType;
     mappedStatement.keyGenerator = configuration.isUseGeneratedKeys() && SqlCommandType.INSERT.equals(sqlCommandType) ? Jdbc3KeyGenerator.INSTANCE : NoKeyGenerator.INSTANCE;
     String logId = id;
// 配置日志前缀
     if (configuration.getLogPrefix() != null) {
      ** logId = configuration.getLogPrefix() + id;**
     }
// 每个MappedStatement(每个SQL语句)创建一个日志对象
    ** mappedStatement.statementLog = LogFactory.getLog(logId);**
     mappedStatement.lang = configuration.getDefaultScriptingLanguageInstance();
   }

二、BaseExecutor

2.1 创建Connection

// SimpleExecutor、BatchExecutor、ReuseExecutor调用该方法获取Connection
protected Connection getConnection(Log statementLog) throws SQLException {
   Connection connection = transaction.getConnection();
   // MappedStatement开启Debug级别日志
   if (statementLog.isDebugEnabled()) {
// 具有日志打印功能的Connection
     return ConnectionLogger.newInstance(connection, statementLog, queryStack);
   } else {
     return connection;
   }
 }

三、ConnectionLogger

3.1 创建Connection代理实例

public static Connection newInstance(Connection conn, Log statementLog, int queryStack) {
   InvocationHandler handler = new ConnectionLogger(conn, statementLog, queryStack);
   ClassLoader cl = Connection.class.getClassLoader();
   return (Connection) Proxy.newProxyInstance(cl, new Class[]{Connection.class}, handler);
 }

3.2 创建日志打印功能的Statement

public Object invoke(Object proxy, Method method, Object[] params)
     throws Throwable {
   try {
     if (Object.class.equals(method.getDeclaringClass())) {
       return method.invoke(this, params);
     }    
     if (“prepareStatement”.equals(method.getName())) {
       if (isDebugEnabled()) {
    // 日志Debug级别打印SQL语句
         debug(" Preparing: " + removeBreakingWhitespace((String) params[0]), true);
       }        
       PreparedStatement stmt = (PreparedStatement) method.invoke(connection, params);
       stmt = PreparedStatementLogger.newInstance(stmt, statementLog, queryStack);
       return stmt;
     } else if (“prepareCall”.equals(method.getName())) {
       if (isDebugEnabled()) {
    // 日志Debug级别打印SQL语句
         debug(" Preparing: " + removeBreakingWhitespace((String) params[0]), true);
       }        
       PreparedStatement stmt = (PreparedStatement) method.invoke(connection, params);
       stmt = PreparedStatementLogger.newInstance(stmt, statementLog, queryStack);
       return stmt;
     } else if (“createStatement”.equals(method.getName())) {
       Statement stmt = (Statement) method.invoke(connection, params);
       stmt = StatementLogger.newInstance(stmt, statementLog, queryStack);
       return stmt;
     } else {
       return method.invoke(connection, params);
     }
   } catch (Throwable t) {
     throw ExceptionUtil.unwrapThrowable(t);
   }
 }

四、StatementLogger

4.1 创建Statement代理实例

public static Statement newInstance(Statement stmt, Log statementLog, int queryStack) {
   InvocationHandler handler = new StatementLogger(stmt, statementLog, queryStack);
   ClassLoader cl = Statement.class.getClassLoader();
   return (Statement) Proxy.newProxyInstance(cl, new Class[]{Statement.class}, handler);
 }

4.2 创建日志打印功能的ResultSet

public Object invoke(Object proxy, Method method, Object[] params) throws Throwable {
   try {
     if (Object.class.equals(method.getDeclaringClass())) {
       return method.invoke(this, params);
     }

// execute、executeUpdate、executeQuery、addBatch
     if (EXECUTE_METHODS.contains(method.getName())) {
       if (isDebugEnabled()) {
         // 日志Debug级别打印SQL语句
        ** debug(" Executing: " + removeBreakingWhitespace((String) params[0]), true);**
       }
       if (“executeQuery”.equals(method.getName())) {
         ResultSet rs = (ResultSet) method.invoke(statement, params);
         return rs == null ? null : ResultSetLogger.newInstance(rs, statementLog, queryStack);
       } else {
         return method.invoke(statement, params);
       }
     } else if (“getResultSet”.equals(method.getName())) {
       ResultSet rs = (ResultSet) method.invoke(statement, params);
       return rs == null ? null : ResultSetLogger.newInstance(rs, statementLog, queryStack);
     } else {
       return method.invoke(statement, params);
     }
   } catch (Throwable t) {
     throw ExceptionUtil.unwrapThrowable(t);
   }
 }

五、PreparedStatementLogger

5.1 创建PreparedStatement代理实例

public static PreparedStatement newInstance(PreparedStatement stmt, Log statementLog, int queryStack) {
   InvocationHandler handler = new PreparedStatementLogger(stmt, statementLog, queryStack);
   ClassLoader cl = PreparedStatement.class.getClassLoader();
   return (PreparedStatement) Proxy.newProxyInstance(cl, new Class[]{PreparedStatement.class, CallableStatement.class}, handler);
 }

5.2 创建日志打印功能的ResultSet

public Object invoke(Object proxy, Method method, Object[] params) throws Throwable {
   try {
     if (Object.class.equals(method.getDeclaringClass())) {
       return method.invoke(this, params);
     }

// execute、executeUpdate、executeQuery、addBatch
     if (EXECUTE_METHODS.contains(method.getName())) {
       if (isDebugEnabled()) {
         // 日志Debug级别打印参数值
         debug("Parameters: " + getParameterValueString(), true);
       }
       clearColumnInfo();
       if (“executeQuery”.equals(method.getName())) {
         ResultSet rs = (ResultSet) method.invoke(statement, params);
         return rs == null ? null : ResultSetLogger.newInstance(rs, statementLog, queryStack);
       } else {
         return method.invoke(statement, params);
       }
     } else if (SET_METHODS.contains(method.getName())) {
       if (“setNull”.equals(method.getName())) {
         setColumn(params[0], null);
       } else {
         setColumn(params[0], params[1]);
       }
       return method.invoke(statement, params);
     } else if (“getResultSet”.equals(method.getName())) {
       ResultSet rs = (ResultSet) method.invoke(statement, params);
       return rs == null ? null : ResultSetLogger.newInstance(rs, statementLog, queryStack);
     } else if (“getUpdateCount”.equals(method.getName())) {
       int updateCount = (Integer) method.invoke(statement, params);
       if (updateCount != -1) {
         debug("   Updates: " + updateCount, false);
       }
       return updateCount;
     } else {
       return method.invoke(statement, params);
     }
   } catch (Throwable t) {
     throw ExceptionUtil.unwrapThrowable(t);
   }
 }

六、ResultSetLogger 日志TRACE级别打印执行结果

6.1 创建ResultSet代理实例

public static ResultSet newInstance(ResultSet rs, Log statementLog, int queryStack) {
   InvocationHandler handler = new ResultSetLogger(rs, statementLog, queryStack);
   ClassLoader cl = ResultSet.class.getClassLoader();
   return (ResultSet) Proxy.newProxyInstance(cl, new Class[]{ResultSet.class}, handler);
 }

6.2 打印执行结果

public Object invoke(Object proxy, Method method, Object[] params) throws Throwable {
   try {
     if (Object.class.equals(method.getDeclaringClass())) {
       return method.invoke(this, params);
     }    
     Object o = method.invoke(rs, params);
     if (“next”.equals(method.getName())) {
       if (((Boolean) o)) {
         rows++;
         if (isTraceEnabled()) {
           ResultSetMetaData rsmd = rs.getMetaData();
           final int columnCount = rsmd.getColumnCount();
           if (first) {
             first = false;
             printColumnHeaders(rsmd, columnCount);
           }
           printColumnValues(columnCount);
         }
       } else {
         debug("     Total: " + rows, false);
       }
     }
     clearColumnInfo();
     return o;
   } catch (Throwable t) {
     throw ExceptionUtil.unwrapThrowable(t);
   }
 }

6.3 打印列头

private void printColumnHeaders(ResultSetMetaData rsmd, int columnCount) throws SQLException {
   StringBuilder row = new StringBuilder();
   row.append("   Columns: “);
   for (int i = 1; i <= columnCount; i++) {
     if (BLOB_TYPES.contains(rsmd.getColumnType(i))) {
       blobColumns.add(i);
     }
     String colname = rsmd.getColumnLabel(i);
     row.append(colname);
     if (i != columnCount) {
       row.append(”, ");
     }
   }
   trace(row.toString(), false);
 }

6.4 打印列值

private void printColumnValues(int columnCount) {
   StringBuilder row = new StringBuilder();
   row.append("       Row: “);
   for (int i = 1; i <= columnCount; i++) {
     String colname;
     try {
       if (blobColumns.contains(i)) {
         colname = “<>”;
       } else {
         colname = rs.getString(i);
       }
     } catch (SQLException e) {
       // generally can’t call getString() on a BLOB column
       colname = “<>”;
     }
     row.append(colname);
     if (i != columnCount) {
       row.append(”, ");
     }
   }
   trace(row.toString(), false);
 }