Add support for appending parameters in user-defined criteria

momosetkn · momosetkn · commit 17d98d9bd53a · 2025-05-25T23:33:23.000+09:00
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/declaration/UserDefinedCriteriaContext.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/declaration/UserDefinedCriteriaContext.java
@@ -54,6 +54,15 @@ interface Builder {
      */
     void appendExpression(PropertyMetamodel<?> propertyMetamodel);
 
+    /**
+     * Appends a parameter.
+     *
+     * @param left the property metamodel representing the left operand
+     * @param right the value to be paired with the left operand
+     * @param <PROPERTY> the type of the property
+     */
+    <PROPERTY> void appendParameter(PropertyMetamodel<PROPERTY> left, PROPERTY right);
+
     /**
      * Represents the specific database dialect. This is utilized to modify user-defined expressions
      * based on the dialect in use.
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/query/BuilderSupport.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/query/BuilderSupport.java
@@ -957,6 +957,13 @@ public void appendExpression(PropertyMetamodel<?> propertyMetamodel) {
       propertyMetamodel.accept(propertyMetamodelVisitor);
     }
 
+    @Override
+    public <PROPERTY> void appendParameter(PropertyMetamodel<PROPERTY> left, PROPERTY right) {
+      var param = new Operand.Param(left, right);
+      var parameter = param.createInParameter(config);
+      param(parameter);
+    }
+
     @Override
     public Dialect getDialect() {
       return config.getDialect();
diff --git a/doma-core/src/test/java/org/seasar/doma/jdbc/criteria/MyExtension.java b/doma-core/src/test/java/org/seasar/doma/jdbc/criteria/MyExtension.java
@@ -16,20 +16,28 @@
 package org.seasar.doma.jdbc.criteria;
 
 import org.seasar.doma.jdbc.criteria.declaration.UserDefinedCriteriaContext;
-import org.seasar.doma.jdbc.criteria.expression.Expressions;
 import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel;
 
 record MyExtension(UserDefinedCriteriaContext context) {
-  public void likeMultiple(PropertyMetamodel<?> entityMetamodel, String... patterns) {
+  public void likeMultiple(PropertyMetamodel<String> entityMetamodel, String... patterns) {
     context.add(
         (b) -> {
           for (String pattern : patterns) {
             b.appendExpression(entityMetamodel);
             b.appendSql(" like ");
-            b.appendExpression(Expressions.literal("%" + pattern + "%"));
+            b.appendParameter(entityMetamodel, "%" + pattern + "%");
             b.appendSql(" or ");
           }
           b.cutBackSql(4);
         });
   }
+
+  public void eq2(PropertyMetamodel<String> entityMetamodel, String pattern) {
+    context.add(
+        (b) -> {
+          b.appendExpression(entityMetamodel);
+          b.appendSql(" = ");
+          b.appendParameter(entityMetamodel, pattern);
+        });
+  }
 }
diff --git a/doma-core/src/test/java/org/seasar/doma/jdbc/criteria/QueryDslSqlSelectTest.java b/doma-core/src/test/java/org/seasar/doma/jdbc/criteria/QueryDslSqlSelectTest.java
@@ -1895,6 +1895,25 @@ void extension_or_and() {
         sql.getFormattedSql());
   }
 
+  @Test
+  void extension_null() {
+    var e = new Emp_();
+    var stmt =
+        dsl.from(e)
+            .where(
+                c -> {
+                  c.extension(
+                      MyExtension::new,
+                      (ext) -> {
+                        ext.eq2(e.name, null);
+                      });
+                })
+            .select(e.id);
+
+    var sql = stmt.asSql();
+    assertEquals("select t0_.ID from EMP t0_ where t0_.NAME = null", sql.getFormattedSql());
+  }
+
   private static UserDefinedExpression<Long> countDistinctMultiple(
       PropertyMetamodel<?>... propertyMetamodels) {
     return userDefined(
diff --git a/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/declaration/KComparisonDeclaration.kt b/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/declaration/KComparisonDeclaration.kt
@@ -115,6 +115,8 @@ abstract class KComparisonDeclaration<DECLARATION : org.seasar.doma.jdbc.criteri
                     override fun cutBackSql(length: Int) = builder.cutBackSql(length)
                     override fun appendExpression(propertyMetamodel: PropertyMetamodel<*>) =
                         builder.appendExpression(propertyMetamodel)
+                    override fun <PROPERTY> appendParameter(left: PropertyMetamodel<PROPERTY>, right: PROPERTY?) =
+                        builder.appendParameter(left, right)
                     override val dialect: Dialect
                         get() = builder.dialect
                 })
diff --git a/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/declaration/KUserDefinedCriteriaContext.kt b/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/declaration/KUserDefinedCriteriaContext.kt
@@ -28,6 +28,8 @@ fun interface KUserDefinedCriteriaContext {
 
         fun appendExpression(propertyMetamodel: PropertyMetamodel<*>)
 
+        fun <PROPERTY> appendParameter(left: PropertyMetamodel<PROPERTY>, right: PROPERTY?)
+
         val dialect: Dialect
     }
 }
diff --git a/doma-kotlin/src/test/kotlin/org/seasar/doma/jdbc/criteria/KQueryDslSqlSelectTest.kt b/doma-kotlin/src/test/kotlin/org/seasar/doma/jdbc/criteria/KQueryDslSqlSelectTest.kt
@@ -707,6 +707,24 @@ internal class KQueryDslSqlSelectTest {
         )
     }
 
+    @Test
+    fun where_null() {
+        val e = Emp_()
+        val stmt = dsl
+            .from(e)
+            .where {
+                extension(::MyExtension) {
+                    eq2(e.name, null)
+                }
+            }
+            .select(e.id)
+        val sql = stmt.asSql()
+        assertEquals(
+            "select t0_.ID from EMP t0_ where t0_.NAME = null",
+            sql.formattedSql,
+        )
+    }
+
     @Test
     fun innerJoin() {
         val e = Emp_()
diff --git a/doma-kotlin/src/test/kotlin/org/seasar/doma/jdbc/criteria/MyExtension.kt b/doma-kotlin/src/test/kotlin/org/seasar/doma/jdbc/criteria/MyExtension.kt
@@ -17,19 +17,26 @@ package org.seasar.doma.jdbc.criteria
 
 import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel
 import org.seasar.doma.kotlin.jdbc.criteria.declaration.KUserDefinedCriteriaContext
-import org.seasar.doma.kotlin.jdbc.criteria.expression.KExpressions
 
 data class MyExtension(val context: KUserDefinedCriteriaContext) {
-    fun likeMultiple(entityMetamodel: PropertyMetamodel<*>, vararg patterns: String) {
+    fun likeMultiple(propertyMetamodel: PropertyMetamodel<String>, vararg patterns: String) {
         context.add {
             patterns.forEach { pattern ->
-                appendExpression(entityMetamodel)
+                appendExpression(propertyMetamodel)
                 appendSql(" like ")
-                appendExpression(KExpressions.literal("%" + pattern + "%"))
+                appendParameter(propertyMetamodel, "%$pattern%")
                 appendSql(" escape '\\'")
                 appendSql(" and ")
             }
             cutBackSql(5)
         }
     }
+
+    fun eq2(entityMetamodel: PropertyMetamodel<String?>, pattern: String?) {
+        context.add {
+            appendExpression(entityMetamodel)
+            appendSql(" = ")
+            appendParameter(entityMetamodel, pattern)
+        }
+    }
 }
diff --git a/integration-test-java/src/test/java/org/seasar/doma/it/criteria/MyExtension.java b/integration-test-java/src/test/java/org/seasar/doma/it/criteria/MyExtension.java
@@ -16,33 +16,41 @@
 package org.seasar.doma.it.criteria;
 
 import org.seasar.doma.jdbc.criteria.declaration.UserDefinedCriteriaContext;
-import org.seasar.doma.jdbc.criteria.expression.Expressions;
 import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel;
 
 record MyExtension(UserDefinedCriteriaContext context) {
-  public void regexp(PropertyMetamodel<?> entityMetamodel, String regexp) {
+  public void regexp(PropertyMetamodel<String> entityMetamodel, String regexp) {
     context.add(
         (b) -> {
           var dialectName = b.getDialect().getName();
           if (dialectName.startsWith("mysql")) {
             b.appendExpression(entityMetamodel);
             b.appendSql(" regexp ");
-            b.appendExpression(Expressions.literal(regexp));
+            b.appendParameter(entityMetamodel, regexp);
           } else if (dialectName.equals("postgres")) {
             b.appendExpression(entityMetamodel);
             b.appendSql(" ~ ");
-            b.appendExpression(Expressions.literal(regexp));
+            b.appendParameter(entityMetamodel, regexp);
           } else if (dialectName.equals("oracle")) {
             b.appendSql("regexp_like(");
             b.appendExpression(entityMetamodel);
             b.appendSql(",");
-            b.appendExpression(Expressions.literal(regexp));
+            b.appendParameter(entityMetamodel, regexp);
             b.appendSql(")");
           } else {
             b.appendExpression(entityMetamodel);
             b.appendSql(" like ");
-            b.appendExpression(Expressions.literal("%" + regexp + "%"));
+            b.appendParameter(entityMetamodel, "%" + regexp + "%");
           }
         });
   }
+
+  public void eq2(PropertyMetamodel<String> entityMetamodel, String pattern) {
+    context.add(
+        (b) -> {
+          b.appendExpression(entityMetamodel);
+          b.appendSql(" = ");
+          b.appendParameter(entityMetamodel, pattern);
+        });
+  }
 }
diff --git a/integration-test-java/src/test/java/org/seasar/doma/it/criteria/QueryDslSqlSelectTest.java b/integration-test-java/src/test/java/org/seasar/doma/it/criteria/QueryDslSqlSelectTest.java
@@ -1218,4 +1218,24 @@ void extension_or_and() {
     assertEquals("ACCOUNTING", list.get(0).getDepartmentName());
     assertEquals("SALES", list.get(1).getDepartmentName());
   }
+
+  @Test
+  void extension_null() {
+    var d = new Department_();
+    var list =
+        dsl.from(d)
+            .where(
+                c -> {
+                  c.extension(
+                      MyExtension::new,
+                      (ext) -> {
+                        ext.eq2(d.departmentName, null);
+                      });
+                })
+            .orderBy(c -> c.asc(d.departmentId))
+            .select()
+            .fetch();
+
+    assertEquals(0, list.size());
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,8 @@ fun interface KUserDefinedCriteriaContext {`
`28`	`28`
`29`	`29`	`fun appendExpression(propertyMetamodel: PropertyMetamodel<*>)`
`30`	`30`
	`31`	`+ fun <PROPERTY> appendParameter(left: PropertyMetamodel<PROPERTY>, right: PROPERTY?)`
	`32`	`+`
`31`	`33`	`val dialect: Dialect`
`32`	`34`	`}`
`33`	`35`	`}`