SQLファイルでUPDATE文のSET句を自動生成

UPDATE文のWHERE句を手書きしたいがSET句は自動設定したいという要望に応える機能です。
次のように記述できます。

```java
@entity
class Person {
  @id
  Integer id;
  String name;
  Integer age;
  @Version
  Integer version;
}
```

```java
@dao
interface PersonDao {
  @update(sqlFile = true)
  int update(Person person, int age);
}
```

```sql
// SQLファイル PersonDao/update.sql
update person set /*%populate */ id = id where age < /* age */0
```

```sql
// 上記SQLファイルに対応するPreparedStatement
update person set name = ?, age = ?, version = ? + 1 where age < ?
```

この機能のポイントは次のものです。

- SQLファイル内の `/*%populate */` からWHERE句までが自動で置き換えられる
  - `pupulate` ではなく `values` というキーワードを使う案もあったが、式コメント内ではSQLの文脈と異なるキーワードを使ったほうがわかりやすいと判断
- SET句の生成結果は `@Update(sqlFile = false)` のときと全く同じ
  - IDは含めない
  - VERSIONはインクリメントする
  - `@Update` の `ignoreVersion` や `suppressOptimisticLockException` 等の要素も有効
- Daoメソッドの第一引数はエンティティクラスでなければいけない
  - エンティティクラスのプロパティがSET句に展開される
  - 第二引数以降は任意の型を指定でき、その引数はSQLファイルの式コメントから参照できる
- `/*%populate */` は `@Update(sqlFile = true)` のときだけでなく `@BatchUpdate(sqlFile = true)` のときも使える

Author: nakamura-to

src/main/java/org/seasar/doma/internal/apt/BatchSqlValidator.java

@@ -45,8 +45,9 @@ public class BatchSqlValidator extends SqlValidator {
     public BatchSqlValidator(ProcessingEnvironment env,
             ExecutableElement methodElement,
             Map<String, TypeMirror> parameterTypeMap, String path,
-            boolean expandable) {
-        super(env, methodElement, parameterTypeMap, path, expandable);
+            boolean expandable, boolean populatable) {
+        super(env, methodElement, parameterTypeMap, path, expandable,
+                populatable);
         suppress = methodElement.getAnnotation(Suppress.class);
     }
 

src/main/java/org/seasar/doma/internal/apt/DaoGenerator.java

@@ -721,11 +721,34 @@ public Void visitSqlFileModifyQueryMeta(SqlFileModifyQueryMeta m,
                         m.getEntityCtType().getBoxedMetaTypeName());
             }
 
+            Boolean excludeNull = m.getExcludeNull();
+            if (excludeNull != null) {
+                iprint("__query.setNullExcluded(%1$s);%n", excludeNull);
+            }
+
             Boolean ignoreVersion = m.getIgnoreVersion();
             if (ignoreVersion != null) {
                 iprint("__query.setVersionIgnored(%1$s);%n", ignoreVersion);
             }
 
+            List<String> include = m.getInclude();
+            if (include != null) {
+                iprint("__query.setIncludedPropertyNames(%1$s);%n",
+                        toCSVFormat(include));
+            }
+
+            List<String> exclude = m.getExclude();
+            if (exclude != null) {
+                iprint("__query.setExcludedPropertyNames(%1$s);%n",
+                        toCSVFormat(m.getExclude()));
+            }
+
+            Boolean includeUnchanged = m.getIncludeUnchanged();
+            if (includeUnchanged != null) {
+                iprint("__query.setUnchangedPropertyIncluded(%1$s);%n",
+                        includeUnchanged);
+            }
+
             Boolean suppressOptimisticLockException = m
                     .getSuppressOptimisticLockException();
             if (suppressOptimisticLockException != null) {
@@ -869,6 +892,18 @@ public Void visitSqlFileBatchModifyQueryMeta(
                 iprint("__query.setVersionIgnored(%1$s);%n", ignoreVersion);
             }
 
+            List<String> include = m.getInclude();
+            if (include != null) {
+                iprint("__query.setIncludedPropertyNames(%1$s);%n",
+                        toCSVFormat(include));
+            }
+
+            List<String> exclude = m.getExclude();
+            if (exclude != null) {
+                iprint("__query.setExcludedPropertyNames(%1$s);%n",
+                        toCSVFormat(exclude));
+            }
+
             Boolean suppressOptimisticLockException = m
                     .getSuppressOptimisticLockException();
             if (suppressOptimisticLockException != null) {

src/main/java/org/seasar/doma/internal/apt/SqlValidator.java

@@ -45,6 +45,7 @@
 import org.seasar.doma.internal.jdbc.sql.node.ForBlockNode;
 import org.seasar.doma.internal.jdbc.sql.node.ForNode;
 import org.seasar.doma.internal.jdbc.sql.node.IfNode;
+import org.seasar.doma.internal.jdbc.sql.node.PopulateNode;
 import org.seasar.doma.internal.jdbc.sql.node.SqlLocation;
 import org.seasar.doma.jdbc.SqlNode;
 import org.seasar.doma.message.Message;
@@ -67,18 +68,21 @@ public class SqlValidator extends SimpleSqlNodeVisitor<Void, Void> {
 
     protected final boolean expandable;
 
+    protected final boolean populatable;
+
     protected final ExpressionValidator expressionValidator;
 
     public SqlValidator(ProcessingEnvironment env,
             ExecutableElement methodElement,
             Map<String, TypeMirror> parameterTypeMap, String path,
-            boolean expandable) {
+            boolean expandable, boolean populatable) {
         assertNotNull(env, methodElement, parameterTypeMap, path);
         this.env = env;
         this.methodElement = methodElement;
         this.parameterTypeMap = parameterTypeMap;
         this.path = path;
         this.expandable = expandable;
+        this.populatable = populatable;
         expressionValidator = new ExpressionValidator(env, methodElement,
                 parameterTypeMap);
     }
@@ -279,6 +283,17 @@ public Void visitExpandNode(ExpandNode node, Void p) {
         return visitNode(node, p);
     }
 
+    @Override
+    public Void visitPopulateNode(PopulateNode node, Void p) {
+        if (!populatable) {
+            SqlLocation location = node.getLocation();
+            String sql = getSql(location);
+            throw new AptException(Message.DOMA4270, env, methodElement, path,
+                    sql, location.getLineNumber(), location.getPosition());
+        }
+        return visitNode(node, p);
+    }
+
     @Override
     protected Void defaultAction(SqlNode node, Void p) {
         return visitNode(node, p);

src/main/java/org/seasar/doma/internal/apt/meta/AbstractSqlFileQueryMetaFactory.java

@@ -53,7 +53,7 @@ protected AbstractSqlFileQueryMetaFactory(ProcessingEnvironment env) {
     }
 
     protected void doSqlFiles(M queryMeta, ExecutableElement method,
-            DaoMeta daoMeta, boolean expandable) {
+            DaoMeta daoMeta, boolean expandable, boolean populatable) {
         if (!Options.getSqlValidation(env)) {
             return;
         }
@@ -77,7 +77,7 @@ protected void doSqlFiles(M queryMeta, ExecutableElement method,
                         sqlFilePath, sql);
                 SqlValidator validator = createSqlValidator(method,
                         queryMeta.getBindableParameterTypeMap(), sqlFilePath,
-                        expandable);
+                        expandable, populatable);
                 validator.validate(sqlNode);
                 queryMeta.addFileName(fileName);
             }
@@ -153,8 +153,8 @@ protected SqlNode createSqlNode(M queryMeta, ExecutableElement method,
 
     protected SqlValidator createSqlValidator(ExecutableElement method,
             Map<String, TypeMirror> parameterTypeMap, String sqlFilePath,
-            boolean expandable) {
+            boolean expandable, boolean populatable) {
         return new SqlValidator(env, method, parameterTypeMap, sqlFilePath,
-                expandable);
+                expandable, populatable);
     }
 }

src/main/java/org/seasar/doma/internal/apt/meta/SqlFileBatchModifyQueryMeta.java

@@ -15,6 +15,8 @@
  */
 package org.seasar.doma.internal.apt.meta;
 
+import java.util.List;
+
 import javax.lang.model.element.ExecutableElement;
 
 import org.seasar.doma.internal.apt.cttype.CtType;
@@ -89,10 +91,23 @@ public Boolean getSuppressOptimisticLockException() {
         return batchModifyMirror.getSuppressOptimisticLockExceptionValue();
     }
 
+    public List<String> getInclude() {
+        return batchModifyMirror.getIncludeValue();
+    }
+
+    public List<String> getExclude() {
+        return batchModifyMirror.getExcludeValue();
+    }
+
     public SqlLogType getSqlLogType() {
         return batchModifyMirror.getSqlLogValue();
     }
 
+    public boolean isPopulatable() {
+        return entityCtType != null
+                && queryKind == QueryKind.SQLFILE_BATCH_UPDATE;
+    }
+
     @Override
     public void addBindableParameterCtType(final String parameterName,
             CtType bindableParameterCtType) {

src/main/java/org/seasar/doma/internal/apt/meta/SqlFileBatchModifyQueryMetaFactory.java

@@ -61,7 +61,7 @@ public QueryMeta createQueryMeta(ExecutableElement method, DaoMeta daoMeta) {
         doParameters(queryMeta, method, daoMeta);
         doReturnType(queryMeta, method, daoMeta);
         doThrowTypes(queryMeta, method, daoMeta);
-        doSqlFiles(queryMeta, method, daoMeta, false);
+        doSqlFiles(queryMeta, method, daoMeta, false, queryMeta.isPopulatable());
         return queryMeta;
     }
 
@@ -162,9 +162,9 @@ public Void visitEntityCtType(EntityCtType ctType, Void p)
     @Override
     protected SqlValidator createSqlValidator(ExecutableElement method,
             Map<String, TypeMirror> parameterTypeMap, String sqlFilePath,
-            boolean expandable) {
+            boolean expandable, boolean populatable) {
         return new BatchSqlValidator(env, method, parameterTypeMap,
-                sqlFilePath, expandable);
+                sqlFilePath, expandable, populatable);
     }
 
 }

src/main/java/org/seasar/doma/internal/apt/meta/SqlFileModifyQueryMeta.java

@@ -15,6 +15,8 @@
  */
 package org.seasar.doma.internal.apt.meta;
 
+import java.util.List;
+
 import javax.lang.model.element.ExecutableElement;
 
 import org.seasar.doma.internal.apt.cttype.EntityCtType;
@@ -69,14 +71,34 @@ public Boolean getIgnoreVersion() {
         return modifyMirror.getIgnoreVersionValue();
     }
 
+    public Boolean getExcludeNull() {
+        return modifyMirror.getExcludeNullValue();
+    }
+
     public Boolean getSuppressOptimisticLockException() {
         return modifyMirror.getSuppressOptimisticLockExceptionValue();
     }
 
+    public Boolean getIncludeUnchanged() {
+        return modifyMirror.getIncludeUnchangedValue();
+    }
+
+    public List<String> getInclude() {
+        return modifyMirror.getIncludeValue();
+    }
+
+    public List<String> getExclude() {
+        return modifyMirror.getExcludeValue();
+    }
+
     public SqlLogType getSqlLogType() {
         return modifyMirror.getSqlLogValue();
     }
 
+    public boolean isPopulatable() {
+        return entityCtType != null && queryKind == QueryKind.SQLFILE_UPDATE;
+    }
+
     @Override
     public <R, P> R accept(QueryMetaVisitor<R, P> visitor, P p) {
         return visitor.visitSqlFileModifyQueryMeta(this, p);

src/main/java/org/seasar/doma/internal/apt/meta/SqlFileModifyQueryMetaFactory.java

@@ -53,7 +53,7 @@ public QueryMeta createQueryMeta(ExecutableElement method, DaoMeta daoMeta) {
         doParameters(queryMeta, method, daoMeta);
         doReturnType(queryMeta, method, daoMeta);
         doThrowTypes(queryMeta, method, daoMeta);
-        doSqlFiles(queryMeta, method, daoMeta, false);
+        doSqlFiles(queryMeta, method, daoMeta, false, queryMeta.isPopulatable());
         return queryMeta;
     }
 

src/main/java/org/seasar/doma/internal/apt/meta/SqlFileScriptQueryMetaFactory.java

@@ -50,7 +50,7 @@ public QueryMeta createQueryMeta(ExecutableElement method, DaoMeta daoMeta) {
         doReturnType(queryMeta, method, daoMeta);
         doParameters(queryMeta, method, daoMeta);
         doThrowTypes(queryMeta, method, daoMeta);
-        doSqlFiles(queryMeta, method, daoMeta, false);
+        doSqlFiles(queryMeta, method, daoMeta, false, false);
         return queryMeta;
     }
 
@@ -87,7 +87,8 @@ protected void doParameters(SqlFileScriptQueryMeta queryMeta,
 
     @Override
     protected void doSqlFiles(SqlFileScriptQueryMeta queryMeta,
-            ExecutableElement method, DaoMeta daoMeta, boolean expandable) {
+            ExecutableElement method, DaoMeta daoMeta, boolean expandable,
+            boolean populatable) {
         String filePath = ScriptFileUtil.buildPath(daoMeta.getDaoElement()
                 .getQualifiedName().toString(), queryMeta.getName());
         File file = getFile(queryMeta, method, filePath);

src/main/java/org/seasar/doma/internal/apt/meta/SqlFileSelectQueryMeta.java

@@ -153,6 +153,10 @@ public SqlLogType getSqlLogType() {
         return selectMirror.getSqlLogValue();
     }
 
+    public boolean isExpandable() {
+        return entityCtType != null;
+    }
+
     @Override
     public <R, P> R accept(QueryMetaVisitor<R, P> visitor, P p) {
         return visitor.visitSqlFileSelectQueryMeta(this, p);