SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

続 Struts 2入門

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にて初期設定されたデフォルトのメッセージが表示されます。

会員登録無料すると、続きをお読みいただけます

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

次のページ
OValプラグインを利用して設定できるチェック内容

この記事は参考になりましたか?

  • このエントリーをはてなブックマークに追加
続 Struts 2入門連載記事一覧

もっと読む

この記事の著者

山田 祥寛(ヤマダ ヨシヒロ)

静岡県榛原町生まれ。一橋大学経済学部卒業後、NECにてシステム企画業務に携わるが、2003年4月に念願かなってフリーライターに転身。Microsoft MVP for ASP/ASP.NET。執筆コミュニティ「WINGSプロジェクト」代表。 主な著書に「入門シリーズ(サーバサイドAjax/XMLDB/PEAR/Smarty)」「独習シリーズ(ASP.NET/PHP)」「10日でおぼえる入門教室シリーズ(ASP.NET/PHP/Jakarta/JSP&サーブレット/XML)」「Pocket詳解辞典シリーズ(ASP.NET/PHP/Perl&CGI)」「今日からつかえるシリーズ(PHP/JSP&サーブレット/XML/ASP)」「書き込み式 SQLのドリル」他、著書多数

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

WINGSプロジェクト 東 浩二(アズマ コウジ)

WINGSプロジェクトについて> 有限会社 WINGSプロジェクトが運営する、テクニカル執筆コミュニティ(代表 山田祥寛)。主にWeb開発分野の書籍/記事執筆、翻訳、講演等を幅広く手がける。2018年11月時点での登録メンバは55名で、現在も執筆メンバを募集中。興味のある方は、どしどし応募頂きたい。著書記事多数。 RSS Twitter: @yyamada(公式)、@yyamada/wings(メンバーリスト) Facebook

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

この記事は参考になりましたか?

この記事をシェア

  • このエントリーをはてなブックマークに追加
CodeZine(コードジン)
https://codezine.jp/article/detail/5345 2010/08/09 14:00

おすすめ

アクセスランキング

アクセスランキング

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

アクセスランキング

アクセスランキング