エンタープライズ JavaBeans

EJB 製品の公式ページでは、エンタープライズ JavaBeans テクノロジを「分散型の、トランザクション可能な、セキュリティー保護された、可搬性があるアプリケーションの開発をすばやく簡単に行うことができるサーバー側コンポーネントアーキテクチャー」と説明しています。EJB (エンタープライズ Bean) をプロジェクトに適用しても、このテクノロジが提供するサービスは開発者にとって透過的なままであり、EJB を使用しない場合に必要になる、大量のボイラープレートコードを追加する退屈で間違えやすい作業を取り除くことができます。EE 開発の経験が少ない場合、作成する Java Web アプリケーションでの EJB の必要性を疑問に思うかもしれません。Debu Panda 氏、Reza Rahman 氏、および Derek Lane 氏による『EJB 3 In Action』の本では、EJB テクノロジの役割を次のようにうまく言い換えています。

中規模の、比較的単純な Web アプリケーションの開発のために EJB を使用することは大げさであると多くの人が考えていますが、これは大きな誤りです。家を建設するとき、すべてを一から造るわけではありません。代わりに資材を買ったり、必要に応じて請負業者のサービスを申し込んだりもします。同様に、エンタープライズアプリケーションを一から構築することはあまり現実的ではありません。ほとんどのサーバー側アプリケーションには、変動するビジネスロジック、アプリケーション状態の管理、リレーショナルデータベースに対する情報の格納および取得、トランザクションの管理、セキュリティーの実装、非同期処理の実行、システムの統合など、多くの共通点があります。

フレームワークとして、EJB コンテナはこの種の一般的な機能をすぐに使えるサービスとして提供しており、EJB コンポーネントが車輪を再発明することなくアプリケーション内でこれらのサービスを使用できるようになっています。たとえば、Web アプリケーションでクレジットカードモジュールを構築するときに、トランザクションやセキュリティーアクセス制御の管理のために複雑で間違えやすい大量のコードを書いているとします。これは、EJB コンテナが提供する宣言型のトランザクションやセキュリティーサービスを使用すれば避けられるはずです。EJB コンポーネントが EJB コンテナへ配備されると、これらのほか数々のサービスを使用できるようになります。これにより、高品質で豊富な機能を持つアプリケーションが、想像を大きく上回るほどの速さで書けるようになります。^[1]

EJB は、プロジェクトに組み込まれたコンポーネントまたは Java クラスと考えることも、多数のエンタープライズ関連のサービスを提供するフレームワークと考えることもできます。このチュートリアルで利用するサービスのいくつかについては、『EJB 3 In Action』で次のように説明されています。

• プール: EJB プラットフォームは、EJB コンポーネントごとに、クライアントで共有されるコンポーネントインスタンスのプールを作成します。どの時点でも、プールされた各インスタンスを使用できるのは単一のクライアントだけです。インスタンスがクライアントへのサービスを終了すると、再生用にガベージコレクタによって破棄されるのではなく、再利用のためにプールに戻されます。
• スレッドの安全性: EJB は、完全に見えない方法で、すべてのコンポーネントをスレッドセーフおよび高性能にします。これは、シングルスレッドのデスクトップアプリケーションのようにサーバーコンポーネントを開発できることを意味します。コンポーネント自体がどれほど複雑であっても、EJB によって確実にスレッドセーフになります。
• トランザクション: EJB は宣言型のトランザクション管理をサポートします。宣言型のトランザクション管理では、コードの代わりに簡単な構成を使用してコンポーネントにトランザクション可能な動作を追加できます。実質的に、どのようなコンポーネントメソッドもトランザクション可能として指定できます。メソッドが正常に完了すると、EJB はトランザクションを確定して、メソッドによるデータの変更を永続的なものにします。それ以外の場合は、トランザクションがロールバックされます。コンテナ管理による EJB トランザクションについては、ユニット 9「トランザクションビジネスロジックの統合」で説明します。
• セキュリティー: EJB は、JAAS (Java Authentication and Authorization Service) API との統合をサポートしているため、アプリケーションをセキュリティーコードで複雑にする代わりに、セキュリティーを完全に外部に切り離して簡単な構成でアプリケーションをセキュリティー保護できます。^[2]ユニット 11「アプリケーションの保護」では、EJB の @RolesAllowed 注釈を示します。

Java Persistence

Java エンタープライズの文脈での「持続性」とは、Java オブジェクトに含まれるデータを自動的にリレーショナルデータベースに格納する動作を指します。JPA (Java Persistence API) は、開発者にとって透過的な方法で、アプリケーションが Java オブジェクトとリレーショナルデータベース間でデータを管理できるようにする ORM (Object-Relational Mapping: オブジェクト関係マッピング) テクノロジです。これは、データモデルをミラー化する一連の Java クラス (エンティティー) を作成および構成することで、JPA をプロジェクトに適用できることを意味します。そうすると、アプリケーションがデータベースに直接アクセスしているようにこれらのエンティティーにアクセスできます。

プロジェクトで JPA を使用すると、次のようなさまざまなメリットがあります。

• JPA には、静的および動的クエリーのための、固有の充実した SQL のようなクエリー言語があります。JPQL (Java Persistence Query Language) を使用することで、アプリケーションが異なるデータベースベンダー間の可搬性を維持できます。
• 低レベル、冗長、そして間違えやすい JDBC/SQL コードを書く作業を避けることができます。
• JPA は、データのキャッシングおよびパフォーマンスの最適化のサービスを透過的に提供します。

インデックスページ

インデックスページには、4 つの製品カテゴリのデータが必要です。現時点の設定では、インデックスページが要求されるたびに、JSTL の <sql> タグがカテゴリの詳細をデータベースに問い合わせます。この情報はほとんど変更されないため、パフォーマンスの観点からすると、アプリケーションが配備されたあとに一度だけクエリーを実行して、アプリケーションスコープ指定された属性にデータを格納する方が効果的です。このコードを ControllerServlet の init メソッドに追加することで、これを実現できます。

1. 「プロジェクト」ウィンドウで、「ソースパッケージ」>「controller」>「ControllerServlet」ノードをダブルクリックしてエディタで開きます。
2. CategoryFacade のインスタンスを宣言して、@EJB 注釈をインスタンスに適用します。

   public class ControllerServlet extends HttpServlet {
   
       @EJB
       private CategoryFacade categoryFacade;
   
       ...
   }

   @EJB 注釈は、CategoryFacade という名前の EJB で categoryFacade 変数をインスタンス化するように EJB コンテナに指示します。
3. IDE のヒントを使用して、次のインポート文を追加します。
   • javax.ejb.EJB
   • session.CategoryFacade

   Ctrl-Shift-I (Mac の場合は ⌘-Shift-I) を押すと、必要なインポートが自動的にクラスに追加されます。

4. 以下の init メソッドをクラスに追加します。Web コンテナは、その init メソッドを呼び出してサーブレットを初期化します。これは、サーブレットがロードされてからサービス要求を開始するまでの間に 1 度だけ起こります。

   public class ControllerServlet extends HttpServlet {
   
       @EJB
       private CategoryFacade categoryFacade;
   
       public void init() throws ServletException {
   
           // store category list in servlet context
           getServletContext().setAttribute("categories", categoryFacade.findAll());
       }
   
       ...
   }

   ここで、Category のすべてのレコードをデータベースに問い合わせる、ファサードクラスの findAll メソッドを適用します。そのあと、結果として得られた Category オブジェクトの List を、「categories」の文字列で参照できる属性として設定します。ServletContext に参照を置くと、その参照はアプリケーション全体のスコープで存在することになります。
   
   

   findAll メソッドのメソッド署名をすばやく判定するには、Ctrl キー (Mac の場合は ⌘) を押しながらカーソルをメソッドの上に移動します。(以下の画像は、NetBeans IDE 6.8 を使用して表示されるポップアップを示しています。)

   
   ハイパーリンクをクリックすると、メソッドに直接移動できます。
5. IDE のヒントを使用して、@Overrides 注釈を追加します。init メソッドは、HttpServlet のスーパークラスである GenericServlet によって定義されます。
   
   注釈を追加することは必須ではありませんが、これを行うと次のようないくつかの利点が得られます。
   • 本当にオーバーライドするつもりのメソッドをオーバーライドしているかどうかを確認するためのコンパイラチェックを使用できるようになります。
   • ソースコードのメソッドがオーバーライドされている状態が明確になるため、読みやすさが向上します。

   注釈の詳細については、「Java チュートリアル: 注釈」を参照してください。

6. これで、カテゴリの一覧を含むアプリケーションスコープ指定された属性を設定したので、新しく作成した属性にアクセスするようにインデックスページを変更します。
   
   「プロジェクト」ウィンドウで「Web ページ」>「index.jsp」ノードをダブルクリックして、このファイルをエディタで開きます。
7. ファイルの最上部に一覧表示されている <sql:query> 文をコメントアウト (または削除) します。エディタでコードをコメントアウトするには、コードを強調表示してから Ctrl-/ (Mac の場合は ⌘-/) を押します。
   
8. <c:forEach> の開始タグを変更して、この items 属性が、新しいアプリケーションスコープ指定された categories 属性を参照するようにします。

   <c:forEach var="category" items="${categories}">

9. プロジェクトの Web 配備記述子を開きます。Alt-Shift-O (Mac の場合は Ctrl-Shift-O) を押して、「ファイルに移動」ダイアログで「web」と入力してから「了解」をクリックします。
   
10. <resource-ref> エントリをコメントアウト (または削除) します。このエントリは、サーバーに登録されたデータソースを <sql> タグで識別するために必要でした。現時点では、JPA に依存してデータベースにアクセスしており、持続性ユニットに jdbc/affablebean データソースがすでに指定されています (上記のプロジェクトの持続性ユニットの「デザイン」ビューを参照)。
    
    <resource-ref> エントリ全体を強調表示してから Ctrl-/ (Mac の場合は ⌘-/) を押します。

    <!-- <resource-ref>
             <description>Connects to database for AffableBean application</description>
             <res-ref-name>jdbc/affablebean</res-ref-name>
             <res-type>javax.sql.DataSource</res-type>
             <res-auth>Container</res-auth>
             <res-sharing-scope>Shareable</res-sharing-scope>
         </resource-ref> -->

11. プロジェクトを実行します。「プロジェクトを実行」() ボタンをクリックします。プロジェクトのインデックスページがブラウザで開き、4 つのすべてのカテゴリ名および画像が表示されるのが確認できます。
    

カテゴリページ

カテゴリページが正しく描画されるには、次の 3 つのデータが必要です。

1. カテゴリデータ: 左の列のカテゴリボタン用
2. 選択されたカテゴリ: 選択されたカテゴリは左の列で強調表示され、選択されたカテゴリの名前は製品の表の上に表示される
3. 選択されたカテゴリの製品データ: 製品の表に表示された製品用

3 つのデータを 1 つずつ処理していきましょう。

• カテゴリデータ
• 選択されたカテゴリ
• 選択されたカテゴリの製品データ

カテゴリデータ

インデックスページのために作成した、アプリケーションスコープ指定された categories 属性をカテゴリデータ用に再利用します。

1. エディタで category.jsp を開き、ファイルの最上部に一覧表示されている JSTL の <sql> 文を (Ctrl-/、Mac の場合は ⌘-/ で) コメントアウトします。
   
2. <c:forEach> の開始タグを変更して、この items 属性が、アプリケーションスコープ指定された categories 属性を参照するようにします (上記で index.jsp に対して行なった手順と同じです)。

   <c:forEach var="category" items="${categories}">

3. プロジェクトを実行して、カテゴリページの現在の状態を調べます。「プロジェクトを実行」() ボタンをクリックします。プロジェクトのインデックスページがブラウザで開いたら、4 つのカテゴリのいずれかをクリックします。左の列にカテゴリボタンが表示され、想定したとおりに機能します。
   

選択されたカテゴリ

選択されたカテゴリを取得するために、カテゴリ ID と要求クエリー文字列が一致する Category を見つけるためにすでに作成してある categoryFacade を使用できます。

1. エディタで ControllerServlet を開きます (すでに開いている場合は、Ctrl-Tab キーを押してポップアップリストから選択します)。
2. 選択されたカテゴリを取得する機能の実装を開始します。TODO: Implement category request というコメントを見つけ、それを削除して以下の (太字の) コードを追加します。

   // if category page is requested
   if (userPath.equals("/category")) {
   
       // get categoryId from request
       String categoryId = request.getQueryString();
   
       if (categoryId != null) {
   
       }
   
   // if cart page is requested
   } else if (userPath.equals("/viewCart")) {

   要求で getQueryString() を呼び出すことで、要求されたカテゴリ ID を取得します。
   
   

   注: 左の列のカテゴリボタン内で選択されたカテゴリを判定するためのロジックは、EL 式を使用する category.jsp ですでに実装されています。これは、サーブレットで getQueryString() を呼び出すことに相当します。この EL 式は pageContext.request.queryString です。

3. if 文の中に、次のコード行を追加します。

   // get categoryId from request
   String categoryId = request.getQueryString();
   
   if (categoryId != null) {
   
       // get selected category
       selectedCategory = categoryFacade.find(Short.parseShort(categoryId));
   }

   CategoryFacade の find メソッドを使用して、要求されたカテゴリ ID に基づく Category オブジェクトを取得します。categoryId を、Category エンティティークラスの id フィールドに使用される型である Short にキャストする必要があります。
4. 左マージンにあるバッジ () をクリックしてエディタのヒントを使用し、selectedCategory を doGet メソッド内のローカル変数として宣言します。
   
   selectedCategory はこのクラスにまだインポートされていない Category 型であるため、IDE は entity.Category のインポート文をファイルの先頭に自動的に追加します。
5. 取得した Category オブジェクトを要求スコープに置くために次の行を追加します。

   // get categoryId from request
   String categoryId = request.getQueryString();
   
   if (categoryId != null) {
   
       // get selected category
       selectedCategory = categoryFacade.find(Short.parseShort(categoryId));
   
       // place selected category in request scope
       request.setAttribute("selectedCategory", selectedCategory);
   }

6. エディタで category.jsp に切り替えます (Ctrl-Tab キー を押してポップアップリストから選択します)。
7. <p id="categoryTitle"> を検索して、次のように変更します。

   <p id="categoryTitle">
       <span style="background-color: #f5eabe; padding: 7px;">${selectedCategory.name}</span>
   </p>

   現時点で、ControllerServlet から要求スコープに置いたばかりの selectedCategory 属性を使用しています。EL 式の中で「.name」を使用すると、指定された Category オブジェクトで getName メソッドが呼び出されます。
8. ブラウザに戻ってカテゴリページを再表示します。選択されたカテゴリの名前がページに表示されるようになっています。
   

選択されたカテゴリの製品データ

選択されたカテゴリのすべての製品を取得するために、Category エンティティーの getProductCollection() を使用します。まず、selectedCategory 上でこのメソッドを呼び出して、selectedCategory に関連付けられたすべての Product のコレクションを取得します。次に製品のコレクションを要求スコープ内の属性として格納し、最後にスコープ指定された属性を category.jsp ページビューから参照します。

1. ControllerServlet では、カテゴリ要求を管理する以下の文をコードに追加します。

   // if category page is requested
   if (userPath.equals("/category")) {
   
       // get categoryId from request
       String categoryId = request.getQueryString();
   
       if (categoryId != null) {
   
           // get selected category
           selectedCategory = categoryFacade.find(Short.parseShort(categoryId));
   
           // place selected category in request scope
           request.setAttribute("selectedCategory", selectedCategory);
   
           // get all products for selected category
           categoryProducts = selectedCategory.getProductCollection();
       }

   ここで getProductCollection() を呼び出すことにより、selectedCategory に関連付けられたすべての Product のコレクションを取得できます。
2. エディタのヒントを使用して、categoryProducts を doGet メソッドのローカル変数として定義します。
   
3. 要求スコープに Product のコレクションを置いて、アプリケーションのフロントエンドから取得できるようにします。

   // if category page is requested
   if (userPath.equals("/category")) {
   
       // get categoryId from request
       String categoryId = request.getQueryString();
   
       if (categoryId != null) {
   
           // get selected category
           selectedCategory = categoryFacade.find(Short.parseShort(categoryId));
   
           // place selected category in request scope
           request.setAttribute("selectedCategory", selectedCategory);
   
           // get all products for selected category
           categoryProducts = selectedCategory.getProductCollection();
   
           // place category products in request scope
           request.setAttribute("categoryProducts", categoryProducts);
       }

4. エディタで category.jsp ファイルを開き、製品の表を次のように変更します。

   <table id="productTable">
   
       <c:forEach var="product" items="${categoryProducts}" varStatus="iter">

   <c:forEach> タグは categoryProducts のコレクションを参照するようになりました。c:forEach ループはコレクションに含まれる各 Product オブジェクトに対して繰り返され、それに応じてデータを抽出するようになりました。
5. F6 (Mac の場合は fn-F6) を押してプロジェクトを実行します。ブラウザでカテゴリページに移動すると、各カテゴリですべての製品が表示されるようになっています。
   

NetBeans リソース

• Java EE および Java Web の学習
• Java EE テクノロジ入門
• Java EE 6 アプリケーション入門
• Java EE でのセキュリティー保護されたエンタープライズ Beans の構築
• EJB 3.1 を使用したエンタープライズアプリケーションの作成
• EclipseLink で JPA サポートを使用する [スクリーンキャスト]
• NetBeans IDE 6.x のビデオチュートリアルとデモ
• NetBeans Java エディタ 6.8 リファレンスカード

EJB リソース

• 製品ページ: エンタープライズ JavaBeans テクノロジ
• 仕様のダウンロード: JSR 318: EJB 3.1 最終リリース
• リファレンス実装: http://glassfish.dev.java.net/downloads/ri
• 公式フォーラム: エンタープライズテクノロジ - エンタープライズ JavaBeans
• Java EE 6 チュートリアル: パート IV - エンタープライズ Bean

JPA リソース

• 製品ページ: Java Persistence API
• 仕様のダウンロード: JSR 317: Java Persistence 2.0 最終リリース
• リファレンス実装: http://www.eclipse.org/eclipselink/downloads/ri.php
• Java EE 6 チュートリアル: パート VI - 持続性

GlassFish リソース

• GlassFish v3 ドキュメント
• Tomcat ユーザー向け GlassFish の学習
• GlassFish プロジェクト - Java Persistence の例
• Your First Cup: Java EE Platform の紹介
• リファレンス実装のダウンロード

技術記事

• EJB 3.1 の新機能
• EJB のベストプラクティス: エンティティー Bean の保護
• コア J2EE パターン - セッションファサード
• セッションファサードの規則およびパターン
• デザインパターンサンプルアプリケーション - セッションファサード
• ベストプラクティス: HttpServlet init メソッドの使用

書籍

• 『Beginning Java EE 6 with GlassFish 3』
• 『Java EE 6 with GlassFish 3 Application Server』
• 『Pro NetBeans IDE 6 Rich Client Platform Edition』
• 『Real World Java EE Patterns Rethinking Best Practices』
• 『Patterns of Enterprise Application Architecture』
• 『Domain-Driven Design: Tackling Complexity in the Heart of Software』