初めに
この章のテーマは、「より使いやすいデータベースにするにはどうしたらよいか」となります。そのためには、デフォルトのままではどのようになるのか、それではどのような問題があるのか、どのようになると使いよいのか、そして具体的にはどのような方法で実現するのかを検討していくことになります。
ライブラリの作成
結論を書けば、ブラウザ用の画面を構築するための仕様である JSF 用と、データベースを操作するための仕様である JPA 用の、より高機能にラップしたクラスからなるライブラリを作ることになります。 ここ にある JavaLibrary_for_JSF_JPA.jar がそれになります。
全体のモデル図を以下に示します。
ライブラリの全体像
最初の問題は必須クラスである EntityManagerFactory と UserTransaction クラスのインスタンスをどのクラスに持たせるか？これは簡単に答えがでました。ブラウザに返す画面構成は JSF に従った xhtml ファイルに記述します。その画面構成に必要なデータそのものは、Java のクラスである管理Bean が持つことになります。そこですべての管理Bean の親クラスとなるクラスを定義して、そのクラスの所有とします。個々の画面毎の管理Bean クラスはその親クラスから派生して作成することになります。
次の問題は、データベースに関係する機能をどのように設計するか？これはやや難しい問題と思います。これは、以下の２種類のクラス／インターフェースを組み合わせることで解決することにしました。
まずはインターフェース。データベースの操作を抽象化した３つのインターフェースを定義します。
| インターフェース名 | 説明 |
|---|---|
| Unique | プライマリーキーを指定して検索し、１エンティティクラスのインスタンスを返すためのインターフェース |
| Findable | 条件を指定して検索し、複数のエンティティクラスのインスタンスを返すためのインターフェース |
| Executable | 追加・変更・削除の処理を１トランザクションとして実行するためのインターフェース |
Unique インターフェースと Findable インターフェースはデータ検索用のインターフェースで、Executable インターフェースは更新系の処理を行うためのインターフェースとなります。
次はクラス。原則として、各テーブルごとにクラスを定義して、上記の３つのインターフェースの実体を定義するものになります。ここら辺は、以下の章の実装を見ていただいた方が分かりやすいでしょう。
管理 Bean の構成
すべての管理Bean の親となるクラスを定義します。名前は BaseBean としました。まずはソース（部分）をご覧ください。実際に試す場合には、JDK のライブラリと Java EE 7 のライブラリを参照する操作をしてください。その上で、必要なクラスを import してください。NetBeans を使用していれば、import の作業はほぼ自動的に対応してくれます。ソースには、このクラス自体が含まれる package や、使用している import は省いてあります。package はご希望に合わせてどうぞ。
abstract public class BaseBean {
@PersistenceUnit
protected EntityManagerFactory emf;
@Resource
protected UserTransaction utx;
/**
* Creates a new instance of BaseBean
*/
public BaseBean() { }
}
「{」「}」の書式は私の好みです。クラス定義の「abstract」は必ず派生クラスを定義する必要を明示したものです。「@PersistenceUnit」「@Resource」は CDI の機能になります。データベースに関連する部分はプログラマの管理下に置きたいけれども、 Web サーバで自動化できる部分はその恩恵を得たいためです。２つのクラスのインスタンスは BaseBean のインスタンス変数としています。どちらのインスタンス生成も Web サーバに任せています。アクセス修飾子はどちらも「protected」としています。これも私の設計上の好みです。派生クラスから直接操作する必要が高いインスタンス変数であると判断した場合に protected とし、公開メソッドをわざわざ用意しないというのが好きです。protected ですので、派生クラスからは変数名で直接操作できます。それくらいは、子供のクラスを信用してあげようということ。なにもしないコンストラクタを用意してあります。
１件のデータを検索するメソッドのソース（部分）は以下になります。
public Object select(Unique obj)
{
Object item = null;
EntityManager em = null;
try
{
em = emf.createEntityManager();
item = obj.select(em);
}
catch (Exception ex)
{
errorOccurred(ex);
}
finally
{
if (em != null)
em.close();
}
return item;
}
プライマリキーによる検索処理の実装はデータベースのテーブルに対応したクラスで行います。そのクラスは、次の章のテーマになります。 BaseBean クラスは実際の検索処理の内容は知りません。しかしテーブルクラスが作成したオブジェクトを使って、１件の検索処理を起動し、エラーが発生した場合の対処方法を一元化しています。
Unique インターフェースを実装したオブジェクトを引数にもらい、検索結果のオブジェクトを返します。実際にはエンティティクラスのインスタンスを返すことになります。処理の詳細説明は、 EntityManagerFactory から EntityManager のインスタンスを作ります。その後、引数のオブジェクトに対して select メソッドを呼び出します。問題はエラーが発生した時の処理になります。errorOccurred メソッドを呼び出しています。必要に応じて派生クラスでこのメソッドをオーバーライドして再定義することを想定しています。
複数のデータを検索するメソッドのソース（部分）は以下になります。
public List select(Findable obj)
{
List list = new ArrayList();
EntityManager em = null;
try
{
em = emf.createEntityManager();
list = obj.select(em);
}
catch (Exception ex)
{
errorOccurred(ex);
}
finally
{
if (em != null)
em.close();
}
return list;
}
構造は１件の場合と同じです。違いは、複数の検索結果を返す必要がありますから、戻り値にリストを使用することくらいです。
次はトランザクションの処理用のソース（部分）です。
@SuppressWarnings("UseSpecificCatch")
public boolean transact(List<Executable> objs)
{
boolean flag = true;
EntityManager em = null;
try
{
utx.begin();
em = emf.createEntityManager();
for (int i = 0, size = objs.size(); i < size; ++i)
objs.get(i).execute(em);
utx.commit();
}
catch(Exception ex)
{
flag = false;
try
{
utx.rollback();
} catch (Exception e) { }
errorOccurred(ex);
}
finally
{
if (em != null)
em.close();
}
return flag;
}
引数として Executable インターフェースを実装したオブジェクトのリストをもらいます。このリストの全要素が１トランザクションとして処理されます。
処理内容を見ていきましょう。トランザクションを開始します。その後、EntityManagerFactory から EntityManager を作ります。引数のリスト分だけ処理を繰り返します。エラー無く終了した場合に、コミットを呼び出します。エラーが発生した場合にロールバックを実行し、エラー処理の errorOccurred メソッドを呼び出します。
最後にエラー処理に関連したメソッドを見てみます。
public void errorOccurred(Exception ex)
{
errorOccurred(ex.getMessage());
}
public void errorOccurred(String msg)
{
errorOccurred(null, msg);
}
public void errorOccurred(String key, String msg)
{
FacesContext.getCurrentInstance().addMessage(key, new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, null));
}
public void infoOccurred(String msg)
{
infoOccurred(null, msg);
}
public void infoOccurred(String key, String msg)
{
FacesContext.getCurrentInstance().addMessage(key, new FacesMessage(FacesMessage.SEVERITY_INFO, msg, null));
}
public void warnOccurred(String msg)
{
warnOccurred(null, msg);
}
public void warnOccurred(String key, String msg)
{
FacesContext.getCurrentInstance().addMessage(key, new FacesMessage(FacesMessage.SEVERITY_WARN, msg, null));
}
７つのメソッドがありますが、易しい内容です。エラー表示用・警告表示用・情報表示用の違いがあるだけです。その違いはメソッド名で明らかでしょう。
１つだけ JSF のメッセージ処理を知らないと分からないものがあります。JSF にはメッセージの特別処理の機能があります。具体的に言えば、メッセージ表示用の２種類のタグが用意されています。メッセージを表示するさい、特定の対象を指定して表示場所を決めるもの（実際には HTML の id 属性を指定することで可能になる）と、全ての表示内容をまとめて HTML の１タグに表示するものとがあります。
２引数の errorOccurred メソッドを例にしましょう。FacesContext.getCurrentInstance() により、現在処理中の JSF オブジェクトを参照できます。そのオブジェクトに対して、addMessage メソッドで表示内容を追加できます。addMessage メソッドの第一引数は表示する HTML のタグの id 属性の値を指定します。 null を指定した場合は、全ての内容を１ケ所で表示する専用のタグを指定したことになります。第２引数はそのメッセージの属性を指定します。エラーなのか、警告なのか、ただの情報なのかで書式が変わります。
データベースクラスの構成
データベースに関連したクラスはやや複雑です。初めて見る Java プログラムの記述となるかもしれません。
まずはインターフェースのソース（部分）です。ここでは１つにまとめてありますが、Java では１インターフェース１ファイルになります。
public interface Unique {
public Object select(EntityManager em) throws Exception;
}
public interface Findable {
public List select(EntityManager em) throws Exception;
}
public interface Executable {
void execute(EntityManager tm) throws Exception;
}
それぞれ引数に EntityManager をとります。その EntityManager の機能を利用して、それぞれ１件の検索、複数の検索、データベースの更新を行うためのインターフェースです。何らかのエラーが発生した場合には、例外を投げる仕様です。
ライブラリとしてまとめてあるのは、上記の１クラス（BaseBean）と３インターフェース（Unique Findable Executable）だけです。NetBeans を使用して jar ファイルを作成します。個々の Web アプリケーションでは、作成したこの独自ライブラリを参照して利用することになります。
次に上記インターフェースを実装しているクラスを見てみましょう。これらのクラスは原則として、データベースのテーブルの数だけ用意する想定です。またビューに対応するクラスを用意することも考えられます。その場合、ビューにはプライマリキーフィールドは想定しずらいですし、追加・変更・削除も必要ないでしょうから、 Findable インターフェースだけを実装することになるでしょう。クラスとしてMajor クラスを取り上げます（部分）。
public class MajorDao {
@SuppressWarnings("Convert2Lambda")
public Unique uniqueKey(final String key)
{
return new Unique() {
@Override
public Major select(EntityManager em) throws Exception
{
return em.find(Major.class, key);
}
};
}
}
ここでは Unique インターフェースの実装だけを取り上げます。クラスの名前は MajorDao としました。「@SuppressWarnings("Convert2Lambda")」は、NetBeans の警告を表示させないための記述です。気にしなくても大丈夫。
uniqueKey メソッドがあります。このメソッドは引数を１つもち、戻り値として Unique インターフェースを実装したオブジェクトを返します。このメソッドの役割は、 Major テーブルのプライマリキーを指定して、１件の検索を実行できるオブジェクトを作成することです。大事なことは、検索結果を返すのでは ない ということです。どのようにしたら検索できるかという、その方法を知っているオブジェクトを返すことになります。実際に検索を行うのは、このメソッドが返したオブジェクトを引数として BaseBean クラスの select(Unique obj) を呼び出したときになります。
どのようにしてこの機能を実現するか？その答えは、無名内部クラスを使用することとなります。処理内容を見ましょう。処理の大枠は「return new Unique();」となっています。Unique はインターフェースであり、クラスではありません。それにも拘わらす、 new でインスタンスを作成して、そのオブジェクトを返しています。実はインターフェースに対して new とすると、コンパイラがそのインターフェースを定義したクラスを自動的に作成してくれるのです。もちろんそのクラスにはクラス名がありません。そのため”無名”クラスとなります。さらにこの無名クラスは、 MajorDao クラスの内部で定義されています。つまりは”内部”クラスです。この２つの性格を持つところから無名内部クラスとなります。
この無名内部クラスは Unique インターフェースを実装している必要があります。具体的には、「public Object select(EntityManager em) throws Exception;」を定義する必要があります。その実装を見てみましょう。まず戻り値は Object ではなく Major クラスのインスタンスとなります。この Major クラスはエンティティクラスであり、 NetBeans を使用してデータベースの Major テーブルから自動作成しました。検索処理自体は、 EntityManager のメソッド find を呼び出しているだけです。find メソッドは EntityManager が標準で提供しているメソッドです。
ここでもう一つ驚くのは、検索条件である引数 key の扱いかもしれません。この引数は uniqueKey メソッドの引数です。そして uniqueKey メソッドは検索結果を返すのではなく、検索のやり方を知っているオブジェクトを返すのが役割です。実際に検索が行われるのはいつになるかは分かりません。しかしこうやって返されたオブジェクトは、自分が生成された時の検索条件を記憶しており、処理が本当に発火した時点で正しく検索することが可能になります。ただし、オブジェクトが生成された後で引数 key が変更されないことを意味する「final」をつけなければいけません。
テーブル Major のプライマリキーは文字列型の１フィールドだけですので、 uniqueKey メソッドの引数はこの定義で問題がありません。より複雑なプライマリーキーを持つテーブルの場合は、そのように引数を変更する必要があります。
Findable の実装コード（部分）だけのせます。 EntityManager のメソッド createNamedQuery を呼び出し、その返されるオブジェクトから getResultList を呼び出しています。なほ、Major.findAll という名前を持つ検索方法は、 NetBeans から Major エンティティクラスを自動作成すると作成されます。 Major エンティティクラスのソースを確認してください。
@SuppressWarnings("Convert2Lambda")
public Findable findAll()
{
return new Findable() {
@Override
public List select(EntityManager em) throws Exception
{
return em.createNamedQuery("Major.findAll").getResultList();
}
};
}
Executable の実装コード（部分）だけのせます。説明は省略します。実装は追加・変更・削除の３メソッドが必要になります。
public Executable insert(final Major aMajor)
{
return new Executable() {
@Override
public void execute(EntityManager em) throws Exception
{
aMajor.setCDate(new Date());
em.persist(aMajor);
}
};
}
public Executable update(final Major aMajor)
{
return new Executable() {
@Override
public void execute(EntityManager em) throws Exception
{
aMajor.setMDate(new Date());
em.merge(aMajor);
}
};
}
public Executable delete(final String key)
{
return new Executable() {
@Override
public void execute(EntityManager em) throws Exception
{
Major obj = em.find(Major.class, key);
em.remove(obj);
}
};
}
テーブルを表現したクラスはすべてで３つ作りました。以下のものです。
| クラス名 | 説明 |
|---|---|
| MajorDao | 大分類テーブルを操作するためのクラス。Major エンティティの検索・追加・変更・削除のメソッドを定義 |
| MinorDao | 小分類テーブルを操作するためのクラス。Minor エンティティの検索・追加・変更・削除のメソッドを定義 |
| KnowledgeDao | 知識テーブルを操作するためのクラス。Knowledge エンティティの検索・追加・変更・削除のメソッドを定義 |
MinorDao クラスは上記内容を参考にして作成してください。さほど難しくありません。
しかし KnowledgeDao クラスにはやや変わったメソッドを実装してあります。それはこのクラスを利用する画面では、ページングが必要になるためです。利用する画面をどのように設計するかで、データベースのクラスに用意しなければならないメソッドも変わってきます。ではそのソース（部分）です。
public Unique count(final String sql)
{
return new Unique() {
@Override
public Long select(EntityManager em) throws Exception
{
return em.createQuery(sql, Long.class).getSingleResult();
}
};
}
public Findable findPage(final int offset, final int limit, final String sql) {
return new Findable() {
@Override
public List select(EntityManager em) throws Exception
{
return em.createQuery(sql, Knowledge.class).setFirstResult(offset).setMaxResults(limit).getResultList();
}
};
}
count メソッドは検索に使用する SQL 文を引数として、その検索に該当する件数を得るためのメソッドです。当然 Unique インターフェースを実装することになります。ここで返されるオブジェクトを発火させた結果は、データの総数すなわち Long 型となります。findPage メソッドは、検索に使用する SQL 文と、ページングの開始ページ番号と１ページの件数を指定して、該当するデータを検索するためのものです。こちらは、Findable インターフェースを実装することになります。
上記メソッドのヘルパ的メソッドである、検索に使用する SQL を構築するための次のメソッド（部分）も用意してあります。
public String makeSql(KnowledgeCondition cond)
{
StringBuilder buf = new StringBuilder("select k from KnowledgeView k where 1 = 1 ");
buf.append(makeWhere(cond));
buf.append(" order by k.majorID, k.minorID, k.id ");
return buf.toString();
}
public String makeCountSql(KnowledgeCondition cond)
{
StringBuilder buf = new StringBuilder("select count(k) from Knowledge k where 1 = 1 ");
buf.append(makeWhere(cond));
return buf.toString();
}
private String makeWhere(KnowledgeCondition cond)
{
StringBuilder buf = new StringBuilder();
if (!cond.getMajorId().equals("-1")) {
buf.append(" and k.majorID = '");
buf.append(cond.getMajorId());
buf.append("'");
}
if (!cond.getMinorId().equals("-1")) {
buf.append(" and k.minorID = '");
buf.append(cond.getMinorId());
buf.append("'");
}
if (cond.getTitle().length() > 0) {
buf.append(" and k.title like '%");
buf.append(cond.getTitle());
buf.append("%'");
}
if (cond.getKeyword().length() > 0) {
buf.append(" and k.keyWord like '%");
buf.append(cond.getKeyword());
buf.append("%'");
}
return buf.toString();
}
makeSql メソッドは上記の findPage メソッドで使用する SQL 文を返します。 makeCountSql メソッドは上記の count メソッドで使用する SQL 文を返します。内部で SQL 文の where 節を構築するメソッドをさらに利用しています。この３つのメソッドの引数である、KnowledgeCondition は検索条件を表現したクラスです。インスタンス変数とその変数への getter/setter メソッドをもつ単純なクラスです。
具体的な検索条件は、 こちら を見てください。大分類、小分類、タイトル、キーワードの４つの条件を自由に組み合わせて検索します。その４つの条件に対応したクラスです。
これら以外のメソッドは MajorDao クラスと同様です。学習を兼ねて作成してみてください。
