Struts/org.apache.struts.action.ActionMessage(エラー処理)

Struts/org.apache.struts.action.ActionMessage(メッセージ処理) で、ActionMessage?を用いたメッセージ処理についてまとめましたが、引き続きエラー処理の記述についてまとめます。

Struts1.1.xのころはActionError?というのを用いていたのですが、1.3系ではメッセージ処理と同じクラスActionMessage?系を使うことになっているようです。メッセージ処理の場合はリクエストスコープにActionMessages?を格納するときに、

saveMessages(request, messages);

としていましたが、エラーのメッセージ情報(業務エラーが起きちゃいました、とか)は

saveErrors(request, messages);

を使用します。でJSP側では

<ul>
<html:messages id="message" message="false" > <-message属性がfalse
  <li><bean:write name="message" /></li>
</html:messages>
</ul>

というようにmessage属性をfalseにするだけです。というよりもデフォルトはfalseなのでsaveMessagesしたときだけmessage属性をtrueにしなさい、というのが正確です。

ActionMessage?のセット方法やリソースファイルから取得する方法、IDによるグルーピングなど、基本的にメッセージ処理でできたことは全てエラー処理でもできるようですね。

<html:errors/> タグの仕組み †

エラー処理については<html:errors/>というエラー処理専門のタグがあります。基本的には<html:messages/>と同じなのですが、リソースファイルからエラー専用のプロパティを取得して表示を装飾する機能を持っています。これを見てみます。

先で見たサンプルのようにアクションクラスでいくつかActionMessage?を作成し、リクエストに入れておきます。

 messages.add(ActionMessages.GLOBAL_MESSAGE, new ActionMessage("メッセージ０",false));
 messages.add(ActionMessages.GLOBAL_MESSAGE, new ActionMessage("msg.message1", "メッセージ１"));
 messages.add(ActionMessages.GLOBAL_MESSAGE, new ActionMessage(
         "msg.message2", new String[] { "メッセージ２の１", "メッセージ２の２" }));
 messages.add("HogeGroup", new ActionMessage("別グループのメッセージ", false));
 saveErrors(request, messages);

JSP側では、

<html:errors/>

とだけしておきます。さらに、MessageResources?.properties には

msg.message1={0}
msg.message2=修飾もできる {0},{1}
# -- standard errors --
errors.header=<ul>
errors.prefix=<li>
errors.suffix=</li>
errors.footer=</ul>

とerrorsで始まるプロパティを設定しておきます。このプロパティは特殊なキー値となっていて、<html:errors/> がiterativeにActionMessage?を出力するときにヘッダやフッタ、各メッセージのprefix,suffixと共にhtmlを出力します。

結果的に出力結果は以下の通りです。

<ul>
  <li>メッセージ０</li>
  <li>メッセージ１</li>
  <li>修飾もできる メッセージ２の１,メッセージ２の２</li>
  <li>別グループのメッセージ</li>
</ul>

というように、始めと終わりにheader,footerを出力し、各メッセージの始めと終わりにprefix,suffixを出力しているのが分かると思います。

サンプル †

• errorMessage.jsp
• ErrorAction
• MessageResources.properties

TIPS †

特殊なキー値を変更 †

先のerrors.headerなどのプロパティ値で、別のキーを使いたい場合はerrorsタグで直接キー値を指定します。

<html:errors header="myErrors.header" footer="myErrors.footer" />

などとすると、別のキー値を指定できます。header,footer,suffix,prefix全てあるみたいですね。

関連リンク †

• Struts/org.apache.struts.action.ActionMessage(メッセージ処理)

この記事は

• ちなみにsaveErrors内ではrequest.setAttribute(Globals.ERROR_KEY, errors);ってやってますね -- きの? 2008-01-20 (日) 20:35:13

• ちなみにsaveMessages内ではrequest.setAttribute(Globals.MESSAGE_KEY, messages);ってやってますね -- きの? 2008-01-21 (月) 10:35:13

現在のアクセス:26401