お客様が developerWorks に初めてサインインすると、プロフィールが作成されます。プロフィールで選択した情報は公開されますが、いつでもその情報を編集できます。お客様の姓名（非表示設定にしていない限り）とディスプレイ・ネームは、投稿するコンテンツと一緒に表示されます。

送信されたすべての情報は安全です。

developerWorks に初めてサインインするとプロフィールが作成されますので、その際にディスプレイ・ネームを選択する必要があります。ディスプレイ・ネームは、お客様が developerWorks に投稿するコンテンツと一緒に表示されます。

ディスプレイ・ネームは、3文字から31文字の範囲で指定し、かつ developerWorks コミュニティーでユニークである必要があります。また、プライバシー上の理由でお客様の電子メール・アドレスは使用しないでください。

送信されたすべての情報は安全です。

My developerWorks：

通知：

サイン・アウト

言語を選択する：

Struts 2 による動的なデータ処理

強力で使いやすい機能を探る

Ina Arya, Senior Software Engineer, IBM

Ina は IBM India Software Lab の Software Development Workbench Team に所属するシステム・ソフトウェア技術者です。彼女は Java 技術を使用した Web アプリケーションなど、アプリケーション開発に4 年以上の経験があります。

概要： この記事では、Web ベースのアプリケーションでの動的データの処理が Apache Struts 2 によっていかに楽になるかを学びます。Struts 2 の最も一般的な使用ケースについて、サンプル・コードを示していくつか例を挙げながら説明した後、Action、Interceptor、Result などの強力な機能を使って UI フィールドにデータベースのデータを設定する方法を詳しく探ります。また、アプリケーションをモジュール化する方法として、アプリケーションが値のリストからロードする際にデータ値を設定する方法と、必要なデータをフィールドに事前に入力する方法についても学びます。

タグを付ける!

日付: 2010年 6月 15日
レベル: 初級
この記事の原文: 英語
アクティビティー： 13370 ビュー
お気軽にご意見・ご感想をお寄せください：

はじめに

Web ベースのビジネス・アプリケーションではほとんどの場合、さまざまなデータベースにデータを保存する必要があります。Struts 2 の初心者にとって、Web アプリケーションを開発する際の最大の難題は、データベースに保存されたデータをブラウザーの表示ページにどう表示するか、という点にあります。

データ処理のための最適な手段を開発するためには多くの作業が必要になります。優れたアプリケーションには適切な UI (User Interface) と適切なバックエンド実装が必要です。Struts 2 の強力さは MVC (Model-View-Controller) パターンをすっきりと実装できる点にあり、それを実現しているのが以下の機能です。

Action: Action は Struts 2 フレームワークのアーキテクチャーの一部として、すべてのビジネス・ロジックを 1 ヶ所にまとめることで、簡潔な実装を実現します。Action はリクエストから結果ページにデータを自動転送するためのチャネルとして機能します。
Result: ユーザーの要求に対するアプリケーションの応答を Web ブラウザーに表示する UI です。
Interceptor: さまざまな Action で共通に行われる操作 (妥当性検証、ロギング命令、エラー・チェックなど) を実装することで、Action のオーバーヘッドをなくし、パフォーマンスを改善します。
Interceptor は処理前と処理後の両方で呼び出されます。1 つのアクション・リクエストに対し、複数の Interceptor がある場合があります。
ValueStack: リクエストの処理中に関連付けられるデータすべてを保持するオブジェクトです。

図 1 は Struts 2 フレームワークのコンポーネントを示しています。

図 1. Struts 2 の Action、Interceptor、Result
この図には Struts 2 フレームワークのコンポーネントが表示されています。コンポーネントとしては、「Web browser (result)」、「Interceptor 1」、「Interceptor 2」、「Interceptor 3」、「Action」があり、また「Session」と「Variable 1, 2...」を含んだ「ValueStack」があります。

この図には Struts 2 フレームワークのコンポーネントが表示されています。コンポーネントとしては、「Web browser (result)」、「Interceptor 1」、「Interceptor 2」、「Interceptor 3」、「Action」があり、また「Session」と「Variable 1, 2...」を含んだ「ValueStack」があります。

この記事では、Web ベースのアプリケーションでの動的なデータ処理について学びます。さらに、実行時にユーザー・データを送信する方法をいくつかの特別な使用ケースを例に探っていきます (例えばフォームにユーザー・データの値をあらかじめ入力する場合や、リストの中にある値からデフォルト値を表示するように UI フィールドを設定する場合など)。この記事では、Struts 2 の Action クラスと結果ページとの間での動的なデータのフローに関し、その実装の詳細に焦点を絞ります。

上に戻る

Struts 2 の ValueStack を使った動的なデータ処理

Struts 2 の強力な機能の 1 つである ValueStack は、リクエストを処理する際のすべてのデータを保持します。Action クラスも Bean の形でデータを保存します (Struts 2 ではゲッター・メソッドとセッター・メソッドを使います)。Action クラスのオブジェクトにデータが保存されると、Struts 2 はそのデータを、Action オブジェクトの形式で ValueStack に格納します。ValueStack は複数のオブジェクトを格納し、このデータが Struts 2 フレームワークの他の部分に公開されます。

図 2 では、Action クラスが 2 つの変数の値をゲッター・メソッドとセッター・メソッドを使って設定しています。このデータはリクエストが処理される間に、ValueStack に保存されます。HelloWorld.jsp はこれらの変数の値を ValueStack から取得し、Struts 2 のタグ・ライブラリーの <s:property> タグを使って表示します。

図 2. ValueStack に保持されるデータ
この図には、ValueStack に保持されるデータとして、Hello World Action と HelloWorld.jsp が表示されています。

上に戻る

静的データと動的データ

UI に表示されるデータが事前にわかる場合、そのデータは静的データと呼ばれます。静的データは、JSP (JavaServer Pages) で直接コーディングすることで、容易に処理することができます。図 3 は静的データの処理を示しています。

図 3. 静的データ
この図は静的データを示しています。3 つのボックス (JSP、Action、Client browser (クライアント・ブラウザー)) があり、それぞれのボックスは反時計回りに他のボックスを矢印で指しています。

ユーザー・データベースから取得したデータをユーザーが表示しようとする場合、そのデータを Action と JSP で適切に処理して UI で表示するためのメカニズムが必要です。Struts 2 の場合、このタイプのシナリオのためのビルディング・ブロックは、Action クラスと ValueStack です。Action クラスはゲッター・メソッドとセッター・メソッドを使うことで、ユーザー値を ValueStack に格納します。すると、その値に対応する変数名の値を JSP が取得し、UI に表示します。図 4 を見てください。

図 4. 動的データ
この図は動的データを示しています。動的データとして、「Result (結果)」、「ValueStack」、「DB」、「Action」、「Client broswer Name = Swati (クライアント・ブラウザー Name = Swati)」というラベルの付いたボックスがあります。

上に戻る

ユーザー・データによって UI フィールドとタグを設定する

Struts 2 にはリッチで再利用可能な HTML にデータを表示するタグ・ライブラリーがあるため、対話型でフォーム・ベースのアプリケーションを容易に作成することができます。Struts 2 には汎用タグ (制御タグとデータ・タグ) と UI タグが用意されています。UI タグは、ValueStack のデータ (ValueStack 上にある、アクションが追加されたデータ) またはデータ・タグのデータを取得するために設計されています。以下に示すのは Struts 2 の UI タグ <select tag> の例です。

UI にデータを表示するための Action クラスを作成します (リスト 1)。

リスト 1. UI にデータを表示するための Action クラスを作成する


public class DisplayAction extends ActionSupport {
	
private List state = new ArrayList();
private List status = new ArrayList();
	
public String execute()
	{
		setState(this.state);
		setStatus(this.status);
return "success";
	}
	
	//getter and setter method for state variable//
public List getState() {
return state;
	}

public void setState(List state) {
	//implement the application specific logic to 
	retrieve the data from the 
	database here//
		
	//Here for displaying the data on UI, we are using few hardcoded values//
		state.add("Defect"); 
		state.add("Task");
		state.add("User Stories");
	}

public List getStatus() {
return status;
	}

public void setStatus(List status) {
	//implement the application specific logic to
	retrieve the data from the database here//

	//Here for displaying the data on UI, we are using few hardcoded values//
		
		status.add("New"); 
		status.add("Fixed")
		status.add("Resolved");
		status.add("Closed");
	}

}

この例では DisplayAction クラスが、ArrayList オブジェクトの state と status に値をいくつか設定しています。Action クラスはこのデータを ValueStack に格納し、JSP はそのデータを UI に表示します。

JSP 側でデータを処理するために、state と status の値を取得する <select> タグを作成する必要があります (リスト 2)。

リスト 2. state と status の値を取得する <select> タグを作成する


                        <%@ page language="java" contentType="text/html;
charset=ISO-8859-1" pageEncoding="ISO-8859-1"%>
                        <%@ taglib prefix="s" uri="/struts-tags" %>
                        
                        <html>
                        <title>Sample Display Page</title>
                        <body>
                        
                        <s:select list="%{status}" name="Status"></s:select>
                        <s:select list="%{state}" name="State"></s:select>
                        
                        </body>
                        </html>

struts.xml によるマッピングを使って Action と JSP を構成します (リスト 3)。

リスト 3. struts.xml によるマッピングを使って Action と JSP を構成する


                        <!DOCTYPE struts PUBLIC"-//Apache Software
                        Foundation//DTD Struts Configuration 2.0//EN"
                        "http://struts.apache.org/dtds/struts-2.0.dtd">
                        <struts>
                        <package name="sample.exmaple"
                        extends="struts-default">
                        <action name=”DisplayAction”   
                        class=”com.sample.example.DisplayAction”>
                        <result name=”success”>/DisplayPage.jsp
</result>
                        </action>
                        </package>
                        </struts>

上記 3 つのコード例は、以下のようになっています。

Action クラスに state と status というリスト変数があります。
state と status を arraylist 型にすることで、Action クラスにデータを追加しています。
<s:select> には、Action クラスの中で定義された名前と同じ名前を持つリスト・パラメーター (必須) があります。
これらのリスト変数を %{<list-variable>} を使って配置しています。
JSP の中のリスト変数の名前は、Action クラスの中で指定された名前と一致しなければなりません。

図 5 は出力の例を示しています。

図 5. 出力 1: Status リストの表示
このスクリーン・ショットには「Status」と「State」という 2 つのドロップダウン・ボックスが表示されています。「Status」リストは展開されており、選択可能な値は「New」、「Fixed」、「Resolved」、「Closed」です。

図 6 では、Status という <select> タグが、Action クラスに入力された値で初期化されています。

図 6. 出力 2: State リストの表示
このスクリーン・ショットには「Status」と「State」という 2 つのドロップダウン・ボックスが表示されています。「State」リストは展開されており、選択可能な値は「Defect」、「Task」、「User Stories」です。

また、State という <select> タグも、Action クラスに入力された値で初期化されています。

上に戻る

入力済みの UI フィールドにデフォルト値を設定する

ここで例えば、ユーザーが値のリストを持っているとします。ユーザーは、UI がロードされたら、リストの中にある値の 1 つをデフォルト値に設定したいと思っています。

以下の例では、ユーザーはコンボ・ボックスを持っており、UI がロードされたら最後の値を表示したいと思っています。

Action クラスを変更し、デフォルト値のコードを追加します (リスト 4)。

リスト 4. Action クラスを変更し、デフォルト値のコードを追加する


public class DisplayAction extends ActionSupport {
	
private List state = new ArrayList();
private List status = new ArrayList();
private String defaultState = "";
private String defaultStatus = "";
	
public String execute()
	{
	 //set status and state list values//
		setState(this.state);
		setStatus(this.status);

	//set default values for state and status which
     //a user wants to display on the User Interface
		setDefaultState("Task");
		setDefaultStatus("Closed");
return "success";
	}
	
	//getter and setter method//
public List getState() {
return state;
	}

public void setState(List state) {
    //implement the application specific logic to retrieve   
    //the data from the database here//

    //Here for displaying the data, we are using few     
    //hardcoded values
		state.add("Defect"); 
		state.add("Task");
		state.add("User Stories");
	}

public List getStatus() {
return status;
	}

     public void setStatus(List status) {
	//implement the application specific logic to retrieve        
     //the data from the database here//
	
     //Here for displaying the data, we are using few     
     //hardcoded values//

          status.add("New"); 
		status.add("Fixed");
		status.add("Resolved");
		status.add("Closed");
	}

public String getDefaultState() {
return defaultState;
	}

public void setDefaultState(String defaultState) {
this.defaultState = defaultState;
	}

public String getDefaultStatus() {
return defaultStatus;
	}

public void setDefaultStatus(String defaultStatus) {
this.defaultStatus = defaultStatus;
	}
}

この例では上記の Action クラスの中で、さらに 2 つのゲッター/セッター・メソッドを追加し、<select> タグの変数にデフォルト値を設定しています。

変更された JSP のコードを以下のリスト 5 に示します。

リスト 5. 変更された JSP コード


                        <%@ page language="java" contentType="text/html;
                            charset=ISO-8859-1" pageEncoding="ISO-8859-1"%>
                        <%@ taglib prefix="s" uri="/struts-tags" %>
                        
                        <html>
                        <title>Sample Display Page</title>
                        <body>
                        
                        <s:select list="%{status}" name="Status" 
                        value="%{defaultStatus}"></s:select>
                        <s:select list="%{state}" name="State" 
                        value="%{defaultState}"></s:select>
                        
                        </body>
                        </html>

この場合は struts.xml によるマッピングは先ほどと同じままです。

上記 2 つのコード例は、以下のようになっています。

Action クラスの中で、表示されるデフォルト値は 2 つのストリング変数に保存されます。
JSP の中で、これらの値は <select> タグの value パラメーターを使って処理されます。
Action クラスの中でデフォルト値を持つ変数の名前は、結果を表示する JSP の中にある名前と一致しなければなりません。

図 7 は出力の例を示しています。

図 7. 出力 1: 「Status」のデフォルト値の表示
このスクリーン・ショットには先ほどと同じ 2 つのドロップダウン・ボックスが表示されています。この場合、「Status」フィールドと「State」フィールドでは、それぞれ「Closed」と「Task」が選択されています。

図 8 では、UI がロードされた時の「Status」リストのデフォルト値として、「Closed」が設定されています。

図 8. 出力 2: 「State」のデフォルト値の表示
このスクリーン・ショットには先ほどと同じ 2 つのドロップダウン・ボックスが表示されています。この場合、「Status」フィールドと「State」フィールドでは、それぞれ「Closed」と「Task」が選択されています。

UI がロードされた時の「State」リストのデフォルト値としては、「Task」が設定されています。

上に戻る

まとめ

Struts 2 は第 2 世代の Web アプリケーション・フレームワークであり、Java サーブレットよりもよく使われるようになっています。Struts 2 は、よく使われる MVC デザイン・パターンに対応しています。Struts 2 によって一般的なタスクが自動化されるため、Action から結果ページへのマッピングを SML ベースの構成を利用して行えるようになります。Struts 2 フレームワークは Web ベースのアプリケーションの実装に関する基本部分の詳細をカバーしており、また構造的なソフトウェアを提供しています。

この記事では、完全なフレームワークとしての Struts 2 の機能について学びました。そして Struts 2 の最も一般的な使用ケースをいくつか学び、Struts 2 の強力な機能によって実現されるソリューションについて説明しました。

参考文献

学ぶために

Java Web アプリケーションを作成するための無料のオープンソース・フレームワーク、Apache Struts 2 を理解してください。
Struts 2 のドキュメントを見てください。このサイトには、入門者用資料、チュートリアル、FAQ、ガイドなどが用意されています。
ValueStack の資料を読んでください。ValueStack に複数の Bean をプッシュすることができ、また ValueStack に対して動的な EL 式を評価することができます。
Struts 2 の UI タグ参照を利用してください。Strut の UI タグによって、リッチで再利用可能な HTML にデータを表示することができます。
Struts 2 のドキュメントその他の資料を入手してください。セキュリティー報告、ウィキ、クイック・リンク、チュートリアルなどがあります。
developerWorks の Web development ゾーンには、Web ベースの多様なソリューションを網羅した記事が豊富に用意されています。
developerWorks の Technical events and webcasts で最新情報を入手してください。
developerWorks On demand demos をご覧ください。初心者のための製品インストール方法やセットアップのデモから、上級開発者のための高度な機能に至るまで、多様な話題が解説されています。