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

[nakamura-to]

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

@Entity
class Person {
  @Id
  Integer id;
  String name;
  Integer age;
  @Version
  Integer version;
}

@Dao
interface PersonDao {
  @Update(sqlFile = true)
  int update(Person person, int age);
}

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

// 上記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) のときも使える