Closes #152. Indentation for nested selects logging

emacarron · emacarron · commit 074cef5563ff · 2014-03-06T19:37:16.000+01:00
diff --git a/src/main/java/org/apache/ibatis/logging/jdbc/BaseJdbcLogger.java b/src/main/java/org/apache/ibatis/logging/jdbc/BaseJdbcLogger.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright 2009-2011 the original author or authors.
+ *    Copyright 2009-2014 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@
 package org.apache.ibatis.logging.jdbc;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
@@ -38,13 +39,16 @@ public abstract class BaseJdbcLogger {
   private List<Object> columnNames = new ArrayList<Object>();
   private List<Object> columnValues = new ArrayList<Object>();
 
-  private Log statementLog;
+  protected Log statementLog;
+  protected int queryStack;
 
   /*
    * Default constructor
    */
-  public BaseJdbcLogger(Log log) {
+  public BaseJdbcLogger(Log log, int queryStack) {
     this.statementLog = log;
+    if (queryStack == 0) queryStack = 1;
+    this.queryStack = queryStack;
   }
 
   static {
@@ -127,20 +131,28 @@ protected boolean isTraceEnabled() {
     return statementLog.isTraceEnabled();
   }
 
-  protected void debug(String text) {
+  protected void debug(String text, boolean input) {
     if (statementLog.isDebugEnabled()) {
-      statementLog.debug(text);
+      statementLog.debug(prefix(input) + text);
     }
   }
 
-  protected void trace(String text) {
+  protected void trace(String text, boolean input) {
     if (statementLog.isTraceEnabled()) {
-      statementLog.trace(text);
+      statementLog.trace(prefix(input) + text);
     }
   }
 
-  public Log getStatementLog() {
-    return statementLog;
+  private String prefix(boolean isInput) {
+    char[] buffer = new char[queryStack * 2 + 2];
+    Arrays.fill(buffer, '=');
+    buffer[queryStack * 2 + 1] = ' ';
+    if (isInput) {
+      buffer[queryStack * 2] = '>';
+    } else {
+      buffer[0] = '<';
+    }
+    return new String(buffer);
   }
 
 }
diff --git a/src/main/java/org/apache/ibatis/logging/jdbc/ConnectionLogger.java b/src/main/java/org/apache/ibatis/logging/jdbc/ConnectionLogger.java
@@ -32,40 +32,35 @@ public final class ConnectionLogger extends BaseJdbcLogger implements Invocation
 
   private Connection connection;
 
-  private ConnectionLogger(Connection conn, Log statementLog) {
-    super(statementLog);
+  private ConnectionLogger(Connection conn, Log statementLog, int queryStack) {
+    super(statementLog, queryStack);
     this.connection = conn;
-    if (isDebugEnabled()) {
-      debug("ooo Using Connection [" + conn + "]");
-    }
   }
 
   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("==>  Preparing: " + removeBreakingWhitespace((String) params[0]));
+          debug(" Preparing: " + removeBreakingWhitespace((String) params[0]), true);
         }        
         PreparedStatement stmt = (PreparedStatement) method.invoke(connection, params);
-        stmt = PreparedStatementLogger.newInstance(stmt, getStatementLog());
+        stmt = PreparedStatementLogger.newInstance(stmt, statementLog, queryStack);
         return stmt;
       } else if ("prepareCall".equals(method.getName())) {
         if (isDebugEnabled()) {
-          debug("==>  Preparing: " + removeBreakingWhitespace((String) params[0]));
+          debug(" Preparing: " + removeBreakingWhitespace((String) params[0]), true);
         }        
         PreparedStatement stmt = (PreparedStatement) method.invoke(connection, params);
-        stmt = PreparedStatementLogger.newInstance(stmt, getStatementLog());
+        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, getStatementLog());
+        stmt = StatementLogger.newInstance(stmt, statementLog, queryStack);
         return stmt;
-      } else if ("close".equals(method.getName())) {
-        if (isDebugEnabled()) {
-          debug("xxx Connection Closed");
-        }
-        return method.invoke(connection, params);
       } else {
         return method.invoke(connection, params);
       }
@@ -80,8 +75,8 @@ public Object invoke(Object proxy, Method method, Object[] params)
    * @param conn - the original connection
    * @return - the connection with logging
    */
-  public static Connection newInstance(Connection conn, Log statementLog) {
-    InvocationHandler handler = new ConnectionLogger(conn, statementLog);
+  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);
   }
diff --git a/src/main/java/org/apache/ibatis/logging/jdbc/PreparedStatementLogger.java b/src/main/java/org/apache/ibatis/logging/jdbc/PreparedStatementLogger.java
@@ -32,22 +32,25 @@ public final class PreparedStatementLogger extends BaseJdbcLogger implements Inv
 
   private PreparedStatement statement;
 
-  private PreparedStatementLogger(PreparedStatement stmt, Log statementLog) {
-    super(statementLog);
+  private PreparedStatementLogger(PreparedStatement stmt, Log statementLog, int queryStack) {
+    super(statementLog, queryStack);
     this.statement = stmt;
   }
 
   public Object invoke(Object proxy, Method method, Object[] params) throws Throwable {
     try {
+      if (Object.class.equals(method.getDeclaringClass())) {
+        return method.invoke(this, params);
+      }          
       if (EXECUTE_METHODS.contains(method.getName())) {
         if (isDebugEnabled()) {
-          debug("==> Parameters: " + getParameterValueString());
+          debug("Parameters: " + getParameterValueString(), true);
         }
         clearColumnInfo();
         if ("executeQuery".equals(method.getName())) {
           ResultSet rs = (ResultSet) method.invoke(statement, params);
           if (rs != null) {
-            return ResultSetLogger.newInstance(rs, getStatementLog());
+            return ResultSetLogger.newInstance(rs, statementLog, queryStack);
           } else {
             return null;
           }
@@ -64,21 +67,16 @@ public Object invoke(Object proxy, Method method, Object[] params) throws Throwa
       } else if ("getResultSet".equals(method.getName())) {
         ResultSet rs = (ResultSet) method.invoke(statement, params);
         if (rs != null) {
-          return ResultSetLogger.newInstance(rs, getStatementLog());
+          return ResultSetLogger.newInstance(rs, statementLog, queryStack);
         } else {
           return null;
         }
       } else if ("getUpdateCount".equals(method.getName())) {
         int updateCount = (Integer) method.invoke(statement, params);
         if (updateCount != -1) {
-          debug("<==    Updates: " + updateCount);
+          debug("   Updates: " + updateCount, false);
         }
         return updateCount;
-      } else if ("equals".equals(method.getName())) {
-        Object ps = params[0];
-        return ps instanceof Proxy && proxy == ps;
-      } else if ("hashCode".equals(method.getName())) {
-        return proxy.hashCode();
       } else {
         return method.invoke(statement, params);
       }
@@ -94,8 +92,8 @@ public Object invoke(Object proxy, Method method, Object[] params) throws Throwa
    * @param sql  - the sql statement
    * @return - the proxy
    */
-  public static PreparedStatement newInstance(PreparedStatement stmt, Log statementLog) {
-    InvocationHandler handler = new PreparedStatementLogger(stmt, statementLog);
+  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);
   }
diff --git a/src/main/java/org/apache/ibatis/logging/jdbc/ResultSetLogger.java b/src/main/java/org/apache/ibatis/logging/jdbc/ResultSetLogger.java
@@ -50,13 +50,16 @@ public final class ResultSetLogger extends BaseJdbcLogger implements InvocationH
     BLOB_TYPES.add(Types.VARBINARY);
   }
   
-  private ResultSetLogger(ResultSet rs, Log statementLog) {
-    super(statementLog);
+  private ResultSetLogger(ResultSet rs, Log statementLog, int queryStack) {
+    super(statementLog, queryStack);
     this.rs = rs;
   }
 
   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)) {
@@ -71,7 +74,7 @@ public Object invoke(Object proxy, Method method, Object[] params) throws Throwa
             printColumnValues(columnCount);
           }
         } else {
-          debug("<==      Total: " + rows);
+          debug("     Total: " + rows, false);
         }
       }
       clearColumnInfo();
@@ -83,7 +86,7 @@ public Object invoke(Object proxy, Method method, Object[] params) throws Throwa
 
   private void printColumnHeaders(ResultSetMetaData rsmd, int columnCount) throws SQLException {
     StringBuilder row = new StringBuilder();
-    row.append("<==    Columns: ");
+    row.append("   Columns: ");
     for (int i = 1; i <= columnCount; i++) {
       if (BLOB_TYPES.contains(rsmd.getColumnType(i))) {
         blobColumns.add(i);
@@ -92,12 +95,12 @@ private void printColumnHeaders(ResultSetMetaData rsmd, int columnCount) throws
       row.append(colname);
       if (i != columnCount) row.append(", ");
     }
-    trace(row.toString());
+    trace(row.toString(), false);
   }
 
   private void printColumnValues(int columnCount) throws SQLException {
     StringBuilder row = new StringBuilder();
-    row.append("<==        Row: ");
+    row.append("       Row: ");
     for (int i = 1; i <= columnCount; i++) {
       String colname;
       try {
@@ -113,7 +116,7 @@ private void printColumnValues(int columnCount) throws SQLException {
       row.append(colname);
       if (i != columnCount) row.append(", ");
     }
-    trace(row.toString());
+    trace(row.toString(), false);
   }
 
   /*
@@ -122,8 +125,8 @@ private void printColumnValues(int columnCount) throws SQLException {
    * @param rs - the ResultSet to proxy
    * @return - the ResultSet with logging
    */
-  public static ResultSet newInstance(ResultSet rs, Log statementLog) {
-    InvocationHandler handler = new ResultSetLogger(rs, statementLog);
+  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);
   }
diff --git a/src/main/java/org/apache/ibatis/logging/jdbc/StatementLogger.java b/src/main/java/org/apache/ibatis/logging/jdbc/StatementLogger.java
@@ -31,21 +31,24 @@ public final class StatementLogger extends BaseJdbcLogger implements InvocationH
 
   private Statement statement;
 
-  private StatementLogger(Statement stmt, Log statementLog) {
-    super(statementLog);
+  private StatementLogger(Statement stmt, Log statementLog, int queryStack) {
+    super(statementLog, queryStack);
     this.statement = stmt;
   }
 
   public Object invoke(Object proxy, Method method, Object[] params) throws Throwable {
     try {
+      if (Object.class.equals(method.getDeclaringClass())) {
+        return method.invoke(this, params);
+      }    
       if (EXECUTE_METHODS.contains(method.getName())) {
         if (isDebugEnabled()) {
-          debug("==>  Executing: " + removeBreakingWhitespace((String) params[0]));
+          debug(" Executing: " + removeBreakingWhitespace((String) params[0]), true);
         }
         if ("executeQuery".equals(method.getName())) {
           ResultSet rs = (ResultSet) method.invoke(statement, params);
           if (rs != null) {
-            return ResultSetLogger.newInstance(rs, getStatementLog());
+            return ResultSetLogger.newInstance(rs, statementLog, queryStack);
           } else {
             return null;
           }
@@ -55,7 +58,7 @@ public Object invoke(Object proxy, Method method, Object[] params) throws Throwa
       } else if ("getResultSet".equals(method.getName())) {
         ResultSet rs = (ResultSet) method.invoke(statement, params);
         if (rs != null) {
-          return ResultSetLogger.newInstance(rs, getStatementLog());
+          return ResultSetLogger.newInstance(rs, statementLog, queryStack);
         } else {
           return null;
         }
@@ -78,8 +81,8 @@ public Object invoke(Object proxy, Method method, Object[] params) throws Throwa
    * @param stmt - the statement
    * @return - the proxy
    */
-  public static Statement newInstance(Statement stmt, Log statementLog) {
-    InvocationHandler handler = new StatementLogger(stmt, statementLog);
+  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);
   }
diff --git a/src/test/java/org/apache/ibatis/executor/BaseExecutorTest.java b/src/test/java/org/apache/ibatis/executor/BaseExecutorTest.java
@@ -253,7 +253,6 @@ public void shouldSelectDiscriminatedPost() throws Exception {
         }
       }
     } finally {
-      executor.rollback(true);
       executor.close(false);
     }
   }
@@ -340,6 +339,7 @@ public void shouldFetchPostsForBlog() throws Exception {
       List<Post> posts = executor.query(selectPosts, 1, RowBounds.DEFAULT, Executor.NO_RESULT_HANDLER);
       executor.flushStatements();
       assertEquals(2, posts.size());
+      assertTrue(posts.get(1).getClass().getName().contains("CGLIB"));
       assertNotNull(posts.get(1).getBlog());
       assertEquals(1, posts.get(1).getBlog().getId());
       executor.rollback(true);
@@ -392,7 +392,6 @@ public void shouldFetchPostWithBlogWithCompositeKey() throws Exception {
     }
   }
 
-
   @Test
   public void shouldFetchComplexBlogs() throws Exception {
     
@@ -402,7 +401,6 @@ public void shouldFetchComplexBlogs() throws Exception {
       MappedStatement selectPosts = ExecutorTestHelper.prepareSelectPostsForBlogMappedStatement(config);
       config.addMappedStatement(selectBlog);
       config.addMappedStatement(selectPosts);
-      config.setLazyLoadingEnabled(true);
       List<Blog> blogs = executor.query(selectBlog, 1, RowBounds.DEFAULT, Executor.NO_RESULT_HANDLER);
       executor.flushStatements();
       assertEquals(1, blogs.size());
@@ -411,7 +409,6 @@ public void shouldFetchComplexBlogs() throws Exception {
       assertEquals(1, blogs.get(0).getPosts().get(1).getBlog().getPosts().get(1).getBlog().getId());
       executor.rollback(true);
     } finally {
-      config.setLazyLoadingEnabled(true);
       executor.rollback(true);
       executor.close(false);
     }
diff --git a/src/test/java/org/apache/ibatis/logging/jdbc/ResultSetLoggerTest.java b/src/test/java/org/apache/ibatis/logging/jdbc/ResultSetLoggerTest.java
@@ -50,7 +50,7 @@ public void setup(int type) throws SQLException {
     when(metaData.getColumnLabel(1)).thenReturn("ColumnName");
     when(rs.getString(1)).thenReturn("value");
     when(log.isTraceEnabled()).thenReturn(true);
-    ResultSet resultSet = ResultSetLogger.newInstance(rs, log);
+    ResultSet resultSet = ResultSetLogger.newInstance(rs, log, 1);
     resultSet.next();
   }
 

Original file line number	Diff line number	Diff line change
`@@ -253,7 +253,6 @@ public void shouldSelectDiscriminatedPost() throws Exception {`
`253`	`253`	`}`
`254`	`254`	`}`
`255`	`255`	`} finally {`
`256`		`- executor.rollback(true);`
`257`	`256`	`executor.close(false);`
`258`	`257`	`}`
`259`	`258`	`}`
`@@ -340,6 +339,7 @@ public void shouldFetchPostsForBlog() throws Exception {`
`340`	`339`	`List<Post> posts = executor.query(selectPosts, 1, RowBounds.DEFAULT, Executor.NO_RESULT_HANDLER);`
`341`	`340`	`executor.flushStatements();`
`342`	`341`	`assertEquals(2, posts.size());`
	`342`	`+ assertTrue(posts.get(1).getClass().getName().contains("CGLIB"));`
`343`	`343`	`assertNotNull(posts.get(1).getBlog());`
`344`	`344`	`assertEquals(1, posts.get(1).getBlog().getId());`
`345`	`345`	`executor.rollback(true);`
`@@ -392,7 +392,6 @@ public void shouldFetchPostWithBlogWithCompositeKey() throws Exception {`
`392`	`392`	`}`
`393`	`393`	`}`
`394`	`394`
`395`		`-`
`396`	`395`	`@Test`
`397`	`396`	`public void shouldFetchComplexBlogs() throws Exception {`
`398`	`397`
`@@ -402,7 +401,6 @@ public void shouldFetchComplexBlogs() throws Exception {`
`402`	`401`	`MappedStatement selectPosts = ExecutorTestHelper.prepareSelectPostsForBlogMappedStatement(config);`
`403`	`402`	`config.addMappedStatement(selectBlog);`
`404`	`403`	`config.addMappedStatement(selectPosts);`
`405`		`- config.setLazyLoadingEnabled(true);`
`406`	`404`	`List<Blog> blogs = executor.query(selectBlog, 1, RowBounds.DEFAULT, Executor.NO_RESULT_HANDLER);`
`407`	`405`	`executor.flushStatements();`
`408`	`406`	`assertEquals(1, blogs.size());`
`@@ -411,7 +409,6 @@ public void shouldFetchComplexBlogs() throws Exception {`
`411`	`409`	`assertEquals(1, blogs.get(0).getPosts().get(1).getBlog().getPosts().get(1).getBlog().getId());`
`412`	`410`	`executor.rollback(true);`
`413`	`411`	`} finally {`
`414`		`- config.setLazyLoadingEnabled(true);`
`415`	`412`	`executor.rollback(true);`
`416`	`413`	`executor.close(false);`
`417`	`414`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public void setup(int type) throws SQLException {`
`50`	`50`	`when(metaData.getColumnLabel(1)).thenReturn("ColumnName");`
`51`	`51`	`when(rs.getString(1)).thenReturn("value");`
`52`	`52`	`when(log.isTraceEnabled()).thenReturn(true);`
`53`		`- ResultSet resultSet = ResultSetLogger.newInstance(rs, log);`
	`53`	`+ ResultSet resultSet = ResultSetLogger.newInstance(rs, log, 1);`
`54`	`54`	`resultSet.next();`
`55`	`55`	`}`
`56`	`56`