SHOEISHA iD

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

DeveloperZine(デベロッパージン)- エンジニアの意思決定を支える技術情報メディア ProductZine

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

続 Struts 2入門

Struts 2のインターセプタによるパラメータ操作とデバッグ機能

続 Struts 2入門(4)

(3) ParametersInterceptor

 リクエストパラメータをActionクラスへバインドする際に自動的に使われるインターセプタで、他のインターセプタやStruts 2のプラグイン機能の基本となっています。解除される場合にもカスタマイズされる場合にも他への影響は非常に大きくなりますので、変更や解除をすることは非常に稀です。デフォルトでは常に使われるインターセプタです。

(4) StaticParametersInterceptor

 各Actionクラスの定数、初期値を定義できるようにするインターセプタです。Actionクラスにて設定された変数は、リクエストパラメータの値を特定の値へ変換するか、強制的に設定値へ上書きするかを選択させることができます。

  利用する際にはParameterizableインターフェイスを実装します。ParameterizableインターフェイスによりActionクラスの定数をMap形式で取り扱いますがこのMapはUnmodifiableMap(参照のみ可能なMap)ですので、Actionクラス内での内容変更は許可されていません。次にサンプルコードを示します。

リスト3 StaticParamsSampleAction.java(抜粋)
@Namespace(value="/params")
@ParentPackage(value="struts-default")
@InterceptorRefs({
    @InterceptorRef(
    value="defaultStack" ,
    params={"staticParams.merge" , "true" ,     // リクエストパラメータとのマージ設定…(A)
            "staticParams.overwrite","false"}), // リクエストパラメータを強制上書き…(B)
})

@Results({
    @Result(name="success" , location="success.jsp"),
})
public class StaticParamsSampleAction extends ActionSupport implements
        Parameterizable {
    private static Logger log = Logger.getLogger(StaticParamsSampleAction.class);
    // key1の値をvalue1に指定する …(C)
    @Action(value="start" , params={"key1","value1"})
    public String execute() throws Exception {
        log.debug(params);
        log.debug(key1);
        log.debug(key2);
        return "success";
    }

    public void addParam(String key, String value) {
        params.put(key, value);
    }
    public Map<String, String> getParams() {
        return params;
    }
    public void setParams(Map<String, String> params) {
        this.params = params;
    }
}

 StaticParamsInterceptorの振る舞いについては、以下の一覧表になります。

表2 StaticParamsインターセプタの設定値
項目名 説明
merge boolean true時に指定されたパラメータがnullだった場合に初期値を設定する
overwrite boolean true時には指定されたパラメータを強制的に設定する

 リスト中の(A)および(B)の箇所で定義されます。(A)の箇所にてtrueを指定すると、リクエストパラメータから取得した値に対して、もし指定したパラメータがnullであった場合には、StaticParamsInterceptorが上書きを行う処理稼働します。さらに(B)の箇所にてtrueを指定すると、どんな値が入ってきたとしても強制的に上書きするようになります。上書き設定を行うのは各Actionのparams設定である(C)の箇所で行います。

 このサンプルでは、(A)でtrue、(B)でfalse、(C)でkey1の値はvalue1であると定義していますので、もしkey1がnullであった場合には、value1となります。このActionを次のリクエストパラメータを含めて起動したログは次のようになります。「http://127.0.0.1:8080/interceptors/params/start.action?key2=value2」と定数で定義したkey1を含めないリクエストを投げてみると、次の結果になります。

リスト4 StaticParamsSampleActionの起動ログ
[seren.lumi2.action.StaticParamsSampleAction] - {key1=value1}
[seren.lumi2.action.StaticParamsSampleAction] - value1
[seren.lumi2.action.StaticParamsSampleAction] - value2

 key1の値がActionクラスの初期値で定義されていますので、value1となります。

 このようにHTMLやJSPなどの画面側で初期値を設定することなく、Actionクラス側で初期値を設定することができますので、例えば検索結果一覧のページング機能などで初期値がnullだった場合にページ番号を1とする、といった初期化の設定や、ウィザード形式の入力画面にて、あらゆる画面から来ても初期値を空文字にしておくなど、初期設定を画面側に持たすことなくアプリケーション側にすべて持たせることができます。

次のページ
デバッグ用のインターセプタ

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

続 Struts 2入門連載記事一覧

もっと読む

この記事の著者

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

静岡県榛原町生まれ。一橋大学経済学部卒業後、NECにてシステム企画業務に携わるが、2003年4月に念願かなってフリーライターに転身。Microsoft MVP for Visual Studio and Development Technologies。執筆コミュニティ「WINGSプロジェクト」代表。主な著書に「独習シリーズ(Java・C#・Python・PHP・Ruby・JSP&サーブレットなど)」「速習シリーズ(ASP.NET Core・Vue.js・React・TypeScript・ECMAScript、Laravelなど)」「改訂3版JavaScript本格入門」「これからはじめるLaravel実践入門」「はじめてのAndroidアプリ開発 Kotlin編 」他、著書多数

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

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

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

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

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

この記事をシェア

CodeZine(コードジン)
https://codezine.jp/article/detail/5192 2010/06/17 14:00

イベント

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

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

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

メールバックナンバー