Add the peek method to make debugging easy

nakamura-to · nakamura-to · commit fea6c7c2b646 · 2020-05-06T20:16:05.000+09:00
diff --git a/docs/criteria-api.rst b/docs/criteria-api.rst
@@ -826,7 +826,7 @@ Be careful of the following points when you use the ``select`` method:
 Debugging (Entityql, NativeSql)
 -------------------------------
 
-To know the SQL statement built by the DSLs, use the ``asSql`` method instead of the ``execute`` method:
+To know the SQL statement built by the DSLs, use the ``asSql`` method:
 
 .. code-block:: java
 
@@ -848,6 +848,31 @@ The above code prints as follows:
 The ``asSql`` method doesn't issue the SQL statement to your Database.
 It only builds the SQL statement and return it as an ``Sql`` object.
 
+You can also get the ``Sql`` object by calling the ``peek`` method.
+
+.. code-block:: java
+
+    Department_ d = new Department_();
+
+    List<Department> list =
+        entityql
+            .from(d)
+            .peek(System.out::println)
+            .where(c -> c.eq(d.departmentName, "SALES"))
+            .peek(System.out::println)
+            .orderBy(c -> c.asc(d.location))
+            .peek(sql -> System.out.println(sql.getFormattedSql()))
+            .getResultList();
+
+The above code prints as follows:
+
+.. code-block:: sh
+
+    select t0_.DEPARTMENT_ID, t0_.DEPARTMENT_NO, t0_.DEPARTMENT_NAME, t0_.LOCATION, t0_.VERSION from DEPARTMENT t0_
+    select t0_.DEPARTMENT_ID, t0_.DEPARTMENT_NO, t0_.DEPARTMENT_NAME, t0_.LOCATION, t0_.VERSION from DEPARTMENT t0_ where t0_.DEPARTMENT_NAME = ?
+    select t0_.DEPARTMENT_ID, t0_.DEPARTMENT_NO, t0_.DEPARTMENT_NAME, t0_.LOCATION, t0_.VERSION from DEPARTMENT t0_ where t0_.DEPARTMENT_NAME = 'SALES' order by t0_.LOCATION asc
+
+
 Sample projects
 ===============
 
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/AbstractStatement.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/AbstractStatement.java
@@ -2,6 +2,7 @@
 
 import java.lang.reflect.Method;
 import java.util.Objects;
+import java.util.function.Consumer;
 import java.util.function.Function;
 import org.seasar.doma.DomaException;
 import org.seasar.doma.jdbc.CommentContext;
@@ -10,7 +11,8 @@
 import org.seasar.doma.jdbc.command.Command;
 import org.seasar.doma.message.Message;
 
-public abstract class AbstractStatement<RESULT> implements Statement<RESULT> {
+public abstract class AbstractStatement<RESULT, STMT extends AbstractStatement<RESULT, STMT>>
+    implements Statement<RESULT>, Peekable<STMT> {
 
   protected static final String EXECUTE_METHOD_NAME = "execute";
   protected static final Method EXECUTE_METHOD;
@@ -41,6 +43,13 @@ public Sql<?> asSql() {
     return command.getQuery().getSql();
   }
 
+  @Override
+  @SuppressWarnings("unchecked")
+  public STMT peek(Consumer<Sql<?>> consumer) {
+    consumer.accept(asSql());
+    return (STMT) this;
+  }
+
   protected Function<String, String> createCommenter(String comment) {
     return sql -> {
       CommentContext context =
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/Collectable.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/Collectable.java
@@ -1,13 +1,20 @@
 package org.seasar.doma.jdbc.criteria.statement;
 
 import java.util.List;
+import java.util.function.Consumer;
 import java.util.function.Function;
 import java.util.stream.Collector;
 import java.util.stream.Stream;
+import org.seasar.doma.jdbc.Sql;
 
 public interface Collectable<ELEMENT> extends Statement<List<ELEMENT>>, Listable<ELEMENT> {
 
   <RESULT> RESULT mapStream(Function<Stream<ELEMENT>, RESULT> streamMapper);
 
   <RESULT> RESULT collect(Collector<ELEMENT, ?, RESULT> collector);
+
+  default Collectable<ELEMENT> peek(Consumer<Sql<?>> consumer) {
+    consumer.accept(asSql());
+    return this;
+  }
 }
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlBatchDeleteStatement.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlBatchDeleteStatement.java
@@ -13,7 +13,8 @@
 import org.seasar.doma.jdbc.query.AutoBatchDeleteQuery;
 import org.seasar.doma.jdbc.query.Query;
 
-public class EntityqlBatchDeleteStatement<ENTITY> extends AbstractStatement<List<ENTITY>> {
+public class EntityqlBatchDeleteStatement<ENTITY>
+    extends AbstractStatement<List<ENTITY>, EntityqlBatchDeleteStatement<ENTITY>> {
 
   private static final EmptySql EMPTY_SQL = new EmptySql(SqlKind.BATCH_DELETE);
   private final EntityDef<ENTITY> entityDef;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlBatchInsertStatement.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlBatchInsertStatement.java
@@ -13,7 +13,8 @@
 import org.seasar.doma.jdbc.query.AutoBatchInsertQuery;
 import org.seasar.doma.jdbc.query.Query;
 
-public class EntityqlBatchInsertStatement<ENTITY> extends AbstractStatement<List<ENTITY>> {
+public class EntityqlBatchInsertStatement<ENTITY>
+    extends AbstractStatement<List<ENTITY>, EntityqlBatchInsertStatement<ENTITY>> {
 
   private static final EmptySql EMPTY_SQL = new EmptySql(SqlKind.BATCH_INSERT);
   private final EntityDef<ENTITY> entityDef;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlBatchUpdateStatement.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlBatchUpdateStatement.java
@@ -13,7 +13,8 @@
 import org.seasar.doma.jdbc.query.AutoBatchUpdateQuery;
 import org.seasar.doma.jdbc.query.Query;
 
-public class EntityqlBatchUpdateStatement<ENTITY> extends AbstractStatement<List<ENTITY>> {
+public class EntityqlBatchUpdateStatement<ENTITY>
+    extends AbstractStatement<List<ENTITY>, EntityqlBatchUpdateStatement<ENTITY>> {
 
   private static final EmptySql EMPTY_SQL = new EmptySql(SqlKind.BATCH_UPDATE);
   private final EntityDef<ENTITY> entityDef;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlDeleteStatement.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlDeleteStatement.java
@@ -10,7 +10,8 @@
 import org.seasar.doma.jdbc.query.AutoDeleteQuery;
 import org.seasar.doma.jdbc.query.Query;
 
-public class EntityqlDeleteStatement<ENTITY> extends AbstractStatement<ENTITY> {
+public class EntityqlDeleteStatement<ENTITY>
+    extends AbstractStatement<ENTITY, EntityqlDeleteStatement<ENTITY>> {
 
   private final EntityDef<ENTITY> entityDef;
   private final ENTITY entity;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlInsertStatement.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlInsertStatement.java
@@ -10,7 +10,8 @@
 import org.seasar.doma.jdbc.query.AutoInsertQuery;
 import org.seasar.doma.jdbc.query.Query;
 
-public class EntityqlInsertStatement<ENTITY> extends AbstractStatement<ENTITY> {
+public class EntityqlInsertStatement<ENTITY>
+    extends AbstractStatement<ENTITY, EntityqlInsertStatement<ENTITY>> {
 
   private final EntityDef<ENTITY> entityDef;
   private final ENTITY entity;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlSelectStatement.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlSelectStatement.java
@@ -20,7 +20,8 @@
 import org.seasar.doma.jdbc.criteria.query.CriteriaQuery;
 import org.seasar.doma.jdbc.criteria.query.SelectBuilder;
 
-public class EntityqlSelectStatement<ENTITY> extends AbstractStatement<List<ENTITY>>
+public class EntityqlSelectStatement<ENTITY>
+    extends AbstractStatement<List<ENTITY>, EntityqlSelectStatement<ENTITY>>
     implements Listable<ENTITY> {
 
   private final SelectFromDeclaration declaration;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlUpdateStatement.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlUpdateStatement.java
@@ -10,7 +10,8 @@
 import org.seasar.doma.jdbc.query.AutoUpdateQuery;
 import org.seasar.doma.jdbc.query.Query;
 
-public class EntityqlUpdateStatement<ENTITY> extends AbstractStatement<ENTITY> {
+public class EntityqlUpdateStatement<ENTITY>
+    extends AbstractStatement<ENTITY, EntityqlUpdateStatement<ENTITY>> {
 
   private final EntityDef<ENTITY> entityDef;
   private final ENTITY entity;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/Listable.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/Listable.java
@@ -2,7 +2,9 @@
 
 import java.util.List;
 import java.util.Optional;
+import java.util.function.Consumer;
 import java.util.stream.Stream;
+import org.seasar.doma.jdbc.Sql;
 
 public interface Listable<ELEMENT> extends Statement<List<ELEMENT>> {
 
@@ -17,4 +19,9 @@ default Optional<ELEMENT> getSingleResult() {
   default Stream<ELEMENT> stream() {
     return execute().stream();
   }
+
+  default Listable<ELEMENT> peek(Consumer<Sql<?>> consumer) {
+    consumer.accept(asSql());
+    return this;
+  }
 }
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/Mappable.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/Mappable.java
@@ -1,8 +1,15 @@
 package org.seasar.doma.jdbc.criteria.statement;
 
+import java.util.function.Consumer;
 import java.util.function.Function;
+import org.seasar.doma.jdbc.Sql;
 
 public interface Mappable<ELEMENT> extends SetOperand<ELEMENT>, Buildable {
 
   Collectable<ELEMENT> map(Function<Row, ELEMENT> mapper);
+
+  default Mappable<ELEMENT> peek(Consumer<Sql<?>> consumer) {
+    consumer.accept(asSql());
+    return this;
+  }
 }
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlDeleteStarting.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlDeleteStarting.java
@@ -7,7 +7,7 @@
 import org.seasar.doma.jdbc.criteria.declaration.DeleteDeclaration;
 import org.seasar.doma.jdbc.criteria.declaration.WhereDeclaration;
 
-public class NativeSqlDeleteStarting extends AbstractStatement<Integer> {
+public class NativeSqlDeleteStarting extends AbstractStatement<Integer, NativeSqlDeleteStarting> {
 
   private final DeleteDeclaration declaration;
 
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlDeleteTerminal.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlDeleteTerminal.java
@@ -11,7 +11,7 @@
 import org.seasar.doma.jdbc.criteria.query.CriteriaQuery;
 import org.seasar.doma.jdbc.criteria.query.DeleteBuilder;
 
-public class NativeSqlDeleteTerminal extends AbstractStatement<Integer> {
+public class NativeSqlDeleteTerminal extends AbstractStatement<Integer, NativeSqlDeleteTerminal> {
 
   private final DeleteDeclaration declaration;
 
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlInsertTerminal.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlInsertTerminal.java
@@ -11,7 +11,7 @@
 import org.seasar.doma.jdbc.criteria.query.CriteriaQuery;
 import org.seasar.doma.jdbc.criteria.query.InsertBuilder;
 
-public class NativeSqlInsertTerminal extends AbstractStatement<Integer> {
+public class NativeSqlInsertTerminal extends AbstractStatement<Integer, NativeSqlInsertTerminal> {
 
   private final InsertDeclaration declaration;
 
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlSelectCollectable.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlSelectCollectable.java
@@ -14,7 +14,8 @@
 import org.seasar.doma.jdbc.criteria.declaration.SelectFromDeclaration;
 import org.seasar.doma.jdbc.criteria.def.PropertyDef;
 
-public class NativeSqlSelectCollectable<ELEMENT> extends AbstractStatement<List<ELEMENT>>
+public class NativeSqlSelectCollectable<ELEMENT>
+    extends AbstractStatement<List<ELEMENT>, NativeSqlSelectCollectable<ELEMENT>>
     implements Collectable<ELEMENT> {
 
   private final SelectFromDeclaration declaration;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlSelectStarting.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlSelectStarting.java
@@ -21,7 +21,8 @@
 import org.seasar.doma.jdbc.criteria.def.EntityDef;
 import org.seasar.doma.jdbc.criteria.def.PropertyDef;
 
-public class NativeSqlSelectStarting<ENTITY> extends AbstractStatement<List<ENTITY>>
+public class NativeSqlSelectStarting<ENTITY>
+    extends AbstractStatement<List<ENTITY>, NativeSqlSelectStarting<ENTITY>>
     implements Collectable<ENTITY> {
 
   private final SelectFromDeclaration declaration;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlSelectTerminal.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlSelectTerminal.java
@@ -12,7 +12,8 @@
 import org.seasar.doma.jdbc.criteria.query.CriteriaQuery;
 import org.seasar.doma.jdbc.criteria.query.SelectBuilder;
 
-public class NativeSqlSelectTerminal<RESULT> extends AbstractStatement<RESULT> {
+public class NativeSqlSelectTerminal<RESULT>
+    extends AbstractStatement<RESULT, NativeSqlSelectTerminal<RESULT>> {
 
   private final SelectFromDeclaration declaration;
   private final ResultSetHandler<RESULT> resultSetHandler;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlSetCollectable.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlSetCollectable.java
@@ -13,7 +13,8 @@
 import org.seasar.doma.jdbc.criteria.command.SetOperationResultStreamHandler;
 import org.seasar.doma.jdbc.criteria.context.SetOperationContext;
 
-public class NativeSqlSetCollectable<ELEMENT> extends AbstractStatement<List<ELEMENT>>
+public class NativeSqlSetCollectable<ELEMENT>
+    extends AbstractStatement<List<ELEMENT>, NativeSqlSetCollectable<ELEMENT>>
     implements Collectable<ELEMENT> {
 
   private final SetOperationContext<ELEMENT> context;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlSetTerminal.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlSetTerminal.java
@@ -11,7 +11,8 @@
 import org.seasar.doma.jdbc.criteria.query.CriteriaQuery;
 import org.seasar.doma.jdbc.criteria.query.SetOperationBuilder;
 
-public class NativeSqlSetTerminal<RESULT> extends AbstractStatement<RESULT> {
+public class NativeSqlSetTerminal<RESULT>
+    extends AbstractStatement<RESULT, NativeSqlSetTerminal<RESULT>> {
 
   private final SetOperationContext<?> context;
   private final ResultSetHandler<RESULT> resultSetHandler;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlUpdateTerminal.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/NativeSqlUpdateTerminal.java
@@ -13,7 +13,7 @@
 import org.seasar.doma.jdbc.criteria.query.CriteriaQuery;
 import org.seasar.doma.jdbc.criteria.query.UpdateBuilder;
 
-public class NativeSqlUpdateTerminal extends AbstractStatement<Integer> {
+public class NativeSqlUpdateTerminal extends AbstractStatement<Integer, NativeSqlUpdateTerminal> {
 
   private final UpdateDeclaration declaration;
 
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/Peekable.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/Peekable.java
@@ -0,0 +1,13 @@
+package org.seasar.doma.jdbc.criteria.statement;
+
+import java.util.function.Consumer;
+import org.seasar.doma.jdbc.Sql;
+
+public interface Peekable<PEEKABLE extends Peekable<PEEKABLE>> extends Buildable {
+
+  @SuppressWarnings("unchecked")
+  default PEEKABLE peek(Consumer<Sql<?>> consumer) {
+    consumer.accept(asSql());
+    return (PEEKABLE) this;
+  }
+}
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/Statement.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/Statement.java
@@ -1,6 +1,14 @@
 package org.seasar.doma.jdbc.criteria.statement;
 
+import java.util.function.Consumer;
+import org.seasar.doma.jdbc.Sql;
+
 public interface Statement<RESULT> extends Buildable {
 
   RESULT execute();
+
+  default Statement<RESULT> peek(Consumer<Sql<?>> consumer) {
+    consumer.accept(asSql());
+    return this;
+  }
 }
diff --git a/doma-core/src/test/java/org/seasar/doma/jdbc/criteria/NativeSqlSelectTest.java b/doma-core/src/test/java/org/seasar/doma/jdbc/criteria/NativeSqlSelectTest.java
@@ -851,4 +851,18 @@ public String comment(String sql, CommentContext context) {
         "// hello\nselect t0_.ID, t0_.NAME, t0_.SALARY, t0_.VERSION from EMP t0_",
         sql.getFormattedSql());
   }
+
+  @Test
+  void peek() {
+    Emp_ e = new Emp_();
+    Dept_ d = new Dept_();
+    Collectable<Object> stmt =
+        nativeSql
+            .from(e)
+            .select(e.name)
+            .peek(System.out::println)
+            .union(nativeSql.from(d).select(d.name).peek(System.out::println))
+            .peek(System.out::println)
+            .map(row -> row.get(e.name));
+  }
 }
diff --git a/test-criteria/src/test/java/example/EntityqlSelectTest.java b/test-criteria/src/test/java/example/EntityqlSelectTest.java
@@ -204,4 +204,19 @@ void asSql() {
     System.out.printf("Raw SQL      : %s\n", sql.getRawSql());
     System.out.printf("Formatted SQL: %s\n", sql.getFormattedSql());
   }
+
+  @Test
+  void peek() {
+    Department_ d = new Department_();
+
+    List<Department> list =
+        entityql
+            .from(d)
+            .peek(System.out::println)
+            .where(c -> c.eq(d.departmentName, "SALES"))
+            .peek(System.out::println)
+            .orderBy(c -> c.asc(d.location))
+            .peek(sql -> System.out.println(sql.getFormattedSql()))
+            .getResultList();
+  }
 }
