Struts 2の新たな検証機能「OVal Frameworkプラグイン」

続・Struts2入門（6）

　本稿ではStruts 2に新しく導入された入力チェック機構であるOVal Frameworkのプラグインを紹介します。

はじめに

　本稿ではStruts 2に新しく導入された入力チェック機構であるOVal Frameworkのプラグインを紹介します。

対象読者

　Struts 2のWebアプリケーション開発に興味ある方。

必要な環境

　最低動作環境は次のとおりです。

• Java SE 5
• Struts 2.1.8.1が動作する環境
• Tomcat 5.5.x / 6.0.x

OVal Frameworkとは

　入力チェックを担う仕組みとしてValidation（参考記事：Struts 2入門（3）～バリデーションの仕組みを理解する（後編）～）がありますが、Struts 2.1.8.1から新機能としてOVal Frameworkの機能を利用できるようになりました。OVal Framework（以降、OValと略します）とはJavaオブジェクトに対する入力チェック機能を提供するフレームワークで、既存のValidationでチェックできる内容はもちろん、オブジェクトの比較や、より複雑な文字列チェック、ネスト構造のクラスに対してもチェックが行えるようになっています。

　OValを設定する方法は、XMLファイルで定義する方法と、アノテーションで定義する方法があります。本稿では、アノテーションで定義する方法を紹介します。

導入方法

　OValプラグインは、Struts 2.1.8.1からは標準バンドルされています。前回のGAリリースである2.1.6で利用する場合は、OVal Framework本体をSourceForge:ovalからダウンロードし、他のJARファイルと同様、（WEBアプリケーションのフォルダ）/WEB-INF/lib以下へ配置することで利用できます。現在最新のバージョンは1.50です。

設定手順

　OValプラグインを導入するには、あらかじめ以下の設定を行います。

• struts.xmlに設定を追加します。
• ActionクラスにOVal利用の設定をします。

　それ以外に、既存のValidationとの違いはありません。ActionクラスやJSPでの実装に対して、極力変更を与えないようになっています。

　struts.xmlの設定は次のようになります。

リスト1　struts.xml（抜粋）

<?xml version="1.0" encoding="UTF-8" ?>
<struts>
  …（中略）…
  <constant name="struts.oval.validateJPAAnnotations" value="true" />
</struts>

　次にActionクラスへの設定例です。

リスト2　SampleAction.java（抜粋）

@ParentPackage("oval-default")  // …（A）
@InterceptorRefs({              // …（B）
    @InterceptorRef(value="ovalValidationStack"),
})
…（中略）…
public class SampleAction extends ActionSupport {
    …（中略）…
}

　（A）のParentPackageにて、oval-defaultを継承します。

　（B）のInterceptorRefsにて、ovalValidationStackを宣言します。

　以上で、Ovalプラグインを利用する準備が整いました。では実際にActionクラスへOValを利用した入力チェックを設定してみましょう。

ActionクラスへOValの設定を行う

　ではActionクラスへの実装を、最も簡単な例で示します。

　次に示す例は、Actionクラスにリクエストパラメータを1つだけ格納する場合です。

リスト3　SampleAction.java（抜粋）

public class SampleAction extends ActionSupport {

    @Action("check")
    public String check() throws Exception {
        return "success";
    }

    @NotNull(message ="usermodel.input.name.require")    // （A）
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

　リスト3内にある（A）の箇所に定義されているものが、OValによるチェック内容になります。この例ではnameに対してNotNullのルールを適用しています。ですのでもしNotNullに違反したら、つまりnameがnullであった場合には入力チェックエラーと判断し、そのエラーメッセージはmessage属性に定義した内容になります。また、メッセージに定義した内容はStruts 2の標準に従い、メッセージを定義したプロパティファイルから自動的に参照します。設定されていないメッセージは、OValにて初期設定されたデフォルトのメッセージが表示されます。