JBoss Seamの導入

バイジェクション（bijection）とは何か

Seamの文書では、「バイジェクション（bijection）」という用語を目にすることがあります。この用語は、SeamコンポーネントとSeam管理コンテキスト間のインジェクションとアウトジェクションの双方向の注入を表しています。

personフィールドにはすでにインジェクションを通じてフォームデータが含まれているため、sayHello()メソッドは単にJPA EntityManagerを通じてそれをデータベースに保存し、@PersistenceContextアノテーションを通じてインジェクトされる。その後、fansおよびpersonオブジェクトを更新し、これらはメソッドの終了後にアウトジェクトされる。The sayHello()は、呼出し後に現在のJSFページが最新のモデルデータで再表示されることを示すためにnullを返す。

  @PersistenceContext
  private EntityManager em;

  public String sayHello () {
    em.persist (person);
    person = new Person ();
    fans = em.createQuery("select p from Person p")
          .getResultList();

    return null;
  }

1つだけささいなことを除けば、ほぼ終了だ。おそらくお気付きのとおり、ManagerActionのBeanクラスはManagerインターフェイスを実装する。EJB3のセッションBeanの仕様に準拠するために、Bean内のビジネスメソッドすべてをリストするインターフェイスが必要である。下記はManagerインターフェイスのコードだ。幸い、最近のIDEツールからはこのインターフェイスを簡単に自動生成できる。

@Local
public interface Manager {
  public String sayHello ();
}

Hello Worldの例に必要なコードはこれですべてだ。次の2つのセクションでは、別の作業方法とSeamアプリケーションの設定について取り上げる。すぐコードに取り掛かり、独自の小さいデータベースアプリケーション用にhelloworldプロジェクトをカスタマイズしたい場合は、この章の残りの部分を省略して構わない。

4. Seamプログラミングモデルをよりよく理解する

Hello Worldサンプルアプリケーションを急いで説明してきたが、別の作業方法や上記のコードで扱っていない重要な機能など、いくつかの重要なトピックを省略している。このセクションでは、それらのトピックについて説明する。Seamをより深く理解するのに役立つが、待ちきれない場合はこのセクションを飛ばして後回しにしてもよい。

4.1. Seam POJOコンポーネント

上記の例では、EJB3セッションBeanを使用してアプリケーションロジックを実装したが、SeamではEJB3コンポーネントの使用に限定されない。実際、Seamでは、@Nameアノテーション付きのPOJOを管理コンポーネントに変えることができる。

たとえば、ManagerActionをEJB3セッションBeanではなくPOJOにすることができる。

@Name("manager")
public class ManagerAction {

  @In (create=true)
  private EntityManager em;

  ... ...
} 

EJB3 Beanの代わりにPOJOを使用することには良い点と悪い点がある。POJOは、EJB3固有のアノテーションとインターフェイスを必要としないため、若干簡単にプログラムできる（上記を参照）。すべてのビジネスコンポーネントがSeam POJOの場合、EJB3アプリケーションサーバーの外部でSeamアプリケーションを実行できる（第23章「Seam Without EJB3」を参照）。

しかし、POJOは、EJB3コンテナサービスを取得できないため、EJB3コンポーネントよりも機能が少ない。非EJB3 Seam POJOで失うEJB3サービスの例として、次のことがある。

• @PersistenceContextインジェクションはもはやPOJOでは機能しない。Seam POJOでEntityManagerを取得するには、Seam設定ファイルでEntityManagerを初期化してから、Seam @In アノテーションを使用してPOJOにインジェクトする必要がある。
• POJOでは宣言的なメソッドレベルのトランザクションをサポートしない。代わりに、Web要求を受信してから応答ページがレンダリングされるまでのデータベーストランザクションの境界を定めるようにSeamを設定できる。
• Seam POJOはメッセージ駆動型コンポーネントになることはできない。
• @Asynchronousメソッドをサポートしない。
• コンテナ管理セキュリティをサポートしない。
• トランザクションまたはコンポーネントレベルの永続コンテキストはない。Seam POJOでの永続コンテキストはすべて、「拡張」である（詳細については、セクション7.1「The Default Conversation Scope」を参照）。
• コンテナの管理アーキテクチャ（すなわち、JMXコンソールサービス）への統合はない。
• Seam POJO メソッドへのJavaリモートメソッド呼び出し（RMI）はない。
• Seam POJOは@WebService cコンポーネントになることはできない。
• JCA統合はない。

では、EJB3コンテナに配備するとき、なぜ誰もがPOJOコンポーネントを使用したがるのか? POJOコンポーネントは、純粋な「ビジネスロジック」コンポーネントに適しており、データアクセス、メッセージング、およびその他のインフラストラクチャの機能性を他のコンポーネントに委託する。たとえば、Seamデータアクセスオブジェクトを管理するのにPOJOコンポーネントを使用できる。「ビジネスロジック」POJOは、必要に応じて他のフレームワークで再使用できるため、便利だ。しかし全体として見れば、それらのアプリケーションは、特に小型から中型のアプリケーションでは、EJB3コンポーネントよりもはるかに小さい。そのため、本書のほとんどの例で、EJB3コンポーネントを使用している。

4.2. テストの容易さ

第1章「Seamとは何か」で述べたように、Seamは容易かつコンテナ外でテストできるように土台から設計されている。helloworldプロジェクトでは、testフォルダにユニットテストとJSF統合テストの2つのテストケースを含めた。Seamテスト基盤は、普通のJava SE環境におけるデータベース、JSF、Seamコンテキスト、および他のアプリケーションサーバーサービスをまねる。これらのテストを実行するには、単にantテストを実行する。

4.3. Getter / Setterベースのバイジェクション

Hello Worldの例では、フィールド変数に対するSeamコンポーネントのバイジェクト（biject）方法を説明した。getterおよびsetterメソッドに対してコンポーネントをバイジェクトすることもできる。たとえば、次のコードがうまく機能する。

private Person person;
private List  fans;

@In
public void setPerson (Person person) {
  this.person = person;
}
@Out
public Person getPerson () {
  return person;
}
@Out
public List  getFans () {
  return fans;
}

上記のgetter / setterメソッドはささいなことだが、getter / setterメソッドが通じたバイジェクションの真の価値は、カスタムロジックを追加してバイジェクションプロセスを操作できることだ。たとえば、インジェクトされたオブジェクトの有効性を確認することや、アウトジェクトされたオブジェクトをデータベースからオンザフライで取り出すことができる。

4.4. 過度のバイジェクションの回避

Dependency Bijectionは非常に便利な設計パターンだ。しかし、他の設計パターンと同様に、過度に使用することの危険性が常にある。Dependency Bijectionを使いすぎると、開発者は各コンポーネントがどこからインジェクトされたかを心の中で把握する必要があるため、コードが読みづらくなることがある。また、バイジェクションはランタイム時に発生するため、パフォーマンスのオーバーヘッドが増える可能性がある。

Hello Worldの例では、バイジェクションを減らし、排除もできる簡単な方法がある。単に、ビジネスコンポーネントのデータコンポーネントプロパティを作成するだけだ。このようにして、JSFページでは、ビジネスコンポーネントを参照することのみ必要で、ビジネスおよびデータコンポーネントを結びつけるためにバイジェクションは必要ない。たとえば、ManagerActionクラスを次のように変更できる。

@Stateless
@Name("manager")
public class ManagerAction implements Manager {

  private Person person;
  public Person getPerson () {return person;}
  public void setPerson (Person person) {
    this.person = person;
  }

  private List  fans;
  public List getFans () {return fans;}

...  ...
}

次に、Webページ上で、次のようにプロパティを参照する。

<h:form>

Please enter your name:<br/>

<h:inputText value="#{manager.person.name}"/>
<br/>
<h:commandButton type="submit" value="Say Hello"
                 action="#{manager.sayHello}"/>
</h:form>

... ...

<h:dataTable value="#{manager.fans}" var="fan">
  <h:column>
    <h:outputText value="#{fan.name}"/>
  </h:column>
</h:dataTable>

結論を言えば、Seamは依存性の管理に関して用途が広い。一般に、データコンポーネントとそのデータアクセスビジネスコンポーネントをカプセル化するとよい。特にステートフルなビジネスコンポーネントではそうだ。

4.5. JSFでのページナビゲーション

この例では、1ページのアプリケーションを使用している。各ボタンのクリック後、JSFは更新されたデータモデル値を持つページを再レンダリングする。当然、ほとんどのWebアプリケーションは複数のページを持つ。JSFでは、UIイベントハンドラメソッドがナビゲーション規則の文字列名を返すことで、次にどのページを表示するかを決定できる。たとえば、navigation.xmlファイルに次のナビゲーション規則を定義できる。

<navigation-case>
  <from-outcome>anotherPage</from-outcome>
  <to-view-id>/anotherPage.jsp</to-view-id>
</navigation-case>

その後、sayHello()メソッドが「anotherPage」の文字列値を返す場合、JSFは次にanotherPage.jspページを表示する。これにより、UIイベントハンドラメソッド内から次にどのページを表示するかをプログラム制御できる。

4.6. EntityManagerを通じたデータベースアクセス

JPA (Java Persistence API、別名EJB3 Entity Bean Persistence）EntityManager は、関係データベーステーブルとエンティティBeanオブジェクト間のマッピングを管理する。EntityManagerはランタイム時にアプリケーションサーバーによって作成される。@PersistenceContextアノテーションを使用して、EntityManagerインスタンスをインジェクトできる。

EntityManager.persist()メソッドは、エンティティBeanオブジェクトを、マッピングされた関係テーブル内に行として保存する。EntityManager.query()メソッドは、SQLライクなクエリーを実行して、エンティティBeanオブジェクトの集合の形式でデータベースからデータを取り出す。EntityManagerとクエリー言語の使用方法に関する詳細については、JPAのマニュアルを参照のこと。本書では、最も単純なクエリーのみを使用している。

デフォルトで、EntityManager はデータを埋め込みHSQLデータベースに保存する。ローカルマシン上のJBoss ASでアプリケーションを実行している場合は、次の手順によってHSQLデータベースのGUIコンソールを開くことができる。http://localhost:8080/jmx-console/ ページに進み、database=localDB,service=Hypersonic MBean をクリックし、次にstartDatabaseManagerメソッド下の[invoke]ボタンをクリックする。コンソールからデータベースに対して任意のSQLコマンドを実行できる。

5. 設定およびパッケージング

次に、設定ファイルとアプリケーションのパッケージングの説明に移る。Seam Genコマンドラインユーティリティを使用して、実際にほぼすべての設定ファイルを生成してスクリプトを構築できる。または、単にサンプルアプリケーションのソースプロジェクト内にあるものを再使用できる。したがって、最初にSeamプログラミング技術を学び、後で設定/配備について考えたい場合は、それでもよい。このセクションを安全に飛ばして、必要に応じて後で戻ってくればよい。

このセクションでは、Seam EJB3コンポーネント設定に焦点を当てる。JBoss AS外でのSeam POJO設定と配備も、もちろん可能だ。

ほとんどのSeam設定ファイルはXMLファイルである。しかし待って! SeamはJ2EEとSpringで「XML hell（XML地獄）」から救ってくれることを約束しなかったか? なぜXMLファイルもあるのか? 結局のところ、XMLファイルには優れた用途がいくつかある! XMLファイルは、コードの変更や再コンパイルなしに配備時間を変更することを可能にするため、配備時間の設定に非常に適している（WebアプリケーションのルートURLやバックエンドデータベースの場所など）。また、アプリケーションサーバー内のさまざまなサブシステムを張り合わせるためにも適している（JSFコンポーネントとSeam EJB3コンポーネントとの対話方法を設定するためなど)。さらに、XMLファイルはプレゼンテーション関連のコンテンツ（たとえば、Webページやページナビゲーションフロー)にも適している。

我々が反対するのは、Javaソースコードにすでに存在する情報をXMLファイルに複製することだ。すぐに分かるとおり、この単純なSeamアプリケーションにはいくつかのXML設定ファイルがある。それらはすべて非常に短く、いずれもJavaコードですでに利用可能な情報に関係しない。言い換えると、Seamには「XMLコード」は存在しない。

さらに、これらのXMLファイル内のほとんどのコンテンツはかなり静的である。そのため、独自のSeamアプリケーションにこれらのファイルを容易に再使用できる。独自のアプリケーションにテンプレートとしてサンプルアプリケーションを使用する方法については、付録B「Use Example Applications as Templates」を参照のこと。

次の数ページを使用して、サンプルアプリケーションの設定ファイルとパッケージング構造の詳細を述べる。アプリケーションテンプレートに満足であり、待ちきれない場合は、この説明を飛ばしても構わない。とにかく、難しい話は抜きにして、hello worldサンプルアプリケーションの設定およびパッケージング方法を見てみよう。JBoss AS用の配備可能なSeamアプリケーションを構築するには、上記のすべてのJavaクラスと設定ファイルをEnterprise Application aRchive（EAR）ファイルにパッケージングする必要がある。この例では、EARファイルはhelloworld.earである。これには、3つのJARファイルと2つのXML設定ファイルが含まれる。

helloworld.ear
|+ app.war        // Contains web pages etc.
|+ app.jar        // Contains Seam components
|+ jboss-seam.jar // The Seam library
|+ META-INF
   |+ application.xml
   |+ jboss-app.xml  

ソースコードのディレクトリ

ソースコードプロジェクトで、resources/WEB-INFディレクトリにはapp.war/WEB-INFに入る設定ファイルが含まれます。resources/META-INFディレクトリにはapp.jar/META-INFおよびhelloworld.ear/META-INFに入る設定ファイルが含まれます。resourcesディレクトリルートにはapp.jarのルートディレクトリに入るファイルがあります。

application.xmlファイルは、EAR内のJARファイルをリストし、このアプリケーション用のルートURLを指定する。

<application>
  <display-name>Seam Hello World</display-name>

  <module>
    <web>
      <web-uri>app.war</web-uri>
      <context-root>/helloworld</context-root>
    </web>
  </module>

  <module>
    <ejb>app.jar</ejb>
  </module>

  <module>
    <java>jboss-seam.jar</java>
  </module>

</application>

jboss-app.xmlファイルは、このアプリケーション用のクラスローダを指定する。各EARアプリケーションはクラスローダに固有の文字列名を持つ必要がある。ここでは、重複を避けるため、クラスローダ名にアプリケーション名を使用する。

<jboss-app>
  <loader-repository>
    helloworld:archive=helloworld.ear
  </loader-repository>
</jboss-app> 

5.1. WARファイル

app.warファイルは、Web Application aRchive（WAR）仕様にパッケージングされたJARファイルである。これには、Webページと標準のJSF / Seam設定ファイルが含まれる。また、WEB-INF/lib ディレクトリにJSF固有のライブラリファイルを置くこともできる(jboss-seam-ui.jarなど)。

app.war
|+ hello.jsp
|+ index.html
|+ WEB-INF
   |+ web.xml
   |+ faces-config.xml
   |+ components.xml
   |+ navigation.xml

web.xmlファイルは、すべてのJava EE Webアプリケーションに必要とされる。このファイルを使用して、JSFはJSFコントローラサーブレットを設定し、SeamはすべてのWeb要求をインターセプトする。このファイル内の設定はかなり標準的である。

<web-app version="2.4"
    xmlns="http://java.sun.com/xml/ns/j2ee"
    xmlns:xsi="..."
    xsi:schemaLocation="...">

  <!-- Seam -->
  <listener>
    <listener-class>
      org.jboss.seam.servlet.SeamListener
    </listener-class>
  </listener>

  <!-- MyFaces -->
  <listener>
    <listener-class>
org.apache.myfaces.webapp.StartupServletContextListener
    </listener-class>
  </listener>

  <context-param>
    <param-name>
      javax.faces.STATE_SAVING_METHOD
    </param-name>
    <param-value>client</param-value>
  </context-param>

  <servlet>
    <servlet-name>Faces Servlet</servlet-name>
    <servlet-class>
      javax.faces.webapp.FacesServlet
    </servlet-class>
    <load-on-startup>1</load-on-startup>
  </servlet>

  <!-- Faces Servlet Mapping -->
  <servlet-mapping>
    <servlet-name>Faces Servlet</servlet-name>
    <url-pattern>*.seam</url-pattern>
  </servlet-mapping>
  <context-param>
    <param-name>javax.faces.CONFIG_FILES</param-name>
    <param-value>/WEB-INF/navigation.xml</param-value>
  </context-param>
</web-app>

faces-config.xmlファイルは、JSF用の標準の設定ファイルである。Seamはこれを使用して、SeamインターセプタをJSFライフサイクルに追加する。

<faces-config>

  <lifecycle>
    <phase-listener>
      org.jboss.seam.jsf.SeamPhaseListener
    </phase-listener>
  </lifecycle>

</faces-config>

navigation.xml ファイルには、複数ページのアプリケーション用のJSFページナビゲーション規則が含まれる。hello worldの例は1ページしかないため、このファイルはここでは空白の状態である。

components.xmlファイルには、Seam固有の設定オプションが含まれる。また、jndi-patternプロパティを除いて、アプリケーションにほとんど依存しない。Seamが完全なJNDI名でEJB3 Beanにアクセスするために、EARファイルのベース名を含む必要がある。

<components ...>

  <core:init
    jndi-pattern="helloworld/#{ejbName}/local"
    debug="false"/>

  <core:manager conversation-timeout="120000"/>

</components>

5.2. SeamコンポーネントJAR

app.jarファイルには、すべてのEJB3 Beanクラス（エンティティBeansとセッションBeanの両方）、およびEJB3関連の設定ファイルが含まれる。

app.jar
|+ Person.class        // entity bean
|+ Manager.class       // session bean interface
|+ ManagerAction.class // session bean
|+ seam.properties     // empty file but needed
|+ META-INF
   |+ ejb-jar.xml
   |+ persistence.xml

seam.propertiesファイルは、ここでは空白だが、JBossにおいて、このJARファイルにSeam EJB3 Beanクラスが含まれていることを把握し、それに応じてアノテーションを処理するために必要である。

ejb-jar.xmlファイルには、EJB3 Beanでアノテーションをオーバーライドまたは補完できる追加の設定が含まれる。Seamアプリケーションでは、このファイルはSeamインターセプタをすべてのEJB3クラスに追加する。すべてのSeamアプリケーションに同一のファイルを再使用できる。

<ejb-jar>
  <assembly-descriptor>
    <interceptor-binding>
      <ejb-name>*</ejb-name>
      <interceptor-class>
        org.jboss.seam.ejb.SeamInterceptor
      </interceptor-class>
    </interceptor-binding>
  </assembly-descriptor>
</ejb-jar>

persistence.xmlファイルは、EJB3エンティティBeanのバックエンドデータベースのソースを設定する。この例では、JBoss AS内に埋め込まれたデフォルトのHSQLデータベース（つまり、java:/DefaultDS データソース）を使用する。

<persistence>
  <persistence-unit name="helloworld">
    <provider>
      org.hibernate.ejb.HibernatePersistence
    </provider>
    <jta-data-source>java:/DefaultDS</jta-data-source>
    <properties>
      <property name="hibernate.dialect"
          value="org.hibernate.dialect.HSQLDialect"/>
      <property name="hibernate.hbm2ddl.auto"
          value="create-drop"/>
      <property name="hibernate.show_sql" value="true"/>
    </properties>
  </persistence-unit>
</persistence>

6. どうしてこれが単純なのか?

hello worldアプリケーションはこれで終わりだ。3つの単純なJavaクラス、JSFページ、および大部分はスタティックな一連の設定ファイルで、完全なデータベース駆動型Webアプリケーションが実現する。アプリケーション全体で、30行未満のJavaコードしか必要でなく、「XMLコード」は存在しない。しかしそれでもPHP出身者は次のように問いかけるかもしれない。「どうしてこれが単純なのか? 私はPHPでより少ないコードでアプリケーションを開発できる!」

その答えは、Seamアプリケーションは概念的にPHP（またはその他のスクリプト言語）アプリケーションよりもはるかに単純だということだ。Seamコンポーネントモデルにより、制御された保守可能な方法でより多くの機能性をアプリケーションに追加できる。すぐに分かるように、Seamコンポーネントは、ステートフルでトランザクショナルなWebアプリケーションの開発をスムーズに進ませる。オブジェクト関連マッピングフレームワーク（すなわち、エンティティBean）では、データベース固有のSQLステートメントを処理する必要なく、抽象的なデータモデルに焦点を当てることができる。

この記事は、第1章と第2章からの抜粋に基づいている。本書の残りの部分では、Seamコンポーネントを使用してますます複雑なSeamアプリケーションを開発する方法について説明する。本書の全トピックを示している目次(PDF・英語)も参照のこと。

Seamに関する以前のニュース記事から、Seam作成者であるGavin King氏との2つのインタビュー記事も参照できる。

• JBoss Seam 1.1 Indepth: An Interview with Gavin King (source)
• JBoss Seam 1.0: rethinking web application architecture (source)

著者について

Michael Yuan博士は、次世代Webアプリケーションフレームワークに関する本『JBoss Seam: Simplicity and Power Beyond Java EE 5.0』(source)の著者である。また、『Nokia Smartphone Hacks』(source)とその他3冊の技術本の著者でもある。Michael氏は、軽量のエンタープライズ/Webアプリケーション、およびエンドツーエンドのモバイルアプリケーション開発を専門としている。Michael氏のブログ(source)を通じて連絡をとることが可能である。