Sc2009autumn 次世代Daoフレームワーク Doma

次世代 Dao フレームワーク Doma 2009 年 9 月 12 日中村年宏 (http://d.hatena.ne.jp/taedium)

自己紹介中村 (taedium) http:// d.hatena.ne.jp/taedium S2Container 、 S2Dao 、 Slim3 のコミッタ S2JDBC-Gen コードジェネレーションデータベースリファクタリング S2Dao 高速化対応（データベースのメタデータを不要に） Slim3-Gen apt と ant によるコードジェネレーション JPA の入門書執筆 Seasar2 と Hibernate で学ぶ JPA 入門

アジェンダ Doma の概要 apt Doma の戦略ロードマップとまとめ

Doma とは？ Domain Oriented MApping framework ドメイン指向マッピングフレームワークドメインとは？値の定義域（値がとりうる範囲）のこと、またはそれを表すクラス体重：　 0 から 500 の数値、単位は kg 　->　 Weight クラス都市名　：アルファベットの文字列　->　 CityName クラス Dao フレームワーク S2Dao 、 S2JDBC 、 Hibernate のよいところを取り入れた O/R マッパーデータベースの型とドメインをマッピング、ドメインを String や Integer など一般的な値型にマッピング SQL ファイルの実行と、 SQL の自動生成の 2 パターンに対応ただし、検索系は SQL ファイルの実行のみ

Doma を利用した構成 address dept emp BusinessLogic ( データの利用者 ) AddressDao DepartmentDao EmployeeDao update insert select Doma SQL EMPLOYEE DEPARTMENT ADDRESS emp 、 dept 、 address はエンティティのインスタンス（ドメインの集合） SQL の生成 SQL ファイルの解析 SQL の発行 DB

ドメインの利点　– タイプセーフ public void execute( String orderNo, String customerName, 　　　　 String phoneNumber, String location, String description) { 　　　　 ... } public void execute( OrderNo orderNo, CustomerName customerName, 　　　　 PhoneNumber phoneNumber, Location location, 　　　　 Description description) { ．．． } ドメインを使わない場合（値型を使用する場合）ドメインを使う場合

ドメインの利点 – 振る舞い String phoneNumber = "03-1234-5678" ; int areaCode = PhoneNumberUtil.getAreaCode (phoneNumber); PhoneNumber phoneNumber = new PhoneNumber( "03-1234-5678" ); int areaCode = phoneNumber.getAreaCode (); ドメインを使わない場合（値型を使用する場合）ドメインを使う場合 Employee id phoneNumber ... Department id phoneNumber ... 振る舞いはエンティティにもたせればいいという考え方があるが、エンティティよりもプロパティにもたせた方がコードの重複が少ない。同じドメインは複数のエンティティにまたがって使われるため。

ドメインの定義 public class PhoneNumber extends StringDomain<PhoneNumber> { private static final long serialVersionUID = 1L; public PhoneNumber() { } public PhoneNumber(String value) { super (value); } public int getAreaCode() { ... } } 値型に対応する抽象ドメインクラスを継承して作成。 public なデフォルトコンストラクタが必要。任意のメソッドをもてる。必要に応じて定義域をバリデーション。

ドメインのインタフェース public interface Domain<V, D extends Domain<V, D>> { V get(); void set(V value); void setDomain(D other); boolean isNull(); boolean isChanged(); void setChanged( boolean changed); Class<V> getValueClass(); <R, P, TH extends Throwable> R accept(DomainVisitor<R, P, TH> visitor, P p) throws TH, DomaNullPointerException; } PhoneNumber phoneNumber = new PhoneNumber(); phoneNumber.set( "03-1234-5678" ); String value = phoneNumber.get(); PhoneNumber copy = new PhoneNumber(); copy.setDomain(phoneNumber); 利用例ジェネリクスを活用しタイプセーフを実現。

エンティティの定義 @Entity public interface Employee { 　　　　 @Id 　　　　 Identity id(); 　　　　 Name name(); 　　　　 Salary salary(); 　　　　 @Version 　　　　 VersionNo version(); } インタフェース！ @Entity が必須。プロパティはフィールドではなくメソッドで定義。 getter/setter が不要で簡潔。プロパティはもちろんドメインクラス。アノテーションの名前は JPA にあわせているが、すべて org.seasar.doma のパッケージに属する。

Dao の定義 @Dao (config = AppConfig. class ) public interface EmployeeDao { 　　 @Select 　　 Employee selectById(Identity id); 　　 @Select 　　 List<Employee> selectByNames 　　　　 (List<Name> names); 　　 @Insert 　　 int insert(Employee employee); 　　 @Update 　　 int update(Employee employee); 　　 @Delete 　　 int delete(Employee employee); } やっぱりインタフェース！ @Dao が必須。データソースやデータベースの方言の指定は config に指定するクラスの中で設定。クエリの種類はすべてアノテーションで明示。メソッド名に制約はなし。

サンプルコード – 追加 Employee employee = new Employee_(); employee.id().set(99); employee.name().set( "test" ); employee.salary().set(300); EmployeeDao dao = new EmployeeDao_(); dao .insert(employee); insert into EMPLOYEE (ID, NAME, SALARY, VERSION) values (99, 'test', 300, 1) Java コード SQL のログエンティティも Dao も実装クラスを new すれば OK 。

サンプルコード – 検索 & 更新 EmployeeDao dao = new EmployeeDao_(); Employee employee = dao .selectById( new Identity(1)); employee.name().set( "hoge" ); dao .update(employee); select * from employee where id = 1 update EMPLOYEE set NAME = 'hoge', VERSION = 1 + 1 where ID = 1 and VERSION = 1 select * from employee where id = /*id*/ 0 selectById に対応する SQL ファイル Java コード SQL のログ Dao は実装クラスを new すれば OK 。

次世代とは？旧世代黒魔術に頼りすぎてしまった時代限定的に使用すれば少ないコードで効力を発揮するが、一歩誤ると生産性や保守性を損なう技術。アプリケーションで管理されたソースコードをみただけでは挙動がわからない。わかりにくいエラーメッセージが出ることも。 AOP （バイトコードエンハンス）命名規約次世代脱黒魔術ソースコードのとおりに動くバイトコードエンハンスや命名規約を使った場合と同等のソースコードを生成。デバッグしやすい規約は事前にチェックするコンパイルエラーとして扱えば単なる命名規約ではないエラーが起きてもエラーメッセージがわかりやすい

脱黒魔術のためのツール： apt Pluggable Annotation Processing API Java6 から導入されたアノテーション処理のための API javax.annotation.processing javax.lang.model javax.lang.model.element javax.lang.model.type javax.lang.model.util コンパイル時に次のことが可能ソースコードの生成ソースコードの検証リソースの参照リスースの生成

apt の魅力コンパイル時に自動で実行されるコンパイルするだけでよいコンパイル以外で別の処理（ ant タスクやプラグインなどで）を実行したり、実行時にオプション指定（ java の -javaagent ）をする必要がない開発環境（ Eclipse ）でも javac でも動作するエラーを早期に検出できる実行時ではなくコンパイル時に検出動かさなくても間違いに気づけるため開発効率が高い実行時の負荷を軽減できる多くのフレームワークは実行時にクラスのメタ情報を解析しキャッシュするが、 apt を使えば、メタ情報をコンパイル時にあらかじめソースコードにして出力。解析やキャッシュの必要性がない。

Doma における apt の利用エンティティの検証・実装クラスの生成 Dao の検証・実装クラスの生成 Dto （ JavaBeans ）の生成 SQL ファイルの検証バインド変数条件式

Doma における apt の利用 – デモ設定バリデーションコードジェネレーション

Doma の戦略依存ライブラリ Dao SQL ファイルキャッシュプラガブルな構成 JavaBeans （ DTO ）への自動変換

依存ライブラリ依存ライブラリはなし Seasar2 にも依存していない DI も必須でない new すればいいだけ Doma の jar （ doma-x.x.x.jar ）が 1 つがあればいい他のフレームワークと特定のライブラリが競合するといった問題が発生しない

Dao 構成のわかりやすさメソッド呼び出しと SQL の発行が 1 対 1 で対応しているのがわかりやすい。メンテナンスのしやすさ CRUD がどこで行われているのか、すぐに調べられるのが重要。テストのしやすさ Mock が作りやすい。 Mock ライブラリとの相性。

SQL ファイル検索系 SQL 意図的に自動生成機能はなし。すべて SQL ファイルを利用。動的な SQL は、 SQL コメントによる条件式で生成。 Java コードに埋め込むのはメンテナンスを難しくするので認めない。更新系 SQL 基本自動生成。 SQL ファイルの利用も可。 select * from employee where /* %if id != null*/ id = /*id*/ 99 /* %end */ select * from employee select * from employee where id = ? SQL ファイル実行される SQL 　 id != null 　が成立する場合実行される SQL 　 id != null 　が成立しない場合

キャッシュメモリを圧迫する可能性ありキャッシュはできるだけ避けるべき Doma では apt でコンパイル時にメタ情報のクラスを生成するため、キャッシュの必要性がないデフォルトでキャッシュするのは SQL の解析結果のみ（キャッシュの実装は差し替え可能）

プラガブルな構成差し替えられるところを明確化しているネーミング規約データベースの方言 SQL ファイルのキャッシュ戦略 JavaBeans へのアクセス方法ドメインとデータベースの型のマッピング SQL のログ出力とフォーマット方法

JavaBeans （ DTO ）への変換 public class EmployeeDto 　　　　　　　 implements java.io.Serializable { private static final long 　　　　　　　　 serialVersionUID = 1L; private java.lang.Integer id ; private java.lang.String name ; private java.lang.Long salary ; private java.lang.Integer versionNo ; // getter/setter @Entity public interface Employee { @Id Identity id(); Name name(); Salary salary(); @Version VersionNo versionNo(); } 自動生成 Employee employee = dao.selectById(new Identity(1)); EmployeeDto dto = new EmployeeDto(); CopyUtil. copy (employee, dto); 相互変換 JavaBeans への変換は容易（他のフレームワークとの連携も OK ）

ロードマップ Eclipse のプラグインの作成 Dao と SQL ファイルの相互遷移 SQL の保存と同時に Dao を再ビルド apt をキック「 Create Domain Class 」ダイアログデータベースからエンティティと Dao の自動生成テストのサポート S2Unit を進化させたもの？ apt を使った SQL ファイルの検証をさらに賢く型チェック異なる型同士の比較をエラーとする。 /*%if name == 1*/ 　という式で name が StringDomain の場合

まとめ値型よりもリッチなクラスにメリットがある apt を使って脱黒魔術コードジェネレーションやバリデーションがコンパイル時に実行できる Doma は、 apt を活用した Dao フレームワークドメインというリッチなクラスとデータベースの型をマッピングプラガブルな構成なため、カスタマイズが容易必要なところでは JavaBeans に変換し、他のフレームワークとの互換性も確保

サイト http://doma.sandbox.seasar.org/ よくある質問 http://doma.sandbox.seasar.org/faq.html ソースリポジトリ http://doma.sandbox.seasar.org/source-repository.html

ご清聴ありがとうございました。

Sc2009autumn 次世代Daoフレームワーク Doma

More Related Content

What's hot (15)

Similar to Sc2009autumn 次世代Daoフレームワーク Doma (15)

Recently uploaded (20)

Sc2009autumn 次世代Daoフレームワーク Doma