JavaのORM、Domaの話 +α¶

JavaのORM、Domaの話 +α

@backpaper0

@backpaper0とは

• うらがみです。
• ｴｽｱｲﾔｰでｼﾞｬﾊﾞ使ってｳｪｯﾌﾞやってます。
• ｱﾝﾖﾖｲﾖも少しやってます。仕事で。
• Doma歴4年ぐらい。

+αの話から

みなさんORM使っていますか？

backpaper0が知ってるORM

• JPA (EclipseLink, Hibernate)
• S2JDBC
• S2Dao
• ActiveObjects
• Iciql (JaQu)
• MyBatis (旧iBatis)
• Mirage
• Doma

Doma

Domaとは

• JavaのORM。
• Object ResultSet Mapper (※個人の感想です)。
• Pluggable Annotation Processing API を使用している。
• その仕組み上、Scalaなど他の言語で書くことはできない。
• 特定のアノテーションを付けたクラスやインターフェースをもとに補助クラスや実装クラスをコンパイル時にモリモリ生成

エンティティ

@Entity
public class Book {

    @Id
    public String isbn;

    public String title;

    public String author;

    ...

Daoインターフェース

@Dao(config = MyConfig.class)
public interface BookDao {

    @Select
    List< Book> select(String title, String author);

SQLファイル

META-INF/app/dao/BookDao/select.sql

SELECT /*%expand*/*
  FROM book
 WHERE title = /* title */'x'
   /*%if author != null */
   AND author = /* author */'y'
   /*%end*/

コンパイル時に色々検出

• @Selectを付けたメソッドに対応するSQLファイルがないと コンパイルエラー
• Daoクラスのメソッドに@Selectや@Insertなどのアノテーションが付いていないと コンパイルエラー
• SQLファイルの中身が空っぽだと コンパイルエラー
• メソッドの引数がSQLファイル内で使用されていないと コンパイルエラー
• SQLファイル内の /*%if ...*/ や /*%end*/ が変な位置にあると コンパイルエラー

ドメインクラス

エンティティのフィールドやDaoのメソッドの引数、戻り値にStringなどの基本型ではなくてユーザー定義のクラスを利用できる仕組み。

@Domain(valueType = String.class, factoryMethod = "of")
public class Isbn {

    private final String value;

    private Isbn(String value) {
        this.value = value;
    }

    public String getValue() {
        return value;
    }

    public static Isbn of(String value) {
        return Optional.ofNullable(value).map(Isbn::new).orElse(null);
    }
}

エンティティ + ドメインクラス

@Entity
public class Book {

    @Id
    public Isbn isbn;

    public Title title;

    public Author author;

    ...

Dao + ドメインクラス

@Dao(config = MyConfig.class)
public interface BookDao {

    @Select
    List< Book> select(Title title, Author author);

    @Select
    Title selectTitle(Isbn isbn);

SQLファイル + ドメインクラス

SQLファイルはドメインクラスを使用しない場合と何も変わらない。

SELECT /*%expand*/*
  FROM book
 WHERE title = /* title */'x'
   /*%if author != null */
   AND author = /* author */'y'
   /*%end*/

ドメインクラスの有無を比較

@Select
List< Book> select(Title title, Author author);

@Select
List< Book> select(String title, String author);

ドメインクラスを使用していると dao.select(author, title) はコンパイルエラーになる。

ジェネリックなドメインクラス

例えばサロゲートキーを表すドメインクラスがあったとする。

@Domain(valueType = Long.class)
public class SurrogateKey< T> {

    private final Long value;

    public SurrogateKey(Long value) {
        this.value = value;
    }

    public Long getValue() {
        return value;
    }
}

ジェネリックなドメインクラス

型変数にはエンティティをバインドする。

@Entity
public class Book {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    public SurrogateKey< Book> id;

@Entity
public class Author {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    public SurrogateKey< Author> id;

author.id = book.id; //コンパイルエラー

StreamやCollectorへの対応

@Select
List< Book> select();

@Select(strategy = SelectType.STREAM)
< R> R select(Function< Stream< Book>, R> fn);

@Select(strategy = SelectType.COLLECT)
< R> R select(Collector< Book, ?, R> collector);

//タイトルをカンマ区切りで並べる
String titleList = select(s -> s.map(book -> book.title).collect(Collectors.joining(", ")));

Optionalへの対応

@Select
Optional< String> selectTitle(Isbn isbn);

@Select
String selectTitle(Optional< Isbn> isbn);

エンティティのフィールドにもOptionalは使える。

その他の機能

• イミュータブルなエンティティ。
• エンティティ作成の支援ツールdoma-gen。 テーブル定義からエンティティを生成する。
  • SQLファイルの実行結果からも生成できる？ 試してない。
• ローカルトランザクション。
• 外部ドメイン。 既に存在しており変更できないクラスをドメインとして扱う。
• クエリビルダ。 やむを得ず動的にSQLを組み立てるための補助的なクラス。
• Date and Time API への対応。

公式ドキュメントなど

Doma http://doma.readthedocs.org/

( Doma 1.x http://doma.seasar.org/ )

作者: @nakamura_to さん

☃