メッセージのローカライズ方法
これまでのサンプルでは、表示するメッセージはすべてプログラムコードに直接記述してきました。しかし、Webアプリケーションを多言語に対応させることを考えた場合、このようなハードコーディングは望ましいものではありません。また、たとえ日本語にしか対応しない場合でも、メッセージをソースに埋め込むと、後々の修正が大変です。
ここでは、プログラムコードとは別のファイルで、メッセージを一元的に管理する方法を解説することにしましょう。
自動生成されるエラーメッセージ
前回と今回解説したバリデーションは、すべてエラーメッセージは任意に設定できました。ところが、Struts 2のエラーメッセージの中には、デフォルトで自動的にその内容を生成されてしまうものがあります。例えば、メンバ変数の変換エラーの場合がそれにあたります。次の図は、今回作成した入力フォームの年齢フィールドに、数値以外の文字を入力して、確認ボタンをクリックした後の画面です。
前回解説したように、フォームに入力された値は、対応するActionクラスのメンバ変数に、自動的に型変換されて設定されます。正しく型変換できない場合、Struts 2でエラーを検出し、それを示すメッセージが自動で表示されます。変換エラーがStruts 2側で対応できるようになったこと自体は良いのですが、メッセージがデフォルトでは「Invalid field value for field ～」という具合に英語表示されてしまうのです。このメッセージはアプリケーション側で独自に制御したいところです。
独自の表示用メッセージ定義
アプリケーション独自のメッセージを表示するためには、Javaのプロパティファイルを用います。プロパティファイルとは、「キー = 値」というフォーマットで記述されたファイルのことで、Javaのアプリケーションから利用されます。通常ファイル名に「.properties」という拡張子を付与します。
Struts 2で利用する場合は、Actionクラスと同じディレクトリ階層に「Actionクラス名.properties」という名前で配置します。今回は、「/part3/ResearchWithValidation.properties」というファイル名になります。
フィールドの変換エラーのメッセージは、「invalid.fieldvalue.プロパティ名=メッセージ」というキーでメッセージを定義します。下記はその具体例です。
invalid.fieldvalue.age=年齢は数字で入力してください
この場合、次のようなメッセージが表示されます。
なお、プロパティファイルの値に日本語を使用する場合は、Unicodeエスケープ形式で記述する必要があります。文字コードWindows-31J（シフトJIS）でテキストファイルを作成し、JDK付属のnative2asciiコマンドなどを利用して、Unicodeエスケープに変換しましょう。Eclipse環境なら、PropertiesEditorプラグインが便利です。Unicodeエスケープの変換を意識することなく、通常のテキストファイルの感覚で扱うことができます。
