エンティティ・クラスの作成

この課題では、新規エンティティ・クラス・ウィザードを使用して単純な持続性エンティティ・クラスを作成します。また、このウィザードを使用して、このアプリケーションで使用するデータ・ソースとエンティティ・マネージャを定義する持続性ユニットも作成します。表のデータを表示するためのフィールドをクラスに1つ追加し、新規フィールド用の取得メソッドと設定メソッドを生成します。

エンティティ・クラスには主キーが必要です。ウィザードを使用してエンティティ・クラスを作成する場合、フィールドを主キーとして宣言するため、IDEではデフォルトでidフィールドが生成され、@Id注釈を使用してフィールドに注釈が付けられます。また、プライマリIDフィールドのキー生成方法を指定するための@GeneratedValueという注釈も追加されます。

プロジェクトでJava Persistenceを使用すると、持続フィールドまたはプロパティ向けのオブジェクト・リレーショナル・マッピング情報を提供するデプロイメント・ディスクリプタの構成の必要性が除去され、アプリケーション開発が大幅に簡素化されます。かわりに、注釈を使用して、これらのプロパティを単純なJavaクラス内で直接定義できます。

エンティティの持続性は、EntityManager APIによって管理されます。EntityManager APIは持続性コンテキストを処理し、各持続性コンテキストはエンティティ・インスタンスのグループです。アプリケーション開発時には、クラス内で注釈を使用して、エンティティのインスタンスからなる持続性コンテキストのインスタンスを指定できます。そうすると、エンティティのインスタンスのライフサイクルは、コンテナによって処理されます。

エンティティ・クラスを作成するには、次の手順を行います:

1. プロジェクト・ノードを右クリックし、「新規」>「その他」を選択します。
2. 「持続性」カテゴリから「エンティティ・クラス」を選択します。「次」をクリックします。
3. クラス名に「Message」と入力します。
4. パッケージに「entities」と入力します。
5. 「持続性ユニットを作成」を選択します。「次」をクリックします。
6. データ・ソースを選択します(たとえば、JavaDBを使用する場合はjdbc/sampleを選択)。

   データ・ソースjdbc/sampleは、IDEおよびGlassFishサーバーのインストール時にIDEにバンドルされますが、別のデータベースを使用する場合は他のデータ・ソースを指定することもできます。

   他のデフォルト・オプション(持続性ユニット名、EclipseLink持続性プロバイダ)はそのまま使用できます。持続性ユニットが「Java Transaction APIを使用」になっていること、およびアプリケーションデプロイ時にエンティティ・クラスに基づいた表が作成されるように「表生成の方針」が「作成」に設定されていることを確認します。

7. 新規エンティティ・クラス・ウィザードで「終了」をクリックします。

   「終了」をクリックするとエンティティ・クラスが作成され、そのクラスがエディタに表示されます。IDEによってIDフィールドprivate Long id;が作成され、フィールドに@Idおよび@GeneratedValue(strategy=GenerationType.AUTO)という注釈が付与されます。

8. エディタで、idフィールドの下にmessageフィールド(太字で表示)を追加します。

   private Long id;
   private String message;

9. エディタ内を右クリックして「コードを挿入」([Alt]-[Insert]、Macの場合は[Ctrl]-[I])を選択し、「取得メソッドおよび設定メソッド」を選択します。
10. 「取得メソッドおよび設定メソッドの生成」ダイアログ・ボックスでmessageフィールドを選択し、「生成」をクリックします。

    messageフィールドに取得メソッドと設定メソッドが生成されます。

    
11. 変更を保存します。

エンティティ・クラスは、データベース内の表を表します。このアプリケーションを実行すると、Messageのデータベース表が自動的に作成されます。この表には、id列とmessage列が含まれます。

XMLエディタで持続性ユニットを見ると、アプリケーションがJava Transaction API (JTA)(transaction-type="JTA")を使用しています。これは、持続性コンテキストでのエンティティのライフサイクルの管理義務がコンテナに割り当てられることを指定します。この結果、エンティティのライフサイクルがアプリケーションではなくコードで管理されるため、コードが少なくてすみます。JTAを使用してトランザクションを管理する方法については、Java Transaction APIのドキュメントを参照してください。

セッション・ファサードの作成

この課題では、ウィザードを使用して、Messageエンティティのステートレス・セッション・ファサードを作成します。EJB 3.1仕様で、セッションBeanのビジネス・インタフェースがオプションになったことが示されています。このアプリケーションでは、Beanにアクセスするクライアントがローカル・クライアントであるため、Beanを公開する方法として、ローカル・インタフェースを使用する方法と、インタフェースなしのビューを使用するオプションがあります。

セッションBeanを作成するには、次の手順を行います:

1. プロジェクト・ノードを右クリックし、「新規」>「その他」を選択します。
2. 「エンタープライズJavaBeans」カテゴリから「エンティティ・クラスのセッションBean」を選択します。「次」をクリックします。
3. 「Message」エンティティを選択し、「追加」をクリックします。「次」をクリックします。
4. パッケージに「boundary」と入力します。「終了」をクリックします。

   セッションBeanのビジネス・インタフェースを作成する必要はありませんでした。かわりに、このアプリケーションでは、インタフェースなしのビューを使用して、Beanがローカルの管理対象Beanに公開されます。

   

「終了」をクリックすると、IDEによってセッション・ファサード・クラスMessageFacade.javaおよびAbstractFacade.javaが作成され、エディタでこれらのファイルが開きます。生成されたコードでわかるように、ステートレス・セッションBeanコンポーネントとしてMessageFacade.javaを宣言するため、注釈@Statelessが使用されます。MessageFacade.javaは、AbstractFacade.javaを拡張したもので、ビジネス・ロジックを含み、トランザクションを管理します。

@Stateless
public class MessageFacade extends AbstractFacade<Message> {
    @PersistenceContext(unitName = "SimpleEE6AppPU")
    private EntityManager em;
            

ウィザードを使用してエンティティのファサードを作成すると、エンティティ・マネージャ・リソースをセッションBeanコンポーネントに注入し、持続性ユニットの名前を指定するため、デフォルトでPersistenceContext注釈(@PersistenceContext(unitName="SimpleEE6AppPU"))が追加されます。この例では、持続性ユニットの名前が明示的に宣言されますが、アプリケーションに持続性ユニットが1つしかない場合、この名前はオプションです。

IDEでは、エンティティを作成、編集、除去および検索するためのメソッドが、AbstractFacade.javaに生成されます。EntityManager APIでは、持続性コンテキストと連携するために使用されるメソッドが定義されます。IDEによって、エンティティ・オブジェクトの検索に使用可能な、一般的に使用されるデフォルトの問合せメソッドがいくつか生成されます。findAllメソッド、findRangeメソッドおよびcountメソッドは、問合せを作成するため、Criteria APIで定義されたメソッドを使用します。Criteria APIは、Java EE 6仕様に含まれるJPA 2.x仕様の一部です。

管理対象Beanの作成

この課題では、セッション・ファサードへのアクセスに使用される、単純なJSF管理対象Beanを作成します。JSF 2.x仕様により、Beanクラスで注釈を使用して、クラスをJSF管理対象Beanとして識別したり、スコープを指定したり、Beanの名前を指定したりすることができます。

管理対象Beanを作成するには、次の手順を実行します。

1. プロジェクト・ノードを右クリックし、「新規」>「その他」を選択します。
2. 「JavaServer Faces」カテゴリからJSF管理対象Beanを選択します。「次」をクリックします。
3. クラス名に「MessageView」と入力します。

   Beanでメソッドをコールするときに、管理対象Bean名のMessageViewを、JSFページindex.xhtmlのinputTextおよびcommandButtonの値として使用します。

4. パッケージに「my.presentation」と入力します。
5. 管理対象Beanに使用する名前に「MessageView」と入力します。

   注意:ウィザードを使用して管理対象Beanを作成すると、デフォルトでは、Beanクラスの名前に基づいて先頭を小文字にした名前がBeanに割り当てられます。このチュートリアルおよびデモでは、大文字で始まる名前をBeanに明示的に割り当てます。JSFページでこのBeanを参照するときは、messageViewではなくMessageViewを使用します。名前を明示的に割り当てなかった場合は、JSFページでデフォルトのmessageViewを使用します。

6. 「スコープ」を「リクエスト」に設定します。「終了」をクリックします。

「終了」をクリックすると、IDEはBeanクラスを作成し、そのクラスがエディタに表示されます。「プロジェクト」ウィンドウに次のファイルが表示されます。

エディタで、@ManagedBean注釈、@RequestScoped注釈およびBeanの名前が追加されたことがわかります。

@ManagedBean(name="MessageView")
@RequestScoped
public class MessageView {

    /** Creates a new instance of MessageView */
    public MessageView() {
    }

}

ここで、依存性の注入を使用してMessageFacadeセッションBeanへの参照を取得するための@EJB注釈を追加します。ファサードに公開されたfindAllメソッドとcreateメソッドもコールします。IDEのコード補完は、メソッドを入力するときに役立ちます。

1. エディタ内を右クリックして「コードを挿入」([Alt]-[Insert]、Macの場合は[Ctrl]-[I])を選択し、ポップアップ・メニューから「エンタープライズBeanをコール」を選択します。
2. 「エンタープライズBeanをコール」ダイアログ・ボックスで「MessageFacade」を選択します。「OK」をクリックします。
   

   「OK」をクリックすると、次のコード(太字で表示)が追加され、Beanが注入されます。

   public class MessageView {
   
       /** Creates a new instance of MessageView */
       public MessageView() {
       }
   
       // Injects the MessageFacade session bean using the @EJB annotation
       @EJB
       private MessageFacade messageFacade;
   }
   

3. 次のコードを追加して新しいインスタンスを作成します。

   /** Creates a new instance of MessageView */
       public MessageView() {
          this.message = new Message();
       }

4. クラスに次のコードを追加します。

       // Creates a new field
       private Message message;
   
   
       // Calls getMessage to retrieve the message
       public Message getMessage() {
          return message;
       }
   
       // Returns the total number of messages
       public int getNumberOfMessages(){
          return messageFacade.findAll().size();
       }
   
       // Saves the message and then returns the string "theend"
       public String postMessage(){
          this.messageFacade.create(message);
          return "theend";
       }
   

5. エディタ内を右クリックして「インポートを修正」([Alt]-[Shift]-[I]、Macの場合は[⌘]-[Shift]-[I])を選択し、変更内容を保存します。

エディタでコード補完を使用すると、コードの入力に役立ちます。

postMessageメソッドが文字列「theend」を返します。JSF 2.x仕様では、Faceletsテクノロジを使用するアプリケーションで暗黙ナビゲーション・ルールを使用できます。このアプリケーションは、faces-config.xmlにナビゲーション・ルールが構成されていません。かわりに、ナビゲーション・ハンドラが、アプリケーション内で適切なページを検索しようとします。この場合、ナビゲーション・ハンドラは、postMessageメソッドが呼び出されると、theend.xhtmlという名前のページを検索しようとします。

インデックス・ページの変更

この課題では、index.xhtmlページに単純な変更を加えて、いくつかのUIコンポーネントを追加します。入力テキスト・フィールドとボタンのあるフォームを追加します。

1. エディタでindex.xhtmlを開きます。
2. 次の単純なフォームを<h:body>タグの間に追加するようにファイルを変更します。

   <h:body>
       <f:view>
           <h:form>
               <h:outputLabel value="Message:"/><h:inputText value="#{MessageView.message.message}"/>
               <h:commandButton action="#{MessageView.postMessage}" value="Post Message"/>
           </h:form>
       </f:view>
   </h:body>

   JSFのコード補完は、コードを入力するときに役立ちます。

   

   注意:コードをコピーしてファイルに貼り付けると、<f:view>がある行の左マージンに警告が表示されます。この行に挿入カーソルを置いて[Alt]-[Space]を入力すると、エラーの解決方法に関するヒントを開くことができます。このヒントは、xmlns:f="http://xmlns.jcp.org/jsf/core"というライブラリ宣言を追加する必要があることを示しています。

3. 変更を保存します。

inputTextコンポーネントとcommandButtonコンポーネントが、名前付きのJSF管理対象BeanMessageViewでメソッドを呼び出します。postMessageメソッドが「theend」を返し、ナビゲーション・ハンドラがtheend.xhtmlという名前のページを検索します。

結果ページの作成

この課題では、JSFページtheend.xhtmlを作成します。このページは、ユーザーがindex.xhtmlのPost Messageボタンをクリックし、JSF管理対象BeanのpostMessageメソッドを呼び出したときに表示されます。

1. プロジェクト・ノードを右クリックし、「新規」>「その他」を選択します。
2. 「JavaServer Faces」カテゴリから「JSFページ」を選択します。「次」をクリックします。
3. ファイル名に「theend」と入力します。
4. 「Facelets」オプションが選択されていることを確認します。「終了」をクリックします。
   
5. 次のコードを<h:body> タグの間に入力してファイルを変更します。

   <h:body>
       <h:outputLabel value="Thanks! There are "/>
       <h:outputText value="#{MessageView.numberOfMessages}"/>
       <h:outputLabel value=" messages!"/>
   </h:body>

入力を始めると、xmlns:h="http://xmlns.jcp.org/jsf/html"タグ・ライブラリ定義がJSF要素のファイルに自動的に追加されます。