<?xml version="1.0" encoding="UTF-8"?>
<!--

       Copyright ${license.git.copyrightYears} the original author or authors.

       Licensed under the Apache License, Version 2.0 (the "License");
       you may not use this file except in compliance with the License.
       You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

       Unless required by applicable law or agreed to in writing, software
       distributed under the License is distributed on an "AS IS" BASIS,
       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
       See the License for the specific language governing permissions and
       limitations under the License.

-->
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">

  <properties>
    <title>MyBatis 3 | スタートガイド</title>
    <author email="clinton.begin@gmail.com">Clinton Begin</author>
    <author email="harawata@gmail.com">Iwao AVE!</author>
  </properties>

  <body>
    <section name="スタートガイド">

    <subsection name="Installation">
      <p>
        MyBatis を使うためには、ダウンロードした
        <a href="https://github.com/mybatis/mybatis-3/releases">mybatis-x.x.x.jar</a>
        をクラスパスに追加する必要があります。
      </p>
      <p>
        Maven を利用している場合は pom.xml に下記の依存性を追加するだけで OK です。
      </p>
        <source><![CDATA[
<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>x.x.x</version>
</dependency>]]></source>
    </subsection>

      <subsection name="XML 形式の設定ファイルを使って SqlSessionFactory を生成する">
        <p>
          MyBatis アプリケーションは、SqlSessionFactory のインスタンスを中心に構成されています。<br />
          SqlSessionFactory のインスタンスは、SqlSessionFactoryBuilder を使って取得することができます。
          SqlSessionFactoryBuilder が SqlSessionFactory を生成する際の設定は、XML 形式の設定ファイルを読み込むか、独自に用意した Configuration クラスのインスタンスを渡すことで行います。
        </p>
        <p>
          XML 形式の設定ファイルを使って SqlSessionFactory を生成するのはとても簡単です。<br />
          この設定ファイルはクラスパスに置くことが推奨されますが、ファイルパスや file:// 形式の URL 文字列から生成した
          InputStream を使ってクラスパス以外の場所に配置されたファイルを読み込むこともできます。
          MyBatis 付属の Resources というユーティリティクラスには、クラスパスや、それ以外の場所からリソースを読み込むためのメソッドが多数用意されています。
        </p>
        <source><![CDATA[
String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);]]></source>
        <p>
          XML 形式の設定ファイルには、MyBatis システムの基本設定が含まれます。
          例えば、データベースから Connection のインスタンスを取得する DataSource や、トランザクションの制御方法を決定する TransactionManager などです。<br />
          XML 形式の設定ファイルの詳細については後ほど改めて説明しますが、ここでは簡単なサンプルを挙げておきます。
        </p>
        <source><![CDATA[<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="${driver}"/>
        <property name="url" value="${url}"/>
        <property name="username" value="${username}"/>
        <property name="password" value="${password}"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="org/mybatis/example/BlogMapper.xml"/>
  </mappers>
</configuration>]]></source>
        <p>
          XML 形式の設定ファイルについて説明すべきことは他にもたくさんありますが、最も重要な設定は上記のサンプルに含まれています。<br />
          まず、XML ドキュメントのバリデーションを行うために必要となる XML ヘッダがあります。<br />
          environment 要素には、トランザクション管理やコネクションプーリングといった環境依存の設定が含まれています。<br />
          mappers 要素には Mapper のリストが含まれています。Mapper とは、SQL 文とマッピングの定義を含む XML ファイルです。
        </p>
      </subsection>
      <subsection name="XML を使わずに SqlSessionFactory を生成する">
        <p>
          XML を使わず Java のコードで設定を行いたい方のために、Configuraiton クラスが提供されています。<br />
          XML 形式の設定ファイルで指定できるオプションは、このクラスでも全て設定可能です。
        </p>
        <source><![CDATA[DataSource dataSource = BlogDataSourceFactory.getBlogDataSource();
TransactionFactory transactionFactory = new JdbcTransactionFactory();
Environment environment = new Environment("development", transactionFactory, dataSource);
Configuration configuration = new Configuration(environment);
configuration.addMapper(BlogMapper.class);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);]]></source>
        <p>
          今回は、Configuration のインスタンスに Mapper クラスを追加していることに気づいたでしょうか。<br />
          Mapper クラスには、XML を使わずに SQL マッピングを定義するためのアノテーションが含まれています。
          ただし、Java
          アノテーションの制約と MyBatis のマッピング機能の複雑さのため、高度なマッピングを定義する際に XML
          形式の Mapper が必要となる場合があります（ネストされた結合クエリの結果をマッピングする場合など）。<br />
          このため、MyBatis は対になる XML ファイルを探して自動的に読み込むようになっています（この例では、BlogMapper.class のクラスパスと名前を元に BlogMapper.xml という XML ファイルが読み込まれます）。
          この動作については、後ほど詳しく説明します。
        </p>
      </subsection>
      <subsection name="SqlSessionFactory から SqlSession を取得する">
        <p>
          名前を見れば分かると思いますが、生成した SqlSessionFactory から SqlSession のインスタンスを取得することができます。<br />
          SqlSession には、一連の SQL コマンドを実行するためのメソッドが全て用意されています。
          SqlSession のインスタンスに対して、マップされた SQL 文を直接指定して実行することができます。<br />
          例えば下記のようなコードになります。
        </p>
        <source><![CDATA[try (SqlSession session = sqlSessionFactory.openSession()) {
  Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);
}]]></source>
        <p>
          この方法は期待通りに動作しますし、旧バージョンの MyBatis に慣れている方には分かりやすいと思いますが、
          現在のバージョンではもっと美しい方法があります。
          実行する SQL 文にマッチするように引数と戻り値がきちんと定義されたインターフェイスを使えば、ミスしがちな文字列やキャストなしで、より美しく、型に安全なコードを使って SQL を実行することができます。
        </p>
        <p>例：</p>
        <source><![CDATA[try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  Blog blog = mapper.selectBlog(101);
}]]></source>
        <p>では、実際にどのような処理が行われているのかを見て行きましょう。</p>
      </subsection>
      <subsection name="Mapped SQL Statements について">
        <p>
          SqlSession や Mapper クラスによって何が行われているのか、そろそろ気になり出した頃ではないでしょうか。
          Mapped SQL Statements は非常に大きな話題で、このドキュメントの大部分を占めることになると思いますが、
          ここではいくつか例を挙げて、実際にどのような処理が行われているのかを簡単に説明してみたいと思います。
        </p>
        <p>
          上で挙げた２つのサンプルに対応する SQL Statement は、XML、アノテーションのどちらを使っても定義することができます。<br />
          はじめに XML について見て行きましょう。
          何年にも渡って MyBatis の人気を築いてきた XML ベースのマッピング言語を使えば、MyBatis の全機能を把握することができます。
          このドキュメントの後の方で出てきますが、旧バージョンの MyBatis を使ったことがある方なら、コンセプトは同じですが、多くの改良が加えられていることが分かると思います。
          以下は、先ほどの例で SqlSession のメソッドを呼び出したときに実行されることを想定した XML ベースの Mapped Statement です。
        </p>
        <source><![CDATA[<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
  PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="org.mybatis.example.BlogMapper">
  <select id="selectBlog" resultType="Blog">
    select * from Blog where id = #{id}
  </select>
</mapper>]]></source>
        <p>
          例が簡単なので無駄に記述量が多いように見えるかも知れませんが、本質的にはそれほどではありません。<br />
          ひとつの Mapper XML ファイルに複数の Mapped Statement を定義することができるので、XML ヘッダや doctype 宣言は一度書くだけです。<br />
          残りの部分はほぼ自明ですが、「org.mybatis.example.BlogMapper」というネームスペースの中に「selectBlog」という名前の Mapped Statement を定義しています。<br />
          上のサンプルと同じですが、この Mapped Statement を実行するには、以下のように完全修飾名「org.mybatis.example.BlogMapper.selectBlog」を指定して SqlSession のメソッドを呼び出します。
        </p>
        <source><![CDATA[Blog blog = session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);]]></source>
        <p>
          この例が、完全修飾名で指定した Java クラスのメソッドを呼び出すのと似ていることに気づいたでしょうか。
          これには理由があります。
          この完全修飾名は、Mapped Statement の名前、引数、戻り値にマッチするメソッドを持った、同名の Mapper クラスにマッピングすることができます。
          上で見たような Mapper インターフェイスへの簡単な呼び出しができるのはこの仕組みのおかげです。
          再掲しておきます。
        </p>
        <source><![CDATA[BlogMapper mapper = session.getMapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);]]></source>
        <p>
          ２番目の方法には多くの利点があります。<br />
          まず、文字列リテラルに頼らずに済むので、ずっと安全です。また、Mapped SQL Statement を選ぶときに IDE のコード補完機能を使うことができます。
        </p>
        <hr/>
        <p>
          <span class="label important">NOTE</span>
          <strong>ネームスペースについて</strong>
        </p>
        <p>
          <strong>ネームスペース：</strong> 過去のバージョンの MyBatis では、ネームスペースはオプションでしたが、これは混乱や誤用の原因となっていました。<br />
          現在のバージョンではネームスペースは必須であり、単に長い完全修飾名を使って Statement を整理する以上に重要な役割を果たしています。
        </p>
        <p>
          上で見たように、ネームスペースはインターフェイスバインディングを行うために使われています。
          たとえ今は必要ないと思っても、将来気が変わったときのために推奨される手順通りに設定しておくべきです。
          長い目で見れば、ネームスペースを指定して正しい Java パッケージに配置しておくことでクリーンなコードを書くことができ、MyBatis の使い勝手も向上するはずです。
        </p>
        <p>
          <strong>名前解決：</strong> タイピング量を減らすため、MyBatis は次のようなルールに則って設定要素（Statement, Result Map, Cache など）の名前解決を行います。
        </p>
        <ul>
          <li>完全修飾名（例えば「com.mypackage.MyMapper.selectAllThings」）で指定した場合は、指定された完全修飾名で要素を探し、もし見つかればその要素を参照します。
          </li>
          <li>短縮名（例えば「selectAllThings」）で指定した場合は、短縮名部分が一致する要素を参照します。
          ただし、同じ短縮名を持った要素が２つ以上存在する場合（例えば「com.foo.selectAllThings」と「com.bar.selectAllThings」）は、 指定した短縮名が曖昧なので完全修飾名で指定する必要がある、というエラーが発生します。
          </li>
        </ul>
        <hr/>
        <p>
          BloggerMapper のような Mapper クラスなら、実は XML を使う必要はありません。
          代わりに、Java アノテーションを使って下記のように Mapped Statement を記述することができます。
        </p>
        <source><![CDATA[package org.mybatis.example;
public interface BlogMapper {
  @Select("SELECT * FROM blog WHERE id = #{id}")
  Blog selectBlog(int id);
}]]></source>
        <p>
          アノテーションを使うと単純な SQL 文をスッキリ書くことができますが、複雑な SQL 文をアノテーションを使って書こうとすると可読性が落ちますし、アノテーション固有の制限もありますので、複雑な Mapped Statement を扱わなくてはならない場合には XML を使うことをお勧めします。
        </p>
        <p>
          XML とアノテーションのどちらを使うべきか、そしてどのように一貫性を持たせるかは、あなたとあなたのプロジェクトチーム次第です。
          ただ、常にどちらか一方を使わなくてはならない、という訳ではありません。
          アノテーションベースの Mapped Statement を XML に書き換えることは簡単なことですし、逆もまたしかりです。
        </p>
      </subsection>
      <subsection name="スコープとライフサイクル">
        <p>
          これまでに説明した様々なクラスに適したスコープや、そのライフサイクルについて理解しておくことは大変重要です。
          誤って使用すると、深刻な整合性の問題の原因となります。
        </p>
        <hr/>
        <p><span class="label important">NOTE</span>
          <strong>オブジェクトのライフサイクルと依存性注入（Dependency Injection）フレームワーク</strong>
        </p>
        <p>
          Dependency Injection フレームワークを使うと、スレッドセーフでトランザクション管理された SqlSession や Mapper のインスタンスを作成し、あなたの Bean にインジェクトすることもできます。
          こうすることで、SqlSession や Mapper のライフサイクルについてアプリケーションロジックと分離することができます。
          MyBatis と DI フレームワークの組み合わせについては、サブプロジェクトである MyBatis-Spring または MyBatis-Guice を参照してください。
        </p>
        <hr/>
        <h4>SqlSessionFactoryBuilder</h4>
        <p>
          このクラスは、インスタンス化し、使用し、破棄することができます。
          一旦 SqlSessionFactory を生成してしまえば、このクラスを残しておく理由はありません。
          したがって、このクラスのスコープとして最適なのはメソッドスコープ（つまり、ローカルメソッド変数）です。
          SqlSessionFactoryBuilder を再利用して複数の SqlSessionFactory を生成することも可能ですが、XML をパースするためのリソースが他の重要なものを圧迫しないように、このクラスを保持して使いまわさない方が得策です。
        </p>
        <h4>SqlSessionFactory</h4>
        <p>
          生成した SqlSessionFactory は、あなたのアプリケーション実行中はそのまま残しておくべきです。
          生成した SqlSessionFactory を破棄したり、再度生成する理由はないはずです。
          SqlSessionFactory を再生成しない、というのは所謂ベストプラクティスで、これを行なっていたら「何かおかしいぞ」と考えるべきです。
          したがって、SqlSessionFactory に最適なのはアプリケーションスコープ、ということになります。
          これを実現する方法はいくつもあります。
          最も簡単なのはシングルトンパターンまたはスタティックシングルトンパターンを使う方法です。
        </p>
        <h4>SqlSession</h4>
        <p>
          各スレッドは、独立した SqlSession のインスタンスを使うべきです。
          SqlSession のインスタンスは共有されることを前提としていないため、スレッドセーフではありません。
          当然、最適なスコープはメソッドスコープになります。
          SqlSession のインスタンスへの参照を static なフィールドや、インスタンスフィールドにも格納してはいけません。
          Servlet フレームワークの HttpSession のようなマネージドスコープに SqlSession への参照を保持するのもダメです。
          もし何らかの Web フレームワークを使っているのであれば、SqlSession のスコープが HTTP リクエストと同調するようにしておくべきです。
          つまり、HTTP リクエストを受け取ったら SqlSession をオープンし、レスポンスを返すときにクローズすれば良いのです。
          セッションをクローズすることはとても重要です。
          間違いがないよう、常に finally ブロックの中でセッションをクローズするようにした方が良いでしょう。
          SqlSession を確実にクローズするための一般的なパターンは下記のようなものです。
        </p>
        <source><![CDATA[try (SqlSession session = sqlSessionFactory.openSession()) {
  // do work
}]]></source>
        <p>
          常にこのパターンに従っておけば、すべてのデータベースリソースを確実にクローズすることができます。
        </p>
        <h4>Mapper インスタンス</h4>
        <p>
          Mapper は、Mapped Statement をバインドするためのインターフェイスです。
          Mapper インターフェイスのインスタンスは SqlSession から取得されます。
          したがって、Mapper インスタンスの理論上の最長のスコープは、インスタンス取得元の SqlSession と同じということになります。
          ですが、Mapper インスタンスに最適なスコープはメソッドスコープです。
          つまり、Mapper インスタンスを利用するメソッドの中で取得・破棄するということです。
          Mapper インスタンスを明示的にクローズする必要はありません。
          リクエスト処理が完了するまで残しておいても問題ありませんが、SqlSession 同様、このレベルで余分なリソースを大量に扱うと、すぐに手に負えない状況になってしまうでしょう。
          単純化のため、Mapper はメソッドスコープの中で使うようにしてください。
          このプラクティスを実践したのが次のサンプルになります。
        </p>
        <source><![CDATA[try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  // do work
}
]]></source>
      </subsection>
    </section>
  </body>
</document>
