Mapper XML ファイル

Mapped Statement こそ MyBatis のパワーの源です。 ここで魔法がかけられているのです。 Mapper XML ファイルは、そのパワーの割に比較的シンプルです。 JDBC で同じ処理を書くのと比べると、9割以上のコードが省略できると思います。 MyBatis は SQL にフォーカスし、可能な限りあなたの邪魔をしないように設計されています。

Mapper XML ファイルの第一階層の要素は下記のとおりです(この順番で定義する必要があります)。

  • cache – 指定されたネームスペースに対するキャッシュの設定です。
  • cache-ref – 別のネームスペースで定義されているキャッシュ設定を参照します。
  • resultMap – データベースから取得した結果セットを Java オブジェクトにマッピングするための情報を記述する、最も複雑で強力な要素です。
  • parameterMap – 非推奨! パラメーターをマップする古い方法です。インラインパラメーターの使用が推奨されており、この要素は将来削除される予定です。ここでは解説しません。
  • sql – 他のステートメントから参照することができる、再利用可能な SQL 文字列です。
  • insert – マップされた INSERT ステートメントです。
  • update – マップされた UPDATE ステートメントです。
  • delete – マップされた DELETE ステートメントです。
  • select – マップされた SELECT ステートメントです。

次の章では、それぞれの要素について詳しく説明していきます。 まずはステートメントからです。

select

select ステートメントは、MyBatis で最も頻繁に使われる要素のひとつです。 データを取り出すことができてはじめてデータベースにデータを追加する意味があるので、ほとんどのアプリケーションではデータを変更するよりも検索する回数の方が多くなります。 insert, update, delete のそれぞれに対して、多くの select があるはずです。 これは MyBatis の大原則の一つであり、クエリ発行と結果のマッピングに注力している理由でもあります。 シンプルなケースでは、select 要素は非常に簡単です。1つ例を挙げましょう。

<select id="selectPerson" parameterType="int" resultType="hashmap">
  SELECT * FROM PERSON WHERE ID = #{id}
</select>

これは selectPerson というステートメントで、int (または Integer)型の引数を取り、列名を key、値を value として保持する HashMap を返します。

パラメーターは次のように記述されています。

#{id}

このように記述すると、MyBatis は PreparedStatement のパラメーターを作成します。 JDBC では PreparedStatement を作成する場合の '?' に相当します。

// Similar JDBC code, NOT MyBatis…
String selectPerson = "SELECT * FROM PERSON WHERE ID=?";
PreparedStatement ps = conn.prepareStatement(selectPerson);
ps.setInt(1,id);

JDBC 単体で select 結果を展開してオブジェクトのインスタンスにマップするためにはもっと多くのコードが必要ですが、MyBatis を使えばそうしたコードは書かずに済みます。 パラメーターと結果のマッピングについては他にも知っておくべきことが数多くあります。 これらについては、後ほどそれぞれに独立した章を用意して説明します。

ステートメントに関して細かい設定ができるように、select 要素には多くの属性があります。

<select
  id="selectPerson"
  parameterType="int"
  parameterMap="deprecated"
  resultType="hashmap"
  resultMap="personResultMap"
  flushCache="false"
  useCache="true"
  timeout="10000"
  fetchSize="256"
  statementType="PREPARED"
  resultSetType="FORWARD_ONLY">
Select Attributes
属性 説明
id このネームスペース内で固有な識別子。ステートメントを参照する際に使用します。
parameterType このステートメントに渡される引数の型。完全修飾クラス名またはエイリアス。TypeHandler は実際の引数に応じて自動的に導出されるため、この属性は省略可能です。デフォルト値:未設定
parameterMap 別の場所で定義されている parameterMap を参照する非推奨の方法。インラインパラメーターマッピングと parameterType 属性を使用してください。
resultType このステートメントから返されるオブジェクトの型。完全修飾クラス名またはエイリアス。ステートメントがコレクションを返す場合は、コレクションの型ではなくコレクションに含まれるオブジェクトの型を指定する必要があります。
resultTyperesultMap は、どちらか一方のみ指定可能です。
resultMap 別の場所で定義されている resultMap を参照します。 Result Map は MyBatis の中でも最も強力な機能で、深く理解すれば複雑なマッピングが必要となる様々なケースに対応することができます。
resultTyperesultMap は、どちらか一方のみ指定可能です。
flushCache true を指定した場合、ステートメント実行時にローカルキャッシュおよび2次キャッシュがフラッシュ(=クリア)されます。select ステートメントの場合、デフォルト値は false です。
useCache true を指定した場合、ステートメントの結果が2次キャッシュに保存されます。select ステートメントの場合、デフォルト値は true です。
timeout ドライバーがデータベースからの応答が戻らない場合に、ドライバーが例外を投げるまでの最大待機時間(単位:秒)を設定します。デフォルトは未設定(ドライバー依存)です。
fetchSize ドライバーが結果を返す際に内部的に使用するキャッシュのサイズを指定します(ドライバーに対するヒントです)。デフォルトは未指定(ドライバー依存)です。
statementType MyBatis がクエリを実行する際に使用する Statement の種類を指定します。設定可能な値は STATEMENT, PREPARED, CALLABLE で、それぞれ Statement, PreparedStatement, CallableStatement が使用されます。デフォルトは PREPARED です。
resultSetType FORWARD_ONLY, SCROLL_SENSITIVE, SCROLL_INSENSITIVE のいずれかを指定します。デフォルトは未指定(ドライバー依存)です。
databaseId databaseIdProvider が設定されている場合、MyBatis は定義されているステートメントの中で databaseId 属性が指定されていないステートメントおよび現在の設定と一致する databaseId 属性を持ったステートメントをロードします。 同じステートメントで、databaseId 属性が指定されているものと指定されていないものが両方定義されていた場合、指定がないステートメントは無視されます。
resultOrdered この属性は結果がネストされた select ステートメントでのみ有効です。true が設定された場合、MyBatis はクエリの結果が正しい順番にソートされているという前提でマッピングを実行します。これによりメモリ消費を抑えることができます。 デフォルトは false です。
resultSets 複数の ResultSet を利用する場合にのみ有効です。ステートメントが返す ResultSet にそれぞれ任意の名前を付けてリストアップします。名前はカンマで区切ります。

insert, update and delete

データを変更するステートメントである insert, update, delete は、非常によく似た実装となっています。

<insert
  id="insertAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  keyProperty=""
  keyColumn=""
  useGeneratedKeys=""
  timeout="20">

<update
  id="updateAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">

<delete
  id="deleteAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">
Insert, Update and Delete Attributes
属性 説明
id このネームスペース内で固有な識別子。ステートメントを参照する際に使用します。
parameterType このステートメントに渡される引数の型。完全修飾クラス名またはエイリアス。TypeHandler は実際の引数に応じて自動的に導出されるため、この属性は省略可能です。デフォルト値:未設定
parameterMap 別の場所で定義されている parameterMap を参照する非推奨の方法。インラインパラメーターマッピングと parameterType 属性を使用してください。
flushCache true を指定した場合、ステートメント実行時にローカルキャッシュおよび2次キャッシュがフラッシュ(=クリア)されます。insert, update, delete ステートメントの場合、デフォルト値は true です。
timeout ドライバーがデータベースからの応答が戻らない場合に、ドライバーが例外を投げるまでの最大待機時間を設定します。デフォルトは未設定(ドライバー依存)です。
statementType MyBatis がクエリを実行する際に使用する Statement の種類を指定します。設定可能な値は STATEMENT, PREPARED, CALLABLE で、それぞれ Statement, PreparedStatement, CallableStatement が使用されます。デフォルトは PREPARED です。
useGeneratedKeys (insert, update のみ)MyBatis に対して、JDBC の getGeneratedKeys メソッドを使ってデータベース側で自動生成されたキーを取得するよう指示します(例えば MySQL や SQL Server のような RDBMS における auto increment が設定された列の値が取得できます)。デフォルト値は false です。
keyProperty (insert, update のみ)getGeneratedKeys メソッドまたは selectKey 要素で指定されたクエリによって取得したキーの値は、ここで指定したプロパティにセットされます。カンマ区切りでの複数指定にも対応しています。
keyColumn (insert, update のみ)テーブル内で自動生成が設定されている列の名前を指定します。この設定は、特定のデータベース(例えば PostgreSQL)で、テーブルの先頭以外の列にキーの自動生成が設定されている場合にのみ必要となります。カンマ区切りでの複数指定にも対応しています。
databaseId databaseIdProvider が設定されている場合、MyBatis は定義されているステートメントの中で databaseId 属性が指定されていないステートメントおよび現在の設定と一致する databaseId 属性を持ったステートメントをロードします。 同じステートメントで、databaseId 属性が指定されているものと指定されていないものが両方定義されていた場合、指定がないステートメントは無視されます。

以下、insert, update, delete ステートメントの例をいくつか挙げておきます。

<insert id="insertAuthor">
  insert into Author (id,username,password,email,bio)
  values (#{id},#{username},#{password},#{email},#{bio})
</insert>

<update id="updateAuthor">
  update Author set
    username = #{username},
    password = #{password},
    email = #{email},
    bio = #{bio}
  where id = #{id}
</update>

<delete id="deleteAuthor">
  delete from Author where id = #{id}
</delete>

前述のように、insert は自動生成されたキーを扱うため、追加の属性や子要素を持つことができるようになっています。

お使いのデータベースがキーの自動生成に対応しているなら(MySQL や SQL Server は対応しています)、単純に useGeneratedKeys に true を設定し、keyPropoerty でキーが格納されるプロパティを指定するだけです。 例えば上記の Author テーブルで id 列に自動生成が設定されていた場合、ステートメントは次のように書くことができます。

<insert id="insertAuthor" useGeneratedKeys="true"
    keyProperty="id">
  insert into Author (username,password,email,bio)
  values (#{username},#{password},#{email},#{bio})
</insert>

複数行の一括挿入に対応したデータベースなら、 Author のリストまたは配列を引数として渡して自動生成された id の値を一括取得することも可能です。

<insert id="insertAuthor" useGeneratedKeys="true"
    keyProperty="id">
  insert into Author (username, password, email, bio) values
  <foreach item="item" collection="list" separator=",">
    (#{item.username}, #{item.password}, #{item.email}, #{item.bio})
  </foreach>
</insert>

主にキーの自動生成に対応していないデータベースやドライバーのため、MyBatis はもうひとつ別の方法を提供しています。

全く実用的ではありませんが、MyBatis の柔軟さを示す意味も込めて、ID をランダムに生成する例を挙げておきます。

<insert id="insertAuthor">
  <selectKey keyProperty="id" resultType="int" order="BEFORE">
    select CAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1
  </selectKey>
  insert into Author
    (id, username, password, email,bio, favourite_section)
  values
    (#{id}, #{username}, #{password}, #{email}, #{bio}, #{favouriteSection,jdbcType=VARCHAR})
</insert>

上記の例では、最初に selectKey ステートメントが実行され、Author オブジェクトの id プロパティに生成された乱数がセットされます。 次に、insert ステートメントが実行されます。 こうすることで、Java 側でややこしいコードを書かなくても自動生成と同様の結果を得ることができるようになっています。

selectKey 要素は次の属性を持っています。

<selectKey
  keyProperty="id"
  resultType="int"
  order="BEFORE"
  statementType="PREPARED">
selectKey Attributes
属性 説明
keyProperty selectKey ステートメントの結果がセットされるプロパティを指定します。カンマ区切りでの複数指定にも対応しています。
keyColumn プロパティに対応する結果セット中の列名を指定します。カンマ区切りでの複数指定にも対応しています。
resultType 結果の型を指定します。ほとんどの場合、MyBatis は自動的に型を推測することができますが、念のため設定しておいても害はありません。文字列も含めて、任意の単純型を指定することができます。複数の列が自動生成対象となっている場合、対応するプロパティを持つクラスあるいは Map を指定することができます。
order BEFORE または AFTER が指定可能です。BEFORE を指定した場合、最初に selectKey を実行して keyProperty に取得したキーを設定し、その後で insert を実行します。 AFTER を指定した場合、先に insert を実行してから selectKey ステートメントを実行します。 後者は、Oracle のように insert ステートメントの中に sequence の呼び出しを含むようなケースで良く使われます。
statementType select などと同じく Statement の種類を指定することができます。設定可能な値は STATEMENT, PREPARED, CALLABLE で、それぞれ Statement, PreparedStatement, CallableStatement が使用されます。

sql

この要素を使うと、再利用可能な SQL コードのスニペットを定義しておいて、他のステートメントにインクルードすることができます。このときパラメータを指定することもできますが、インクルードの解決はロード時に行われるので、静的な文字列のみ指定可能です。
例:

<sql id="userColumns"> ${alias}.id,${alias}.username,${alias}.password </sql>

上記の SQL スニペットを他のステートメントにインクルードするには、次のように記述します。

<select id="selectUsers" resultType="map">
  select
    <include refid="userColumns"><property name="alias" value="t1"/></include>,
    <include refid="userColumns"><property name="alias" value="t2"/></include>
  from some_table t1
    cross join some_table t2
</select>

呼び出し側の property 要素で指定された値を、sql 要素に内包された include 要素の refid 属性や property 要素の value 属性として指定することも可能です。
例:

<sql id="sometable">
  ${prefix}Table
</sql>

<sql id="someinclude">
  from
    <include refid="${include_target}"/>
</sql>

<select id="select" resultType="map">
  select
    field1, field2, field3
  <include refid="someinclude">
    <property name="prefix" value="Some"/>
    <property name="include_target" value="sometable"/>
  </include>
</select>

Parameters

これまでのステートメントの例では、すべて単純なパラメーターを利用していました。パラメーターは非常に強力な要素です。単純な用途(たぶん全用途の9割くらい)については、特筆すべきことはありません。
例:

<select id="selectUsers" resultType="User">
  select id, username, password
  from users
  where id = #{id}
</select>

上記は、名前を指定してパラメーターを参照するごく簡単な例です。parameterType が int と指定されていますので、好きな名前を使って参照することができます。プリミティブ型や Integer, String などの単純型はプロパティを持たないので、引数の参照はパラメーターの値そのものに置き換えられます。
パラメーターとして複合型を渡した場合はもう少し複雑です。次の例を見てください。

<insert id="insertUser" parameterType="User">
  insert into users (id, username, password)
  values (#{id}, #{username}, #{password})
</insert>

User 型のオブジェクトがパラメーターとしてステートメントに渡されると、id, username, password の各プロパティが参照され、その値が PreparedStatement の引数として渡されます。

このように、ステートメントにパラメーターを渡すだけならとても簡単です。しかし、パラメーターマップには更にいろいろな機能があります。

まず、他と同じ様に、より具体的に型を指定することができます。

#{property,javaType=int,jdbcType=NUMERIC}

他と同様、ほとんどの場合 javaType は自動的に検出されますが、例外は HashMap です。パラメーターとして HashMap を使う場合は、正しい TypeHandler が使用されるよう javaType を指定してください。

重要 JDBC の仕様上、値として null を設定する場合は JDBC タイプが必須となります。 詳しくは PreparedStatement.setNull() メソッドの javadoc を参照してください。

タイプハンドラーの完全修飾クラス名またはエイリアスを指定して、特定のタイプハンドラーを割り当てることもできます。

#{age,javaType=int,jdbcType=NUMERIC,typeHandler=MyTypeHandler}

だんだんゴチャゴチャしてきましたが、実際のところ、これらの属性を指定することは滅多にないと思います。

数値型に関しては、有効桁数を指定するための numericScale という属性もあります。

#{height,javaType=double,jdbcType=NUMERIC,numericScale=2}

最後になりますが、mode 属性で IN, OUT, INOUT パラメーターを指定することができます。 OUT または INOUT の場合は、パラメーターオブジェクトのプロパティの値が変更されます。 mode が OUT または INOUT で jdbcType が CURSOR(Oracle の REFCURSOR)の場合は、ResultSet とパラメーターの型をマッピングする resultMap を指定する必要があります。ただし jdbcType として CURSOR を指定した場合 javaType には自動的に ResultSet が設定されますので、javaType の指定は省略可能です。

#{department, mode=OUT, jdbcType=CURSOR, javaType=ResultSet, resultMap=departmentResultMap}

MyBatis ではより高度な struct のようなデータ型もサポートされていますが、OUT パラメーターを登録するときに型名を指定する必要があります。

#{middleInitial, mode=OUT, jdbcType=STRUCT, jdbcTypeName=MY_TYPE, resultMap=departmentResultMap}

このように多くの強力なオプションがあるわけですが、ほとんどの場合、単純にプロパティ名を指定すれば、後は MyBatis がよきに計らってくれるはずです。 あとは、null が設定可能な列に対して jdbcType を指定するくらいでしょう。

#{firstName}
#{middleInitial,jdbcType=VARCHAR}
#{lastName}

文字列代入

デフォルトでは、#{} という表記を使うと PreparedStatement のプロパティが生成され、PreparedStatement の引数(? の部分)に対して安全な値が設定されるようになっています。 これは安全かつ高速なので、ほとんどすべてのケースで推奨される方法ですが、時には文字列をそのまま SQL 文に挿入した方が都合が良い場合があります。例えば ORDER BY 句は以下のように記述できます。

ORDER BY ${columnName}

この場合、MyBatis は引数として渡された文字列を変更したりエスケープしたりしません。

重要 この方法を使って、ユーザーが入力した文字列を直接 SQL 文に代入するのは危険です。SQL インジェクションの原因となる可能性がありますので、ユーザーによる入力を受け付けないようにしておくか、常にプログラム側で独自にエスケープやチェックの処理を行うようにしてください。

Result Maps

MyBatis の中で最も重要かつ強力なのが resultMap 要素です。resultMap のおかげで、JDBC を使って ResultSet からデータを取得する場合に書かなくてはならないコードの9割を省くことができ、またときには JDBC がサポートすらしていないことも可能となるのです。 実際、複雑なクエリの結果を結合してマッピングするコードを書く場合、数千行ものコードになってしまう場合もあります。 ResultMap は、簡単なステートメントなら明示的にマッピングな記述を省略でき、複雑なステートメントの場合でもオブジェクト同士の関連付けを行うための必要最小限のコードのみを記述すれば良いように設計されています。

明示的な resultMap を必要としない、簡単な Mapped Statement については既に例として出てきました。
例:

<select id="selectUsers" resultType="map">
  select id, username, hashedPassword
  from some_table
  where id = #{id}
</select>

この例の場合、resultType で指定された通り、すべての列が自動的に HashMap のキーとしてマップされます。 便利な時もありますが、HashMap は良いドメインモデルとは言えません。 ほとんどのアプリケーションではドメインモデルとして JavaBeans や POJO (Plain Old Java Objects) を使っていると思います。MyBatis はどちらもサポートしています。
次のような JavaBean があったとします。

package com.someapp.model;
public class User {
  private int id;
  private String username;
  private String hashedPassword;
  
  public int getId() {
    return id;
  }
  public void setId(int id) {
    this.id = id;
  }
  public String getUsername() {
    return username;
  }
  public void setUsername(String username) {
    this.username = username;
  }
  public String getHashedPassword() {
    return hashedPassword;
  }
  public void setHashedPassword(String hashedPassword) {
    this.hashedPassword = hashedPassword;
  }
}

JavaBeans の仕様によれば、上記のクラスは3つのプロパティ id, username, hashedPassword を持っているということになります。 これらのプロパティは、先に挙げた select ステートメントの中で指定されている列名と一致しています。

このような条件を満たす JavaBean であれば、HashMap のときと同じように ResultSet にマップすることができます。

<select id="selectUsers" resultType="com.someapp.model.User">
  select id, username, hashedPassword
  from some_table
  where id = #{id}
</select>

タイプエイリアスを使えば何度も完全修飾クラス名を入力しなくて済む、ということも思い出してください。

<!-- In Config XML file -->
<typeAlias type="com.someapp.model.User" alias="User"/>

<!-- In SQL Mapping XML file -->
<select id="selectUsers" resultType="User">
  select id, username, hashedPassword
  from some_table
  where id = #{id}
</select>

こうしたケースでは、名前に基づいて列を JavaBean にマップするための ResultMap が MyBatis によって自動的に作成されます。 もし列名が一致しない場合、select 文で列に別名をつけることで対応可能です(列の別名は標準 SQL の機能です)。

<select id="selectUsers" resultType="User">
  select
    user_id     as "id",
    user_name     as "userName",
    hashed_password   as "hashedPassword"
  from some_table
  where id = #{id}
</select>

ResultMap の素晴らしいところは、まだ一つの例も挙げていないにも関わらず、あなたは既にその多くを学んでいるということです。 これらのシンプルなケースでは既に見てきた以上のことは何も必要ありません。 列名の不一致を解消するもう一つの方法でもありますが、この最後のサンプルで resultMap を明示的に定義したらどうなるか見てみましょう。

<resultMap id="userResultMap" type="User">
  <id property="id" column="user_id" />
  <result property="username" column="username"/>
  <result property="password" column="password"/>
</resultMap>

そして、resultMap 属性を使って定義した ResultMap を参照するステートメントは以下のようになります(resultType 属性は削除しています)。

<select id="selectUsers" resultMap="userResultMap">
  select user_id, user_name, hashed_password
  from some_table
  where id = #{id}
</select>

全てがこんなに簡単なら良いのでしょうが、そう甘くはありません。

高度な結果マッピング

MyBatis は「データベースは必ずしも希望通りに定義されている訳ではない」という思想に基づいて設計されています。 すべてのデータベースが完全な第三正規形あるいは BCNF なら最高ですが、実際はそうではありません。 また、たったひとつで全てのアプリケーションに適合できるようなデータベースを作ることができたら素晴らしいですが、これも現実とは異なります。 こうした問題に対する MyBatis の答えが Result Map です。

例えば、こんなステートメントをどうやってマップすれば良いのでしょう?

<!-- Very Complex Statement -->
<select id="selectBlogDetails" resultMap="detailedBlogResultMap">
  select
    B.id as blog_id,
    B.title as blog_title,
    B.author_id as blog_author_id,
    A.id as author_id,
    A.username as author_username,
    A.password as author_password,
    A.email as author_email,
    A.bio as author_bio,
    A.favourite_section as author_favourite_section,
    P.id as post_id,
    P.blog_id as post_blog_id,
    P.author_id as post_author_id,
    P.created_on as post_created_on,
    P.section as post_section,
    P.subject as post_subject,
    P.draft as draft,
    P.body as post_body,
    C.id as comment_id,
    C.post_id as comment_post_id,
    C.name as comment_name,
    C.comment as comment_text,
    T.id as tag_id,
    T.name as tag_name
  from Blog B
    left outer join Author A on B.author_id = A.id
    left outer join Post P on B.id = P.blog_id
    left outer join Comment C on P.id = C.post_id
    left outer join Post_Tag PT on PT.post_id = P.id
    left outer join Tag T on PT.tag_id = T.id
  where B.id = #{id}
</select>

あなたはおそらく、Author によって書かれた、たくさんの Post を持つ Blog といったようなオブジェクトモデルにマップしたいと考えるでしょう。 次に上げるのは、複雑な ResultMap の完全な例です(Author, Blog, Post, Comments, Tags はすべてタイプエイリアスとします)。 後ほどひとつずつ説明しますが、とりあえず目を通してみてください。 最初は難解に思えるかも知れませんが、実際は非常にシンプルです。

<!-- Very Complex Result Map -->
<resultMap id="detailedBlogResultMap" type="Blog">
  <constructor>
    <idArg column="blog_id" javaType="int"/>
  </constructor>
  <result property="title" column="blog_title"/>
  <association property="author" javaType="Author">
    <id property="id" column="author_id"/>
    <result property="username" column="author_username"/>
    <result property="password" column="author_password"/>
    <result property="email" column="author_email"/>
    <result property="bio" column="author_bio"/>
    <result property="favouriteSection" column="author_favourite_section"/>
  </association>
  <collection property="posts" ofType="Post">
    <id property="id" column="post_id"/>
    <result property="subject" column="post_subject"/>
    <association property="author" javaType="Author"/>
    <collection property="comments" ofType="Comment">
      <id property="id" column="comment_id"/>
    </collection>
    <collection property="tags" ofType="Tag" >
      <id property="id" column="tag_id"/>
    </collection>
    <discriminator javaType="int" column="draft">
      <case value="1" resultType="DraftPost"/>
    </discriminator>
  </collection>
</resultMap>

resultMap 要素には多くの子要素や階層構造があり、それぞれについて多少説明が必要です。 以下は resultMap 要素の構成要素です。

resultMap

  • constructor - クエリ結果をコンストラクタに渡してクラスのインスタンスを作成する場合に使用します。
    • idArg - このコンストラクタ引数が ID であることを明示します。ID 列を明示することによって全体のパフォーマンスが向上します。
    • arg - 通常のコンストラクタ引数です。
  • id – このフィールドまたはプロパティが ID であることを明示します。ID を明示することによって全体のパフォーマンスが向上します。
  • result – フィールドまたは JavaBean のプロパティにセットされる通常のデータです。
  • association – 複雑型のアソシエーションを定義します。多くのマッピングはこのタイプに当てはまります。
    • ネストされた Result Map – アソシエーション自身も resultMap として記述します。他で定義されている resultMap を参照することもできます。
  • collection – 複雑型のコレクションを定義します。
    • ネストされた Result Map – コレクション自身も resultMap として記述します。他で定義されている resultMap を参照することもできます。
  • discriminator – 結果の値を使ってどの resultMap を使用するか決定します。
    • case – case は Result Map の一種で、値が一致した場合に使用されます。
      • ネストされた Result Map – case も Result Map なので、resultMap とほぼ同じ要素を持つことができます。また、別の場所で定義された resultMap を参照することもできます。
ResultMap Attributes
属性 説明
id このネームスペース内で固有の識別子。resultMap を参照する際に使用します。
type Java クラスの完全修飾クラス名またはタイプエイリアスを指定します(前に出てきた標準のタイプエイリアスのリストを参照してください)。
autoMapping この resulMap に結果をマッピングする際、自動マッピングを使用するかどうかを true / false で指定します。ここでの指定はグローバルな設定(autoMappingBehavior)より優先されます。デフォルト:未指定

ベストプラクティス ResultMap は段階的に実装するようにしましょう。ユニットテストも効果的です。 上で見たような巨大な resultMap を一度に実装しようとするとミスが発生しやすく、作業も困難です。 シンプルなところからスタートして、ユニットテストを書きながら徐々に拡張しましょう。 フレームワークの欠点でもありますが、ソースが公開されているかどうかに関わらず、フレームワークはある種のブラックボックスとなり得ます。期待通りに動作していることを確かめるにはユニットテストが一番です。 ユニットテストはバグを報告する場合も役に立ちます。

次の章ではそれぞれの要素について詳しく見ていきます。

id と result

<id property="id" column="post_id"/>
<result property="subject" column="post_subject"/>

idresult は結果マッピングの基本となる要素です。 どちらも、ある列の値を単純型(String, int, double, Date など)のプロパティまたはフィールドにマップするときに使用します。

両者の違いは、id は、その結果が識別子プロパティ(オブジェクトのインスタンスを比較する際に使われます)であることを表すという点のみです。 これによって全体的なパフォーマンスが向上しますが、特に恩恵をうけるのはキャッシュとネストされた結果マッピング(=JOIN マッピング)の処理を行うときです。

どちらも多くの属性を持っています。

id and result Attributes
属性 説明
property 結果列の値をマップするフィールドまたはプロパティを指定します。名前が一致する JavaBean プロパティがあれば、そのプロパティが使われます。もしなければ、MyBatis は次に名前が一致するフィールドを探します。 どちらの場合も、ドット表記を使って複雑型のプロパティを指定することができます。 例えば、 "username" のような単純なプロパティを指定することもできますし、 "address.street.number" のように複雑なプロパティを指定することもできます。
column データベースで定義されている列名、あるいは列の別名を指定します。resultSet.getString(columnName) メソッドの引数として渡される文字列と同じと考えてください。
javaType Java クラスの完全修飾クラス名またはタイプエイリアスを指定します(前に出てきた標準のタイプエイリアスのリストを参照してください)。 通常、JavaBean にマッピングする場合の javaType は MyBatis によって正しく判別されます。 ただし、HashMap にマッピングする場合は正しい動作を保証するため適切な javaType を指定するようにしてください。
jdbcType サポートされている JDBC データ型(この後のテーブルにリストがあります)を指定します。 JDBC データ型の指定が必須となるのは、insert, update, delete の各ステートメントで null が許可されている列を指定した場合だけです。 これは JDBC の仕様で MyBatis の仕様ではありません。 ですから、直接 JDBC を使ったコードを書く場合でも null が許可されている列に対しては、やはりデータ型を指定する必要があります。
typeHandler デフォルトのタイプハンドラーについては既に説明しました。 このプロパティを使うと、デフォルトのタイプハンドラーをオーバーライドすることができます。 タイプハンドラーの完全修飾クラス名またはタイプエイリアスを指定します。

サポートされている JDBC データ型

参考として、MyBatis に含まれている JdbcType 列挙型によってサポートされている JDBC データ型を以下に挙げておきます。

BIT FLOAT CHAR TIMESTAMP OTHER UNDEFINED
TINYINT REAL VARCHAR BINARY BLOB NVARCHAR
SMALLINT DOUBLE LONGVARCHAR VARBINARY CLOB NCHAR
INTEGER NUMERIC DATE LONGVARBINARY BOOLEAN NCLOB
BIGINT DECIMAL TIME NULL CURSOR ARRAY

constructor

ほとんどの DTO (Data Transfer Object) やドメインモデルではプロパティを使って値を設定することができますが、時にはイミュータブルなクラスを使いたい場合もあるかも知れません。 通常更新されることのない参照用データを含むテーブルなどはイミュータブルクラスに向いています。 コンストラクタインジェクションを使うとインスタンス化の際に値を設定することができるので、カプセル化の妨げとなる public メソッドの定義が不要となります。 MyBatis は private として定義されているプロパティやフィールドもサポートしていますが、コンストラクタインジェクションを好む人もいると思います。 constructor 要素を使うとコンストラクタインジェクションによって値をマップすることが可能となります。

次のようなコンストラクタを考えてみます。

public class User {
   //...
   public User(Integer id, String username, int age) {
  //...
  }
//...
}

コンストラクタ経由で値をマップするためには、指定された引数にマッチするコンストラクタを特定する必要があります。 下記の例では、MyBatis は3つの引数 java.lang.Integer, java.lang.String, int をこの順番で持つコンストラクタを探します。

<constructor>
   <idArg column="id" javaType="int"/>
   <arg column="username" javaType="String"/>
   <arg column="arg" javaType="_int"/>
</constructor>

上記の指定方法では引数の型を順番通りに並べる必要がありますが、引数の多いコンストラクタを扱うのには向いていません。
3.4.3 以降では、引数名を指定することによって arg 要素を順不同で記述できるようになりました。引数を名前で指定するためには、各引数に @Param アノテーションを追加するか、プロジェクトを '-parameters' オプション付きでコンパイルし、useActualParamName に true (デフォルト値です)を設定します。 下記の指定では2番めと3番目の引数の順番がコンストラクタの宣言と異なりますが、引数名が指定されているので正しく動作します。

<constructor>
   <idArg column="id" javaType="int" name="id" />
   <arg column="age" javaType="_int" name="age" />
   <arg column="username" javaType="String" name="username" />
</constructor>

引数と同じ名前、同じ型を持つプロパティが存在する場合 javaType は省略可能です。

それ以外の属性とルールについては通常の id, result 要素と同じです。

属性 説明
column データベースで定義されている列名、あるいは列の別名を指定します。resultSet.getString(columnName) メソッドの引数として渡される文字列と同じと考えてください。
javaType Java クラスの完全修飾クラス名またはタイプエイリアスを指定します(前に出てきた標準のタイプエイリアスのリストを参照してください)。 通常、JavaBean にマッピングする場合の javaType は MyBatis によって正しく判別されます。 ただし、HashMap にマッピングする場合は正しい動作を保証するため適切な javaType を指定するようにしてください。
jdbcType サポートされている JDBC データ型(この後のテーブルにリストがあります)を指定します。 JDBC データ型の指定が必須となるのは、insert, update, delete の各ステートメントで null が許可されている列を指定した場合だけです。 これは JDBC の仕様で MyBatis の仕様ではありません。 ですから、直接 JDBC を使ったコードを書く場合でも null が許可されている列に対しては、やはりデータ型を指定する必要があります。
typeHandler デフォルトのタイプハンドラーについては既に説明しました。 このプロパティを使うと、デフォルトのタイプハンドラーをオーバーライドすることができます。 タイプハンドラーの完全修飾クラス名またはタイプエイリアスを指定します。
select 別の場所で定義されているステートメントの ID を指定します。 ステートメントの結果として取得したデータがこのプロパティにマップされます。 指定された select ステートメントには column 属性で指定した列の値が引数として渡されます。
詳細は association 要素の説明を参照してください。
resultMap 別の場所で定義されている ResultMap の ID を指定します。ネストされた結果をこのプロパティにマップする際、指定した ResultMap が使われます。 この方法は、別の select 文を実行する方法の代わりに使うことができ、複数のテーブルを結合して取得した ResultSet をマップすることができます。 このような ResultSet には重複や繰り返しが含まれているため、正しく分解してからネストされたオブジェクトグラフにマップしてやる必要がありますが、MyBatis ではこの処理を実現するため Result Map を連結できるようになっています。
詳細は association 要素の説明を参照してください。
name コンストラクタ引数の名前を指定します。引数名を指定することで arg 要素を順不同で記述できるようになります。詳細は上記の説明を参照してください。 導入されたバージョン: 3.4.3

association

<association property="author" column="blog_author_id" javaType="Author">
  <id property="id" column="author_id"/>
  <result property="username" column="author_username"/>
</association>

association 要素は "has-one" タイプのリレーションシップを扱います。 例えば、上で出てきたサンプルの Blog は1つの Author を持っています。 アソシエーションは、他の result とほぼ同じように動作します。 値を設定するプロパティ、値の取得元となる列、プロパティの javaType (ほとんどの場合自動で検出可能)、必要なら jdbcType、またデフォルトのタイプハンドラーをオーバーライドしたい場合は typeHandler を指定します。

association が他と異なるのは、アソシエーションを読み込む方法を MyBatis に伝える必要があるという点です。これには2つの方法があります。

  • select をネストする:別のマップドステートメントを実行してその結果を読み込む方法です。
  • 結果をネストする:ネストした Result Map を使って結合(Join)した結果を読み込む方法です。

まずは要素の属性を調べてみましょう。 select, resultMap 以外の属性は result 要素と同じです。

属性 説明
property 結果列の値をマップするフィールドまたはプロパティを指定します。名前が一致する JavaBean プロパティがあれば、そのプロパティが使われます。もしなければ、MyBatis は次に名前が一致するフィールドを探します。 どちらの場合も、ドット表記を使って複雑型のプロパティを指定することができます。 例えば、 "username" のような単純なプロパティを指定することもできますし、 "address.street.number" のように複雑なプロパティを指定することもできます。
javaType Java クラスの完全修飾クラス名またはタイプエイリアスを指定します(前に出てきた標準のタイプエイリアスのリストを参照してください)。 通常、JavaBean にマッピングする場合の javaType は MyBatis によって正しく判別されます。 ただし、HashMap にマッピングする場合は正しい動作を保証するため適切な javaType を指定するようにしてください。
jdbcType サポートされている JDBC データ型(この後のテーブルにリストがあります)を指定します。 JDBC データ型の指定が必須となるのは、insert, update, delete の各ステートメントで null が許可されている列を指定した場合だけです。 これは JDBC の仕様で MyBatis の仕様ではありません。 ですから、直接 JDBC を使ったコードを書く場合でも null が許可されている列に対しては、やはりデータ型を指定する必要があります。
typeHandler デフォルトのタイプハンドラーについては既に説明しました。 このプロパティを使うと、デフォルトのタイプハンドラーをオーバーライドすることができます。 タイプハンドラーの完全修飾クラス名またはタイプエイリアスを指定します。

ネストされた select を使って association を読み込む

属性 説明
column ネストされた select ステートメントに引数として渡される列名、あるいは列の別名を指定します。resultSet.getString(columnName) メソッドの引数として渡される文字列と同じと考えてください。 Note: 複合キー(composite key)を扱う場合、column="{prop1=col1,prop2=col2} のように記述することで複数の列名を指定することができます。この例ではネストされた select の実行時に prop1 と prop2 が引数として渡されます。
select 別の場所で定義されているステートメントの ID を指定します。 ステートメントの結果として取得したデータがこのプロパティにマップされます。 指定された select ステートメントには column 属性で指定した列の値が引数として渡されます。
この表の後に詳しいサンプルがあります。 Note: 複合キー(composite key)を扱う場合、column="{prop1=col1,prop2=col2} のように記述することで複数の列名を指定することができます。この例ではネストされた select の実行時に prop1 と prop2 が引数として渡されます。
fetchType 任意の属性で、グローバルな lazyLoadingEnabled の設定をオーバーライドする場合に指定します。 指定可能な値は lazy または eager です。

例:

<resultMap id="blogResult" type="Blog">
  <association property="author" column="author_id" javaType="Author" select="selectAuthor"/>
</resultMap>

<select id="selectBlog" resultMap="blogResult">
  SELECT * FROM BLOG WHERE ID = #{id}
</select>

<select id="selectAuthor" resultType="Author">
  SELECT * FROM AUTHOR WHERE ID = #{id}
</select>

これだけです。 select ステートメントが二つありますが、一つは Blog、もう一つは Author を読み込むための selct です。 Blog の resultMap を見ると、author プロパティを読み込むために "selectAuthor" ステートメントを使うように指示されています。

他のプロパティは自動的に読み込まれます(列名とプロパティ名が一致していることが前提となります)。

この方法は簡単ですが、大量のデータやリストを扱うのには向いていません。 この問題は "N+1 セレクト問題" として知られています。 要約すると、"N+1 セレクト問題" が発生する仕組みは下記のようなものです。

  • レコードのリストを取得するために SQL ステートメントを一つ実行します(これが "+1" です)。
  • 結果に含まれる各レコードに対して、その詳細を取得するための select 文が一回ずつ実行されます(これが "N" です)。

場合によっては数百、数千もの SQL ステートメントが実行されることになるので、あまり良い方法とは言えません。

幸い MyBatis ではこのようなクエリに対して遅延読み込み(Lazy load)を設定することができるので、すべてのクエリが同時に実行されるような状況を避けることも可能です。 ただし、リストを読み込んだ直後に各要素を反復処理してネストされたデータにアクセスするような処理を行うと、すべての遅延読み込みが実行されるのでパフォーマンスが極端に悪化します。

では、もう一つの方法について説明しましょう。

ネストされた結果を使って association を読み込む

属性 説明
resultMap 別の場所で定義されている ResultMap の ID を指定します。ネストされた結果をこのプロパティにマップする際、指定した ResultMap が使われます。 この方法は、別の select 文を実行する方法の代わりに使うことができ、複数のテーブルを結合して取得した ResultSet をマップすることができます。 このような ResultSet には重複や繰り返しが含まれているため、正しく分解してからネストされたオブジェクトグラフにマップしてやる必要がありますが、MyBatis ではこの処理を実現するため Result Map を連結できるようになっています。
実際のサンプルを見た方が分かりやすいと思います。この表の後に例を挙げます。
columnPrefix 複数のテーブルを結合して取得した ResultSet では、列名の重複を防ぐため別名を付けなくてはならない場合があります。 columnPrefix を指定すると、別の場所で定義されている resultMap を使って別名の付けられた列をマップすることができます。後で説明するサンプルを参照してください。
notNullColumn ネストされた結果をマッピングする際、デフォルトでは子オブジェクトのプロパティに対応する列のうち一つでも null でない値がセットされているものがあれば子オブジェクトが生成されます。notNullColumn に列名(複数可)を指定しておくと、指定された列に null 以外の値がセットされた場合にのみ子オブジェクトが生成されます。デフォルト:未指定
autoMapping このプロパティに結果をマッピングする際、自動マッピングを使用するかどうかを true / false で指定します。ここでの指定はグローバルな設定(autoMappingBehavior)より優先されます。この設定は別の場所で定義されている ResultMap には適用されませんので、selectresultMap が指定されている場合は無効となります。デフォルト:未指定

ネストされたアソシエーションについては、既にとても複雑な例を見ていただきました。次のサンプルは、それと比べるとずっと理解しやすいと思います。ここでは、独立した select を実行する代わりに Blog と Author のテーブルを結合するクエリを実行します。

<select id="selectBlog" resultMap="blogResult">
  select
    B.id       as blog_id,
    B.title     as blog_title,
    B.author_id   as blog_author_id,
    A.id       as author_id,
    A.username    as author_username,
    A.password     as author_password,
    A.email     as author_email,
    A.bio       as author_bio
  from Blog B left outer join Author A on B.author_id = A.id
  where B.id = #{id}
</select>

テーブルを結合しているだけでなく、全ての列に固有で分かりやすい別名が指定されていることに注意してください。こうしておくとマッピング作業がずっと楽になります。
これで結果をマップする準備が整いました。

<resultMap id="blogResult" type="Blog">
  <id property="id" column="blog_id" />
  <result property="title" column="blog_title"/>
  <association property="author" resultMap="authorResult"/>
</resultMap>

<resultMap id="authorResult" type="Author">
  <id property="id" column="author_id"/>
  <result property="username" column="author_username"/>
  <result property="password" column="author_password"/>
  <result property="email" column="author_email"/>
  <result property="bio" column="author_bio"/>
</resultMap>

この例では、Blog の "author" を読み込むためのアソシエーションで、別の resultMap "authorResult" を指定しています。

超重要 ネストされた Result Map では、id 要素が重要な役割を果たします。常に、結果の固有性を判定できる一つ以上のプロパティを id として指定するようにしてください。指定がなくても動作はしますが、パフォーマンスに著しい悪影響を与えます。また、結果の固有性を判定するために必要な最小限のプロパティを指定するようにしてください。主キー(複合キーでも可)は良い選択肢です。

上の例では、別の場所で定義した resultMap 要素を指定してアソシエーションを読み込んでいますが、こうすると Author の resultMap を再利用することができます。再利用する必要がない場合や、単に一つの resultMap にマッピングの情報をまとめておきたい場合には、アソシエーションの Result Map をネストすることもできます。この方法で書き直したのが次の例です。

<resultMap id="blogResult" type="Blog">
  <id property="id" column="blog_id" />
  <result property="title" column="blog_title"/>
  <association property="author" javaType="Author">
    <id property="id" column="author_id"/>
    <result property="username" column="author_username"/>
    <result property="password" column="author_password"/>
    <result property="email" column="author_email"/>
    <result property="bio" column="author_bio"/>
  </association>
</resultMap>

もしこの Blog に共著者 co-author が設定されていたらどうなるでしょうか。 select ステートメントは下記のようになります。

<select id="selectBlog" resultMap="blogResult">
  select
    B.id            as blog_id,
    B.title         as blog_title,
    A.id            as author_id,
    A.username      as author_username,
    A.password      as author_password,
    A.email         as author_email,
    A.bio           as author_bio,
    CA.id           as co_author_id,
    CA.username     as co_author_username,
    CA.password     as co_author_password,
    CA.email        as co_author_email,
    CA.bio          as co_author_bio
  from Blog B
  left outer join Author A on B.author_id = A.id
  left outer join Author CA on B.co_author_id = CA.id
  where B.id = #{id}
</select>

Author に対する resultMap は下記のように定義されています。

<resultMap id="authorResult" type="Author">
  <id property="id" column="author_id"/>
  <result property="username" column="author_username"/>
  <result property="password" column="author_password"/>
  <result property="email" column="author_email"/>
  <result property="bio" column="author_bio"/>
</resultMap>

結果に含まれる列名が resultMap で指定されている列名と異なるので、この resultMap を再利用するためには columnPrefix を指定する必要があります。

<resultMap id="blogResult" type="Blog">
  <id property="id" column="blog_id" />
  <result property="title" column="blog_title"/>
  <association property="author"
    resultMap="authorResult" />
  <association property="coAuthor"
    resultMap="authorResult"
    columnPrefix="co_" />
</resultMap>

複数の ResultSet を association にマッピングする

属性 説明
column 複数の ResultSet を返すステートメントをマッピングする場合、foreignColumn で指定した外部キーと対になってリレーションシップを構成する親オブジェクト側の列を指定します(カンマ区切りで複数指定可能)。
foreignColumn column 属性で指定した親オブジェクトの列との照合に使用される外部キーを格納する列を指定します。
resultSet 読み込み元の ResultSet の名前を指定します。下記の説明を参照してください。

バージョン 3.2.3 から、N+1 セレクト問題を解決する新しい方法が追加されました。

データベースによってはストアドプロシージャから複数の ResultSet を返すことができます。この機能を利用すると、テーブルの結合(Join)を使わず一度の問い合わせで互いに関連する複数のデータを取得することができます。

以下の例では、ストアドプロシージャが2つの ResultSet を返します。1つめの ResultSet には複数の Blog のデータが含まれており、2つめの ResultSet には複数の Author のデータが含まれています。

SELECT * FROM BLOG WHERE ID = #{id}

SELECT * FROM AUTHOR WHERE ID = #{id}

ストアドプロシージャを実行する select 要素の resultSets 属性で、それぞれの ResultSet に名前を付けておく必要があります(カンマ区切り)。ここでは、それぞれ blogs, authors としています。

<select id="selectBlog" resultSets="blogs,authors" resultMap="blogResult" statementType="CALLABLE">
  {call getBlogsAndAuthors(#{id,jdbcType=INTEGER,mode=IN})}
</select>

下記の resultMap では、authors 内の各 Author が、それぞれ対応する Blog にマッピングされます。

<resultMap id="blogResult" type="Blog">
  <id property="id" column="id" />
  <result property="title" column="title"/>
  <association property="author" javaType="Author" resultSet="authors" column="author_id" foreignColumn="id">
    <id property="id" column="id"/>
    <result property="username" column="username"/>
    <result property="password" column="password"/>
    <result property="email" column="email"/>
    <result property="bio" column="bio"/>
  </association>
</resultMap>

ここまで "has one" タイプのリレーションシップを扱う方法を見て来ましたが、"has many" の場合はどうしたら良いのでしょうか?これは次の章で説明します。

collection

<collection property="posts" ofType="domain.blog.Post">
  <id property="id" column="post_id"/>
  <result property="subject" column="post_subject"/>
  <result property="body" column="post_body"/>
</collection>

collection 要素の働きは association とほとんど同じです。同じ説明の繰り返しを省くため、association との違いにフォーカスして見て行きます。

引き続き上記のサンプルを使います。Blog に対する Author は一人だけですが、Post は複数存在します。この関係を Blog クラスで表現すると、次のようになると思います。

private List<Post> posts;

collection 要素を使ってこのような List 型のプロパティにネストされた結果セットをマップする場合、select をネストする方法と、結果をネストする方法があります。

ネストされた select を使って collection を読み込む

まずは、ネストされた select を使って Blog に関連した Post を読み込む例を見てみましょう。

<resultMap id="blogResult" type="Blog">
  <collection property="posts" javaType="ArrayList" column="id" ofType="Post" select="selectPostsForBlog"/>
</resultMap>

<select id="selectBlog" resultMap="blogResult">
  SELECT * FROM BLOG WHERE ID = #{id}
</select>

<select id="selectPostsForBlog" resultType="Post">
  SELECT * FROM POST WHERE BLOG_ID = #{id}
</select>

いろいろ気づいたことがあると思いますが、上で見た association 要素と似た部分が多いと思います。 まず眼を引くのは collection 要素を使っていることでしょう。次に "ofType" という新しい属性があることに気づくでしょう。 この属性は、JavaBean のプロパティ(またはフィールド)の型と、コレクションに含まれている型を区別するために必要です。 したがって、このマッピングは次のように読むことができます。

<collection property="posts" javaType="ArrayList" column="id" ofType="Post" select="selectPostsForBlog"/>

このように読めます: "投稿のリストは、Post クラスを要素とする ArrayList に格納される。"

ほとんどの場合、javaType 属性はMyBatis によって推測されるため省略可能です。 ということで、大抵は下記のように短く書くことができます。

<collection property="posts" column="id" ofType="Post" select="selectPostsForBlog"/>

ネストされた結果を使って collection を読み込む

ここまで来れば、ネストされた結果を collection に読み込む方法について想像できるのではないでしょうか。 なぜなら、association と全く同じだからです(ただし、ネストされた select と同様、"ofType" 属性の指定が必要です)。

まずは SQL を見てみましょう。

<select id="selectBlog" resultMap="blogResult">
  select
  B.id as blog_id,
  B.title as blog_title,
  B.author_id as blog_author_id,
  P.id as post_id,
  P.subject as post_subject,
  P.body as post_body,
  from Blog B
  left outer join Post P on B.id = P.blog_id
  where B.id = #{id}
</select>

Blog と Post テーブルを結合した上で、マッピングを簡単にするため各列に別名を付けています。 ここまでくれば、次に挙げたシンプルな ResultMap で、Post のリストも含めて Blog のデータを読み込むことができます。

<resultMap id="blogResult" type="Blog">
  <id property="id" column="blog_id" />
  <result property="title" column="blog_title"/>
  <collection property="posts" ofType="Post">
    <id property="id" column="post_id"/>
    <result property="subject" column="post_subject"/>
    <result property="body" column="post_body"/>
  </collection>
</resultMap>

id 要素の重要さはここでも変わりません。まだ読んでいなければ、上の association 要素についての説明を参照してください。

もし、Post のマッピングを再利用したいのであれば、次のように2つの resultMap に分けて書くこともできます。

<resultMap id="blogResult" type="Blog">
  <id property="id" column="blog_id" />
  <result property="title" column="blog_title"/>
  <collection property="posts" ofType="Post" resultMap="blogPostResult" columnPrefix="post_"/>
</resultMap>

<resultMap id="blogPostResult" type="Post">
  <id property="id" column="id"/>
  <result property="subject" column="subject"/>
  <result property="body" column="body"/>
</resultMap>

複数の ResultSets を collection にマッピングする

association で説明したのと同様に、2つの ResultSet を返すストアドプロシージャを呼び出すことができます。1つ目の ResultSet には Blog のリスト、2つ目の ResultSet には Post のリストが含まれているものとします。

SELECT * FROM BLOG WHERE ID = #{id}

SELECT * FROM POST WHERE BLOG_ID = #{id}

ストアドプロシージャを実行する select 要素の resultSets 属性で、それぞれの ResultSet に名前を付けておく必要があります(カンマ区切り)。ここでは、それぞれ blogs, posts としています。

<select id="selectBlog" resultSets="blogs,posts" resultMap="blogResult">
  {call getBlogsAndPosts(#{id,jdbcType=INTEGER,mode=IN})}
</select>

以下の resultMap では、posts に含まれる Post が、対応する Blog にマッピングされます。

<resultMap id="blogResult" type="Blog">
  <id property="id" column="id" />
  <result property="title" column="title"/>
  <collection property="posts" ofType="Post" resultSet="posts" column="id" foreignColumn="blog_id">
    <id property="id" column="id"/>
    <result property="subject" column="subject"/>
    <result property="body" column="body"/>
  </collection>
</resultMap>

Note collection と association のマッピングに関して、階層の深さやオブジェクトの大きさに制限はありませんし、両者を組み合わせることも可能です。 ただ、パフォーマンスのことは忘れないようにしてください。 ユニットテストと負荷テストを怠らなければ、あなたのアプリケーションにとっての最適なアプローチを見つけることができます。 幸いなことに、後で別のアプローチに切り替える場合でも、MyBatis ならコードの変更は最小限(あるいはゼロ)で済みます。

association と collection を使った高度なマッピングはかなり深いテーマです。 ドキュメントで全てを網羅することはできませんが、少し練習すればすぐに全体がクリアになるはずです。

discriminator

<discriminator javaType="int" column="draft">
  <case value="1" resultType="DraftPost"/>
</discriminator>

データベースに対して実行した1回のクエリによって、複数の異なる(何らかの関係を持った)データ型を含む結果が戻ってくることがあります。 discriminator 要素は、こうしたケースをはじめとして、クラスの継承関係を再現する場合など様々な用途を想定して作られています。 discriminator は、Java における switch 文と同じように働くので理解するのはそれほど難しくないはずです。

discriminator を定義する場合は column と javaType 属性を指定します。 ここで指定した column は、MyBatis が比較対象の値を参照する際に使用されます。 javaType は、値が等しいかどうかを調べる際、確実に正しい比較が行われるように指定します(ですが、ほとんどのケースでは String を指定すれば期待通りに動作するはずです)。 使用例を見てみましょう。

<resultMap id="vehicleResult" type="Vehicle">
  <id property="id" column="id" />
  <result property="vin" column="vin"/>
  <result property="year" column="year"/>
  <result property="make" column="make"/>
  <result property="model" column="model"/>
  <result property="color" column="color"/>
  <discriminator javaType="int" column="vehicle_type">
    <case value="1" resultMap="carResult"/>
    <case value="2" resultMap="truckResult"/>
    <case value="3" resultMap="vanResult"/>
    <case value="4" resultMap="suvResult"/>
  </discriminator>
</resultMap>

この例では、MyBatis は結果セットのレコードをひとつずつ取り出して vehicle_type の値を比較します。 もし、vehicle_type の値が case で指定した条件のいずれかに一致した場合、その case 要素で指定されている resultMap を使って結果のマッピングを行います。 この処理は排他的に行われます。言い換えると、使われなかった resultMap は無視されるということです(ただし resultMap が継承されている場合は別です。これについてはすぐ後で説明します)。 一致する case が見つからない場合は、discriminator ブロックの外側で定義されている resultMap だけが適用されます。 仮に、carResult が次のように定義されていたとします。

<resultMap id="carResult" type="Car">
  <result property="doorCount" column="door_count" />
</resultMap>

この場合、doorCount プロパティのみが読み込まれることになります。 これによって、完全に独立した discriminator case のグループを定義することができます。親の resultMap と全く関連性のない resultMap であっても構いません。 今回のケースでは車は乗り物の一種(Car is-a Vehicle)なので、car と vehicle の間に関連性があることは明らかです。 当然、doorCount 以外のプロパティも読み込んで欲しいと思うでしょう。 resultMap を一箇所変更すれば、希望通りの動作になります。

<resultMap id="carResult" type="Car" extends="vehicleResult">
  <result property="doorCount" column="door_count" />
</resultMap>

これで、vehicleResult と carResult の両方で定義されているすべてのプロパティが読み込まれるようになります。

繰り返しになりますが、別々の resultMap を定義するのが面倒だと考える方もいると思います。 簡潔にまとまった表記が好みだという方のために、別の記法も用意されています。

<resultMap id="vehicleResult" type="Vehicle">
  <id property="id" column="id" />
  <result property="vin" column="vin"/>
  <result property="year" column="year"/>
  <result property="make" column="make"/>
  <result property="model" column="model"/>
  <result property="color" column="color"/>
  <discriminator javaType="int" column="vehicle_type">
    <case value="1" resultType="carResult">
      <result property="doorCount" column="door_count" />
    </case>
    <case value="2" resultType="truckResult">
      <result property="boxSize" column="box_size" />
      <result property="extendedCab" column="extended_cab" />
    </case>
    <case value="3" resultType="vanResult">
      <result property="powerSlidingDoor" column="power_sliding_door" />
    </case>
    <case value="4" resultType="suvResult">
      <result property="allWheelDrive" column="all_wheel_drive" />
    </case>
  </discriminator>
</resultMap>

思い出してください これらは全て Result Map なので、もし result が全く指定されていなければ、MyBatis が自動的に列名と一致する名前を持つプロパティに値を設定します。 ですから、上で挙げた例の多くは必要以上に冗長になっているといえます。 ただ、データベースは複雑ですから全てのケースで自動マッピングが使えるということもないでしょう。

自動マッピング

前章では、シンプルなケースでは MyBatis の自動マッピングが利用できるということと、複雑なケースではあなた自身で Result Map を記述する必要があるということを説明しました。 この章では更に、この2つの方法を同時に利用する方法を説明していきます。 まず、自動マッピングの動作について詳しく見て行きましょう。

結果を自動マッピングする際、MyBatis は列名と同じ名前を持つプロパティを探します(大文字と小文字は区別しません)。 例えば ID という名前の列と id という名前のプロパティが見つかった場合、MyBatis は id プロパティに ID 列の値をセットします。

通常、データベースの列名は英数字と単語を区切るアンダースコアで定義され、Java のプロパティはキャメルケースで定義されるのが一般的です。 mapUnderscoreToCamelCase に true に設定すると、この一般的な命名規則に基づいて自動マッピングを適用することができます。

Result Map が指定されている場合でも自動マッピングは動作します。この場合、ResultSet に含まれる列のうち、各 Result Map で明示的にマッピングが指定されていない列が自動マッピングの対象となります。 次の例では、hashed_password 列が password プロパティにマップされ、iduserName 列が自動マッピングの対象となります。

<select id="selectUsers" resultMap="userResultMap">
  select
    user_id             as "id",
    user_name           as "userName",
    hashed_password
  from some_table
  where id = #{id}
</select>
<resultMap id="userResultMap" type="User">
  <result property="password" column="hashed_password"/>
</resultMap>

自動マッピングには3つのレベルがあります。

  • NONE - 自動マッピングを無効化します。明示的にマッピングが指定されたプロパティにのみ値がセットされます。
  • PARTIAL - ネストされた Result Map を持たない Result Map のみが自動マッピングの対象となります。
  • FULL - 全ての Result Map が自動マッピングの対象となります。

デフォルト値は PARTIAL で、それには理由があります。 FULL が指定されていると、JOIN 句によって複数のエンティティに対する結果が一行に結合されているような場合に自動マッピングによって意図しないマッピングが実行されてしまう場合があります。 次の例を見てください。

<select id="selectBlog" resultMap="blogResult">
  select
    B.id,
    B.title,
    A.username,
  from Blog B left outer join Author A on B.author_id = A.id
  where B.id = #{id}
</select>
<resultMap id="blogResult" type="Blog">
  <association property="author" resultMap="authorResult"/>
</resultMap>

<resultMap id="authorResult" type="Author">
  <result property="username" column="author_username"/>
</resultMap>

この Result Map では、BlogAuthor の両方が自動マッピングの対象となりますが、Authorid というプロパティがあり、ResultSet に id という列が含まれているため、Author の id に Blog の id がセットされることになります。 自動マッピングで FULL を指定する場合は、こうした意図しないマッピングが行われないように注意する必要があります。

尚、グローバルな自動マッピング設定とは別に、autoMapping 属性を指定することで特定のステートメントでの自動マッピング動作を有効/無効化することもできます。

<resultMap id="userResultMap" type="User" autoMapping="false">
  <result property="password" column="hashed_password"/>
</resultMap>

cache

MyBatis には非常に柔軟なトランザクション対応のクエリキャッシング機能が用意されています。 MyBatis 3 では、より強力で、かつ簡単に設定できるよう、キャッシュの実装に多くの改良が加えられています。

デフォルトでは、セッション生存期間中のデータを保持するローカルセッションキャッシュのみが有効です。 グローバルな2次キャッシュを有効にするためには、Mapper XML ファイルに次の一行を追加するだけです。

<cache/>

文字通りこれだけです。この行の効果は次の通りです。

  • この SQL マップファイルに含まれる select ステートメントの結果は全てキャッシュされます。
  • この SQL マップファイルに含まれる insert, update, delete ステートメントを実行するとキャッシュがフラッシュされます。
  • このキャッシュは LRU アルゴリズムに基づいて置き換えられます。
  • このキャッシュは経過時間によってフラッシュされることはありません(つまり Flush Interval は設定されていないということです)。
  • このキャッシュはクエリ結果のリストまたはオブジェクトへの参照を 1024 個格納します。
  • このキャッシュは読み書き可能なキャッシュとして扱われます。これはつまり、取得したオブジェクトは共有されず、呼び出した側で安全に変更することができる(別の呼び出し元や他スレッドでの変更の影響を受けない)ということを意味しています。

重要 対応する Java マッパーのステートメントをキャッシュの適用対象に含めるためには @CacheNamespaceRef アノテーションで XML マッパーのネームスペースを指定する必要があります。

これらのプロパティは cache 要素の属性で変更することができます。

<cache
  eviction="FIFO"
  flushInterval="60000"
  size="512"
  readOnly="true"/>

この設定では、以下のようなキャッシュが作成されます。

  • FIFO アルゴリズムに基づいて置き換えられる。
  • 60 秒ごとにフラッシュされる。
  • 結果オブジェクトまたはリストへの参照を 512 個まで格納できる。
  • 返されるオブジェクトは読み取り専用(read-only)(変更した場合、他の呼び出し元や別スレッドからの変更とコンフリクトする可能性がある)。

指定可能な置換(eviction)ポリシーは以下の通りです。

  • LRU – Least Recently Used: 最も長いこと使われていないオブジェクトを優先的に削除します。
  • FIFO – First In First Out: 最初に登録されたオブジェクトから順番に削除します。
  • SOFT – Soft Reference: ガベージコレクターの状態と Soft Reference の規則に基づいてオブジェクトを削除します。
  • WEAK – Weak Reference: ガベージコレクターの状態と Weak Reference の規則に基づいて、より積極的にオブジェクトを削除します。

デフォルト値は LRU です。

flushInterval には、適切な時間(ミリ秒)を表す正の整数を指定することができます。 デフォルト値は指定なしで、キャッシュがフラッシュされるのはステートメント(insert, update, delete または flushCache が設定された select)が実行された場合のみです。

size には任意の正の整数を指定することができますが、実行環境で利用可能なメモリリソースとキャッシュされるオブジェクトのサイズに配慮してください。デフォルト値は 1024 です。

readOnly 属性には true または false を設定することができます。読み取り専用キャッシュはキャッシュされたオブジェクトのインスタンスをそのまま呼び出し元に返しますので、このオブジェクトを変更すべきではありません。 読み取り専用キャッシュの利点は非常に高速だということです。 読み書き可能なキャッシュは、キャッシュされたオブジェクトを複製して(シリアライゼーションを使います)返しますので読み取り専用と比較すると遅いですが安全です。 デフォルト値は false です。

NOTE 2次レベルキャッシュはトランザクションに対応しています。SqlSession が (1) commit された場合、あるいは (2) flushCache=true が指定された insert/delete/update が実行されずに rollback された場合に2次レベルキャッシュが更新されます。

カスタムキャッシュを使う

上記のプロパティを使ってキャッシュをカスタマイズする方法の他に、自作のキャッシュ実装や 3rd パーティのキャッシュソリューションのアダプタを作成してキャッシュの挙動を完全にオーバーライドしてしまうこともできます。

<cache type="com.domain.something.MyCustomCache"/>

上記は、カスタムキャッシュの実装を使用するための設定例です。 type 属性で指定されているクラスは org.mybatis.cache.Cache インターフェイスを実装している必要があります。 このインターフェイスは MyBatis の中では複雑な方ですが、その役割を考えればシンプルです。

public interface Cache {
  String getId();
  int getSize();
  void putObject(Object key, Object value);
  Object getObject(Object key);
  boolean hasKey(Object key);
  Object removeObject(Object key);
  void clear();
}

あなたが作成したキャッシュを設定するには、キャッシュの実装クラスに public な JavaBean プロパティを追加し、cache 要素でプロパティを渡しします。 例えば次のように設定すると、あなたが作成したキャッシュの実装クラスの "setCacheFile(String file)" というメソッドが呼び出されます。

<cache type="com.domain.something.MyCustomCache">
  <property name="cacheFile" value="/tmp/my-custom-cache.tmp"/>
</cache>

設定対象のプロパティは、単純型であれば String 以外でも使用可能です。 加えて、コンフィギュレーション用のプロパティに定義した値で置き換えるために、プレースホルダ(例:${cache.file})を指定することができます。

3.4.2以降では, MyBatisはすべてのプロパティを設定した後に初期化メソッドを呼び出す仕組みをサポートしています。 この機能の使用したい場合は、あなたが作成したキャッシュの実装クラスにorg.apache.ibatis.builder.InitializingObjectインタフェースを実装してください。

public interface InitializingObject {
  void initialize() throws Exception;
}

ここで重要なのは、キャッシュの設定とキャッシュのインスタンスは Mapper XML ファイルのネームスペースに関連付けられているということです。 あるネームスペースに対して定義されているキャッシュは、同じネームスペース内で定義されている全てのステートメントに関連付けられます。 ステートメントごとにキャッシュとの関連性を変更したり無効化することができるように、二つの簡単な属性が用意されています。 デフォルトでは、各ステートメントは下記のように設定されています。

<select ... flushCache="false" useCache="true"/>
<insert ... flushCache="true"/>
<update ... flushCache="true"/>
<delete ... flushCache="true"/>

上記の設定はデフォルトですので、明示的に上記のように設定する必要はありません。 デフォルトの動作を変更したい場合に限り、flushCache と useCache 属性を設定するようにしてください。 例えば、特定の select ステートメントの結果をキャッシュの対象から除外したり、ある select ステートメントを実行する際にキャッシュをフラッシュしたい、といった場合です。 同様に、キャッシュのフラッシュを伴わない update ステートメントを定義したいと思う時があるかも知れません。

cache-ref

前の章で説明した通り、あるネームスペースに対して設定されているキャッシュが適用されるのは同じネームスペース内で定義されているステートメントのみですし、このキャッシュをフラッシュするのも同じネームスペース内で定義されているステートメントのみです。 あるキャッシュの設定とインスタンスを複数のネームスペースで共有したいと思う時があるかも知れません。 その場合、cache-ref 要素を使って別のネームスペースで定義されているキャッシュの定義を参照することができます。

<cache-ref namespace="com.someone.application.data.SomeMapper"/>