iBATIS.NETにてO/Rマッピングを行う（SQL Maps編）

はじめに

　チームのメンバーが作成したプログラムを見ていて「DBアクセス禁止のレイヤ（プレゼンテーション層・サービス層など）からSQLを実行していた」とか「問題を引き起こしているSQLの特定が困難だった」といった経験はありませんか。本稿では、このような問題の解決に有効な「iBATIS.NET」というオープンソースのプロダクトについて紹介します。「iBATIS.NET」は「SQL Maps」と「DAO Framework」というの2つのフレームワークから構成されており、DBアクセスを簡単にすることができます。

SQL Maps

　XMLに定義したSQLを実行し、その実行結果とオブジェクトをマッピングする機能を提供します。NHibernateやGentle.NETといった他のO/Rマッピングツールとは異なり開発者がSQLを記述する必要がありますが、既存のSQLを再利用できたり、パフォーマンスチューニングを行いやすいといったメリットがあります。

DAO Framework

　パーシステンス層（DBアクセス）とサービス層（ビジネスロジック）の依存性を下げる簡易のDI(Dependency Injectioun)機能を提供します（DIとはインターフェースと実装を分離して、実際のコンポーネントの生成を設定ファイルなどで管理しようという考え方です）。

　「iBATIS.NET」を導入すると「プログラムからSQLを分離し設定ファイルで集中管理できる」「サービス層のプログラミングがシンプルになる」「パーシステンス層の変更がサービス層へ影響を与えにくい」といったメリットがあります。また、SQLを実行した際にはログとしてSQL文と入力パラメータが表示されるため、デバッグが行いやすというメリットもあります。今後、データベースにアクセスするアプリケーションを開発する際には選択肢の1つとして検討してみてはいかがでしょうか。

　本稿では、この「iBATIS.NET」のうち、SQL Maps機能について紹介します。DAO Framework機能については、別稿「iBATIS.NETにてO/Rマッピングを行う（DAO Framework編）」を参照してください。

対象読者

　.NETにて開発を行っている方、また基本的なSQLを理解している方を対象としています。

必要な環境

　サンプルはVisual Studio .NET 2003で作成し、.NET Framework 1.1で動作確認をしています。

サンプルアプリケーションについて

　本稿のサンプルは書籍マスタのメンテナンスを行うWindowsアプリケーションです。

書籍マスタのメンテナンス画面

　「SQL Maps」を用いて、MDB(Microsoft Accessのデータベース形式)にアクセスを行い、書籍テーブルへの追加・更新・参照・削除といったデータベース操作を実行します。なお、iBATIS.NET(DataMapper-1.2.1)はサンプルに同梱されているため、改めてiBATIS.NETを入手する必要はありません。

　もし、「SQL Maps」と「DAO Framework」の両方を用いたプログラムの例をご覧になりたい場合には別稿のサンプルをダウンロードしてください。

iBATIS.NETの入手

　iBATIS.NETはApacheのWebサイトからダウンロード可能です。「SQL Maps」と「DAO Framework」という2つのフレームワークから構成されていますので、最新バージョンの「DataAccess-bin-X.X.X.XXX.zip」と「DataMapper-bin-X.X.X.XXXX.zip」を入手してください。なおiBATISにはJava版と.NET版がありますので「iBATIS for Java」ではなく「iBATIS.NET」をダウンロードするようにしてください。また、必要に応じてソースコード・ドキュメント・チュートリアルなどをダウンロードすると良いでしょう。

VisualStudio.NETの設定

　VisualStudioから使用する場合は、ソリューションエクスプローラの[参照設定]を右クリックして[参照の追加]を行います。「SQL Maps」を使用するときは「IBatisNet.Common」と「IBatisNet.DataMapper」を、「DAO Framework」を使用するときは「IBatisNet.Common」と「IBatisNet.DataAccess」を追加してください。

iBATIS.NETの対応データベース

　iBATISはADO.NETを介して動作するため、対応するデータベースはADO.NETのデータプロバイダに依存します。

　執筆時点でiBATIS.NETは上記のデータベースに対応しています。ただし、SQLServer、OleDb、Odbc以外に接続する場合は、そのデータベース固有のライブラリ(DLL)が必要になります。接続できるデータプロバイダの詳細については、iBATISのFAQと「providers.config」ファイルをご覧ください。

「SQL Maps」の実装(更新系:INSERTの場合)

　それでは「SQL Maps」でO/Rマッピングをする方法を紹介します。「SQL Maps」のメリットは以下の通りです。

• SQLとプログラムの分離。
• SQLの入力パラメータの設定の省略と、実行結果のオブジェクトへのマップの実現。
• ビジネスロジッククラスとデータアクセスクラスの分離。

　ここでは「書籍(BOOK)」テーブルのマッピングを行う例を紹介します。

　更新処理に必要な手順は以下の3つです。

1. マッピング対象のクラス「Book.cs」の記述。
2. マッピングファイル「Book.xml」にINSERT文の記述。
3. 管理ファイル「SqlMap.config」に「Book.xml」を登録。

マッピング対象オブジェクト「Book.cs」の記述

　「BOOK」テーブルのデータを格納するBookクラスを記述します。

using System;
namespace iBatisSample.Domain.User
{
  public class Book
  {
    private string _Isbn;
    private string _Title;
    private DateTime _SaleDate;
    private int _Price;

    public string Isbn 
    {
      get{ return _Isbn; }
      set{_Isbn = value; }
    }

    //(以下同様にget/set設定)
  }
}

　このクラスはアクセサメソッドにて構成されるシンプルなオブジェクトです。層間のデータの受け渡しに使用されるため、DTO(Data Transfer Object)とも呼ばれます。

マッピングファイル「Book.xml」にINSERT文を記述

　マッピングファイルと呼ばれる設定ファイルに、SQLを<insert>要素として記述します。id属性にはSQLの定義名を、parameterClass属性には引数用のクラスを指定します。

<insert id="InsertBook" parameterClass="Book">
  insert into BOOK
    (ISBN,TITLE,SALE_DATE,PRICE)
  values 
    (#Isbn#, #Title#, #SaleDate#,#Price#)
</insert>

　ここでは「#Isbn#」のように「#」で囲まれている項目に注目してください。これはSQLの実行時に動的に設定されるパラメータで内部的には以下のようなSQLに展開されます。

--OLE DBの場合
insert into BOOK (ISBN,TITLE,SALE_DATE,PRICE)
 values ( ? , ? , ? , ? )

--SQL Serverの場合
insert into BOOK (ISBN,TITLE,SALE_DATE,PRICE)
 values ( @Isbn ,@Title , @SaleDate , @Price )

　「SQL Maps」は、このSQLのバインド変数にBookクラスのプロパティの値を自動的にセットしてくれます（「#Isbn#」というパラメータに「BookクラスのIsbnプロパティ」の値をセットします）。

　このSQLのパラメータに値を簡単にセットできるところが、「SQL Maps」の便利な機能の1つといえるでしょう。

管理ファイル「SqlMap.config」に「Book.xml」を登録

　マッピングファイルを新しく定義した場合は、SQL Mapsの管理ファイル「SqlMap.config」に登録します。

<!-- マッピング定義ファイル -->
<sqlMaps>
  <sqlMap resource="./Maps/Book.xml"/>
  <sqlMap resource="./Maps/Hoge.xml"/>
  <sqlMap resource="./Maps/Moge.xml"/>
</sqlMaps>

　このように<sqlMaps>要素として「MapsフォルダのBook.xmlファイル」を登録します。また、「SqlMap.config」には以下のようにデータベースの接続先を設定することができます。

<database>
  <!-- MDBへの接続例 -->
  <provider name="OleDb1.1"/>
  <dataSource name="Access" connectionString=
    "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=iBatisSample.mdb"/>
</database>

　ただし、別稿の「DAO Framework」を使用する場合は「dao.config」の接続先が優先されますのでご注意ください。

クライアント側のプログラム

　SQL Mapsで定義したクラスを利用する側(クライアント側)のプログラムは以下のようなイメージになります。

//オブジェクトに値をセット
Book book = new Book();
book.Isbn = "4123456789"; 
book.Title = "iBATIS.NET入門"; 
book.Price = 2800;
book.SaleDate = new DateTime(2005,4,1);
//SQLの実行
Mapper.Instance().Insert("InsertBook",book);

　「Mapper.Instance().Insert("InsertBook",book)」では、iBATISが提供しているクラスSqlMapperのInsertメソッドを使用してデータを登録しています。「Book.xml」にて定義したidの名称を1つ目の引数に、parameterClassのクラス変数名を2つ目の引数に設定する必要があります。

　ここまではINSERTの実行方法について説明をしました。なお、UPDATE、DELETEについても同様の設定(<update>要素、<delete>要素)にて実行することができます。

「SQL Maps」の実装(参照系：SELECTの場合)

　引き続き、SELECTを実行し、結果をオブジェクトにマッピングする方法を紹介します。

マッピングファイル「Book.xml」にSELECT文を記述

　SELECTの場合は、マッピングファイルの<select>要素にてSQLを定義します。

<statements>
  <select id="GetBookListByTitle" 
    resultMap="BookResult" parameterClass="System.String">
    select
      ISBN,
      TITLE,
      SALE_DATE,
      PRICE
    from BOOK
    where TITLE LIKE #VALUE#
    order by ISBN
  </select>
</statements>

　ここではINSERTには存在しなかった「resultMap」という属性があることに注目してください。これは、SELECTの実行結果をオブジェクトにマッピングするための定義名です。マッピングの定義方法は以下のように「class」に対象クラス、「property」にクラスのプロパティ名、「column」に列名を設定します。

<alias>
  <typeAlias alias="Book"
    type="IBatisSample.Domain.Books.Book,IBatisSqlMapSample" />
</alias>
<resultMaps>
  <resultMap id="BookResult" class="Book">
    <result property="Isbn" column="ISBN" />
    <result property="Title" column="TITLE" />
    <result property="SaleDate" column="SALE_DATE" />
    <result property="Price" column="PRICE" />
  </resultMap>
</resultMaps>

　この例では、SELECTした結果の「ISBN」列の値が「BookクラスのISBNプロパティ」へ、「TITLE」列の値が「BookクラスのTitleプロパティ」へと自動的にセットされます。

クライアント側のプログラム

　クライアント側のプログラムは以下のようなイメージになります。

//SQLの実行
IList books =
  Mapper.Instance().QueryForList("GetBookListByTitle","%NET%");
//結果を出力
foreach (Book book in books)
{
  Console.WriteLine(book.Title);
}

　「IList books = Mapper.Instance().QueryForList("GetBookListByTitle","%NET%")」では、SqlMapperのQueryForListメソッドを使用して、タイトルに「NET」が含まれる人をリストにて取得しています。

　マッピングファイルの設定によってSELECTの結果がオブジェクトへ簡単にセットできるところが「SQL Maps」の長所と言えるでしょう。

高度なSQLの作成

　iBATIS.NETにはSQL文のWHERE句などを動的に組み立てる機能もあります。この機能を使うと条件が違うだけのSQLを定義する必要がなくなるので大変便利です。この動的なSQL生成は要素<dynamic>を用いて実現することができます。

//3000円以上の書籍を抽出
Hashtable param = new Hashtable();
param.Add("price","3000");
param.Add("priceCompare","以上");
return ExecuteQueryForList("GetBookListByPrice",param);

<select id="GetBookListByPrice" resultMap="BookResult"
 parameterClass="System.Collections.Hashtable">
  select
    ISBN,
    TITLE,
    SALE_DATE,
    PRICE
  from BOOK
  <dynamic prepend="where">
  
    <isEqual property="priceCompare" compareValue="以上">
    <![CDATA[
      PRICE >= #price#
    ]]>
    </isEqual>
    <isEqual property="priceCompare" compareValue="以下">
    <![CDATA[
      PRICE <= #price#
    ]]>
    </isEqual>
    
  </dynamic>
  order by PRICE
</select>

　この例では、引数「priceCompare」に「以上」が設定されていれば、WHERE句の条件に「PRICE >= #price#」が設定され、「以下」が設定されていれば「PRICE <= #price#」が設定されます。なお<dynamic>要素の属性prependは動的に追加するSQL文の前に付加する文字列になります。つまり引数「priceCompare」に「以上」か「以下」という文字列がセットされていればwhereという文字も追加されます。なお、SQLの条件には今回紹介した<isEqual>以外にも<isGreaterThan><isPropertyAvailable><isNull><isEmpty>など様々な条件式が用意されています。

「SQL Maps」の整理

　Sql Mapsの主要クラスと設定ファイルについて下図に整理します。

SqlMapの主要クラス・設定ファイル(黄色はSqlMapsが提供しているモジュール)

SQL Mapsの主要メソッド

　MapperクラスのInstanceメソッドによって取得できるSqlMapperクラスの主要メソッドは下表の通りです。

　実行したい処理に応じて、SqlMapperクラスのメソッドを呼び出すようにしてください。

引数の型と戻り値の型

　使用可能な引数と戻り値の型は「プリミティブ型（int/stringなど）」「オブジェクト（Bookなど）」「ハッシュテーブル（HashTableなど）」の３パターンで、マッピングファイルに設定できるSQL文の属性は下表の通りです。

• ○・・・設定可
• ×・・・設定不可

　selectとprocedureではデータを取得するため「parameterMap（parameterClass）」と「resultMap（resultClass）」の両方が指定できますが、insertやupdateやdeleteでは「parameterMap（parameterClass）」のみ指定できます。

設定ファイル

　iBATIS.NETには以下のような設定ファイル(*.config/*.xml)が存在します。

　今回紹介した「SQL Maps」では「SqlMap.config」と「マッピング定義ファイル」の2つの設定ファイルの編集が必要です。なお、これらのファイルは「exe/dll」と同じフォルダに配置するようにしてください。

まとめ

　iBATIS.NETのSQL Mapsを利用することで、SQL定義を外部のXMLファイルに設定することができ、画面やビジネスロジックの開発者はSQLを意識することなくオブジェクトを用いた開発に専念することができるようになります。また、本稿で紹介した機能以外にも「プライマリキーの生成」「$～$によるパラメータのセット」「SQL文字列の継承」「NULLの際のデフォルト設定」「キャッシュ」など、さらに便利な機能もありますので、興味のある方はマニュアルに目を通して見ると良いでしょう。

参考資料

1. Apache iBATIS(英語)
2. Apache iBATISのメーリングリストログ(英語)
3. Apache iBATISのFAQ(英語)
4. Apache iBATISのWiki(英語)
5. O/Rマッピングの役割とメリット(@IT)