PR

CDIプログラミングの基本(その1)

2011年3月10日(木)
皆本 房幸

サンプルプログラムの構造

JSF画面の構造

最初に、translatorプログラムをもとにJSFとEJBの連携方法について見ていきましょう。CDIでは、JSFからEJBやPOJOなどのBeanにアクセスするには、EL式(Expression Language)内でBeanの名前を指定します。

translatorサンプルはJSFの画面から、翻訳を行うEJBを呼び出すという単純な構成になっています。JSFの画面のソース (home.xhtml) の中からEJBを呼び出しているのは、以下の3行です。

(1)は翻訳対象となるテキスト入力部分になります。ここでvalueの値として#{translator.text}と書いてありますが、これはtranslatorという名前のBean(以後、translator Beanと略)のtextというプロパティに入力値を設定するという意味になります。

(2)は翻訳結果出力部分です。ここでのvalueの値は#{translator.translatedText}となっており、これはtranslator BeanのtranslatedTextプロパティを出力するということです。

(3)は"Translate"ボタンです。actionの値として#{translator.translate}が指定されています。これはtranslator Beanのtranslateメソッドを実行します。

EJBの構造

翻訳を行うEJB (TranslatorControllerBean)の本体のソースは、図3のような定義になっています。

図3:CDIのBean定義

このTranslatorControllerBeanはクラス定義に3つのアノテーションが付いています。

  • @StatefulはEJB3のアノテーションで、これがステートフルセッションBeanであることを示しています。
  • @RequestScopedはCDIのアノテーションで、このBeanのスコープがRequestスコープであることを示しています。
  • @Named("translator")はCDIのアノテーションで、JSFからEL式でアクセスするときのBeanの名前が"translator"であることを示しています。

JSF画面のEL式からTranslatorControllerBeanのプロパティとしてアクセスしていたtextやtranslatedTextについては、クラスにsetter、getterメソッドを定義しておきます。

CDIスコープの動作

translatorのサンプルを見ればわかるように、CDIを使うとJSFとEJBの連携はとても簡単です。あらかじめEJBに@Namedで名前を付けておけば、JSFのEL式経由でEJBのプロパティやメソッドにアクセスできるようになります。JSFの画面開発者はEJBの作成方法等の詳細については知る必要がありません。

前回の記事でご紹介したように、CDIではEJBのインスタンスのライフサイクル(生成、削除)をスコープによって制御することができます。translator BeanではスコープがRequestなので、このEJBはJSFのリクエストが発行される度に生成され、リクエストが完了すると自動的に削除されます。このライフサイクル管理の自動化によって、クライアントがEJBの実装を意識する必要がなくなり、JSF画面とEJBとの間で疎結合連携が可能になったのです。

このライフサイクルの動作を確認するために、TranslatorControllerBeanのクラス定義に図4のメソッドを追加し、標準出力にログを出力します。

図4:ログ出力用メソッドの追加(赤字の部分)

これらはBeanインスタンスが生成されるときに@PostConstructメソッドが、削除されるときに@PreDestroyメソッドが呼び出されるようになっています。さらに、"Translate"ボタンが押されたときにもログを書くようにしましょう。このような状態でJBossASのログに出力されたものが以下になります。

これらのログは"Translate"ボタンを押す度に出力されますので、RequestスコープでBeanの生成・削除が実行されていることが確認できます。

CDIのインジェクション

CDIのDI (Dependency Injection)の部分は、依存注入する変数をアノテーションで示します。図3では、TranslatorControllerBeanの中で、TextTranslatorをインジェクションしているところがありますので以下に抜粋します。

この@Injectは、インジェクションポイントを示すCDIのアノテーションです。この変数translatorにTextTranslator型のBeanインスタンスが注入されます。インジェクションが起こるタイミングは、このTranslatorControllerBeanが生成されるときです。ここで、TranslatorControllerBeanにログのメソッドを追加したのと同様に、TextTranslatorについてもログ出力メソッドを追加してみると、以下のようなログ出力を得ることができます。

今回のtranslatorのサンプルでは、JSFとEJBの連携、Beanスコープによるライフサイクル管理、インジェクションをご紹介しました。JSF上でUIボタンを押す度、実行時にBeanインスタンスが作成され、インジェクションが起動されるというCDIの動きをご理解いただけたでしょうか。

translatorのサンプルではRequestスコープを使っていたので、複数のリクエストが同じBeanのインスタンスにアクセスするということはありませんでした。しかし、スコープをSessionスコープやApplicationスコープのようなより広いスコープに変更することで複数のリクエストをまたがって同じBeanのインスタンスを共有できるようになります。

このように、CDIのスコープは、Beanインスタンスのライフサイクルだけではなく、Beanインスタンス(つまり、システムの状態)をクライアント間で共有できる範囲も決定します。CDIはシステムの状態が動的に変化し続けることを前提に設計されており、その状態変化を積極的に管理するのです。

次回もCDIの基本について引き続きご紹介します。

レッドハット株式会社

JBoss コンサルタント。日本 JBoss ユーザ・グループ(www.jbug.jp)発起人、翻訳プロジェクトリーダ。 著書『JBoss入門』『JBoss徹底活用ガイド』(共著)他。

連載バックナンバー

Think IT会員サービス無料登録受付中

Think ITでは、より付加価値の高いコンテンツを会員サービスとして提供しています。会員登録を済ませてThink ITのWebサイトにログインすることでさまざまな限定特典を入手できるようになります。

Think IT会員サービスの概要とメリットをチェック

他にもこの記事が読まれています