ImplessDAOユーザーズガイド

ImplessDAOとは、JDBCの面倒なコードを記述せずにDBへアクセスするためのライブラリです。 名前も、IMPlementation-LESS DAOから来てます。 DBアクセスのためのライブラリは既にいくつもありますが、ImplessDAOは次のような目標で設計されています。

ImplessDAOの一番簡単な使い方を示しましょう。 まず、net.sf.implessdao.AbstractDAOを継承して抽象クラスをを作成します。この抽象クラスでは、DBアクセスを行う抽象メソッド(ここではexecuteCreateCarTable) を定義します。このメソッドにnet.sf.implessdao.Sqlアノーテーションを使って、このメソッドが呼ばれたときに実行したいSQLを指定します。

public abstract class CarDAO extends net.sf.implessdao.AbstractDAO {
	@Sql(sql="create table car(ID INT PRIMARY KEY, name VARCHAR(32) NOT NULL)")
	public abstract void executeCreateCarTable();
}
	

		IConnectionFactory connectionFactory = DriverManagerConnectionFactory
				.createConnectionFactory(
						"org.apache.derby.jdbc.EmbeddedDriver",
						"jdbc:derby:testdb;create=true", "", "");
		CarDAO dao = DAOFactory.createWithCompletion(CarDAO.class,
				connectionFactory);
		dao.executeCreateCarTable();
	

ImplessDAOは他のO-Rマッピングフレームワークと比較して、次のようなメリットがあります。

ImplessDAOで補完される抽象メソッドは、以下の条件を満たすものです。

DBアクセス抽象メソッドは、指定されたSQLを実行し結果を返すようImplessDAOにより補完されます。SQLの実行結果の返し方は、メソッド名が何で始まるかによって次のように決まっています。

DBアクセス抽象メソッドで実行するSQLを指定する一つ目の方法はnet.sf.implessdao.Sqlアノーテーションを用いることです。 例えば、下記のようにSQLを指定します。

@Sql(sql="select count(*) from someTable where ${{0:INTEGER}} <= col1 and col1 < ${{1:INTEGER}}")
public abstract IRSIteratable<Map<String,Object>> selectBetween(int lower, int upper);
	

式:アクセッサ指定子
	

Sqlアノーテーションを利用して指定できるSQLは静的な文字列に限定されるので、DBアクセス抽象メソッドの引数の値に応じて SQLを変更したい場合には使えません。動的にSQLを生成するには、Sqlアノーテーションの代わりに、DBアクセス抽象メソッドと同じ引数を持ち、DBアクセス抽象メソッドのメソッド名の後ろに「SQL」を追加した、 Stringを返すメソッド定義します。

public String selectBetweenSQL(Integer lower, Integer upper) {
	String sql = "select count(*) from someTable";
	String sep = " where ";
	if (lower != null) {
		sql += sep + "${{0:INTEGER}} <= col1"; // IN パラメータプレースホルダーを使用
		sep = " and ";
	}
	if (upper != null) {
		sql += sep + "col1 < " + upper; // 文字列に埋め込み
	}
	return sql;
}
public abstract IRSIteratable<Map<String,Object>> selectBetween(Integer lower, Integer upper);
	

select以外で始まるDBアクセス抽象メソッドは、何も返さないかレコード数を返すかなので特に説明は必要ないでしょう。 selectで始まるDBアクセス抽象メソッドは、net.sf.implessdao.IRSIteratableを返します。 IRSIteratableは、java.sql.ResultSetをアプリケーションが扱いやすいjava.util.Iteratorを 通じて利用できるようにしたものです。IRSIteratableの実装は、レコードをどのように格納するのか(Mapに格納するのか、特定のJavaBeansに格納するのかなど)によっていくつか考えられます。 どのIRSIteratableを利用するかは、net.sf.implessdao.IRSIteratableFactoryを指定することで制御します。 IRSIteratableFactoryを指定するには2つの方法があります。一つ目の方法は、AbstractDAOのメソッドdefaultRIF()をオーバーライドすることです。 このメソッドの戻り値が、デフォルトで利用されるIRSIteratableFactoryとなります。二つ目の方法は、動的なSQLの指定と同じように、DBアクセス抽象メソッドと同じ引数で、DBアクセス抽象メソッド名の後ろに「RIF」を追加した、 IRSIteratableFactoryを返すメソッドを定義することです。当然、二つ目の方法が一つ目の方法より優されます。

AbstractDAOのデフォルトの実装では、net.sf.implessdao.DefaultRSIteratableFactoryのインスタンスを返すように実装されており、 DefaultRSIteratableFactoryは、カラム名をキーとしたMapにレコードの値を格納するnet.sf.implessdao.DefaultRSIteratableを 生成します。また、DefaultRSIteratableFactoryは、ResultSetからレコードの値を取り出すのにnet.sf.implessdao.DefaultDBAccessMapperを使用します。 DefaultDBAccessMapperは、ResultSetのメタデータから取得したカラムの型等の情報を元に、値を取り出します。

ImplessDAOのいくつかのクラスの背後には、関連するJDBCのオブジェクトが存在します。リソースの開放やエラーの解析を行うには、 時としてその関連を理解することが重要となります。

AbstractDAOは、Connectionを提供するためのメソッドprepareConnection()を提供しています。 これを利用して、JDBCを直接操作するメソッドを定義することもできます。また、明示的なcommitを行うためのメソッドを次のように定義することもできます。

	public void commit() throws SQLException {
		prepareConnection().commit();
	}