Struts 2のインターセプタによるサーブレット属性の操作

続 Struts 2入門（3）

（4）Scope Interceptor

　Actionクラスのフィールドを、セッション属性またはコンテキスト属性で扱えるようになるインターセプタです。バインド先の属性と、フィールド名を個別に設定できます。特別にセッション属性やコンテキスト属性用の変数を用意することがないまま扱うことができるため非常に便利ですが、フィールドの名前が合致していればリクエストパラメータの値がそのままセッション属性やコンテキスト属性へ反映されてしまうため、扱いには注意が必要です。

［リスト4］ScopeInterceptorSampleAction.java（抜粋）

@Namespace(value="/session")
@ParentPackage(value="struts-default")
@InterceptorRefs({
  // ScopeInterceptorの定義 … (A)
  @InterceptorRef(value="scope" ,
          params={"session","time","key","scoped_","autoCreateSession","true"}),
  // デフォルト定義インターセプタ群
  @InterceptorRef(value="defaultStack"),
})
@Results({
  @Result(name="success" , location="check.jsp"),
  @Result(name="input" , location="check.jsp"),
})

public class ScopeInterceptorSampleAction extends ActionSupport {
  public static final Logger log = Logger.getLogger(ScopeInterceptorSampleAction.class);

  /**
  * index.action。Validation対象外。
  * @return result="success"
  * @throws Exception
  */
  @Action(value="index")
  @SkipValidation()
  public String execute() throws Exception {
    this.time = new Date();
    addActionMessage("timeに現在の時刻がバインドされました");
    return "success";
  }

  /**
  * delete.action。Validation対象外。
  * @return result="success"
  * @throws Exception
  */
  @Action(value="remove")
  @SkipValidation()
  public String remove() throws Exception {
    time = null;
    addActionMessage("timeはアンバインドされました");
    return "success";
  }

  /**
  * check.action。Validation対象。
  * @return result="success"
  * @throws Exception
  */
  @Action(value="check")
  public String check() throws Exception {
    log.debug("*check*" + time);
    addActionMessage("time値の入力チェックは通過しました");
    return "success";
  }

  private Date time;
  public Date getTime() {
    return time;
  }
  /**
  * timeをバインド。同時に必須入力チェックを稼働し、ない場合は入力チェックエラーとする。
  * @param time
  */
  @RequiredFieldValidator(fieldName="time" , message="※セッションに日付が設定されていません")
  public void setTime(Date time) {
    this.time = time;
  }
}

　Scope Interceptorの設定を行っているのは、Actionクラスの上の行に書かれているインターセプタをアノテーションで定義している（A）の部分です。scopeはScope Interceptorの別名（エイリアス）で定義されているので、このインターセプタ設定はScope Interceptorの設定を行っています。さらに、paramsにて細かいパラメータを設定しています。上記の例では、session=time、key=scoped_、autoCreateSession=trueとなります。

　定義できる項目名を次の表に示します。

表1 Scope Interceptorの設定値

項目名	型	説明
session	String	セッション属性へバインドするフィールド名
application	String	アプリケーション属性へバインドするフィールド名
key	String	フィールドのバインド名の接頭辞を定義。指定しない場合はActionクラスのFQDN名
type	String	セッション保存のタイプをstart,end,その他の文字列から指定。startでセッション開始、endでセッション終了を指定。その他の文字列を指定すると、そのタイミングでのセッションのスナップショットを撮る
sessionReset	boolean	Scope Interceptorの対象フィールドを全て初期化する。セッションの場合はフィールドの初期値に、コンテキスト属性の場合はコンテキスト属性から再取得する。typeをstartに指定した場合と同じ
reset	boolean	セッション属性、コンテキスト属性を問わずにScope Interceptorの対象フィールドを全て初期化する
autoCreateSession	boolean	Actionクラス稼働と同時にセッションを自動生成する

　先程の例ではsession=time、key=scoped_、autoCreateSession=trueと設定したので、フィールドであるtimeをセッションで扱い、そのキー名はscoped_time、Action起動時には常にセッションが生成されている状態であることになります。

　では実際にサンプルを動かして、Scope Interceptorを含めたセッション管理用のインターセプタの稼動を確認しましょう。http://127.0.0.1:8080/interceptors/session/index.actionを起動すると、図6の画面が出力され、同時にセッションへ値が格納されます。

図6 セッション管理インターセプタの確認画面

　この画面のそれぞれのリンクを押すことで、セッションの操作を確認できます。

まとめ

　今回はサーブレット属性を取り扱うインターセプタの紹介をしました。サーブレット属性の編集はActionクラスを実装する際には必須事項ですし、特に今回はセッション属性の操作に注視しました。

　このように開発の利便性を高めてくれる機能が豊富に用意されているStruts 2ですが、それはインターセプタという形で提供されているものであることが理解できたかと思います。また、今回紹介しきれなかったインターセプタであるパラメータ操作に関するものや、デバッグ用のインターセプタに関しては次回に取り上げていきます。

参考資料

• Apache Struts 2 Documentation:Interceptors