【Struts2】token interceptorを使ったのですがインターセプタの挙動が理解できません

Question

Struts2で二重送信を防ぐために、以下のようにtoken interceptorを使いました。

<action name="TestAction" class="test.action.TestAction" method="execute">
	<interceptor-ref name="token"/>
	<result name="success">xxx.jsp</result>
	<result name="invalid.token">yyy.jsp</result>
</action>

JSPにも<s:token/>を仕込み済みです。

しかし、これでActionを実行してみたところ、1回目のsubmitをした瞬間に「ぬるぽ」が発生してしまいました。

<interceptor-ref name="token"/>を書く前は正常にJSPからActionへ値をsetterで送り込めていました。

そこで、以下のように<interceptor-ref name="defaultStack"/>を書いてみると値を送ることに成功。

<action name="TestAction" class="test.action.TestAction" method="execute">
	<interceptor-ref name="defaultStack"/>
	<interceptor-ref name="token"/>
	<result name="success">xxx.jsp</result>
	<result name="invalid.token">yyy.jsp</result>
</action>

ここで２つの疑問なのですが

①
なぜ<interceptor-ref name="token"/>を書いた途端にValueStackのActionプロパティに値をセットできなくなり、defaultStackを書いた途端にできるようになったのでしょうか？

<interceptor-ref name="token"/>のようにインターセプタ単品を指定するということは、指定しなかったデフォルトのインターセプタ全てが動作しない。ということを意味するということかと思ったのですが・・・

②
Actionプロパティに値をセットする役割を持ったインターセプタがいる、ということだと思うのですが、具体的にどのインターセプタがその役割を担っているのでしょうか？

以下サイトを読んで、params interceptorではないかと思いました。

https://www.javatpoint.com/struts-2-interceptors-tutorial

1. params It populates the action properties with the request parameters.

しかし、<interceptor-ref name="params"/>と書いても値が渡らず同じくぬるぽになってしまいました。。

Answer 1

Struts2のインターセプタは、無設定のときには struts2のjarファイルに含まれる struts-default.xmlの定義にある defaultStack のインターセプタ・スタック（＝インターセプタの組み合わせを定義したもの）が使われます。

defaultStackの内容は、以下のとおり、複数のインターセプタを経てActionクラスへのフィールドならびにStruts2内部のOgnlValueStackへ情報が格納されていきます。

            <interceptor-stack name="defaultStack">
                <interceptor-ref name="exception"/>
                <interceptor-ref name="alias"/>
                <interceptor-ref name="servletConfig"/>
                <interceptor-ref name="i18n"/>
                <interceptor-ref name="prepare"/>
                <interceptor-ref name="chain"/>
                <interceptor-ref name="scopedModelDriven"/>
                <interceptor-ref name="modelDriven"/>
                <interceptor-ref name="fileUpload"/>
                <interceptor-ref name="checkbox"/>
                <interceptor-ref name="datetime"/>
                <interceptor-ref name="multiselect"/>
                <interceptor-ref name="staticParams"/>
                <interceptor-ref name="actionMappingParams"/>
                <interceptor-ref name="params"/>
                <interceptor-ref name="conversionError"/>
                <interceptor-ref name="validation">
                    <param name="excludeMethods">input,back,cancel,browse</param>
                </interceptor-ref>
                <interceptor-ref name="workflow">
                    <param name="excludeMethods">input,back,cancel,browse</param>
                </interceptor-ref>
                <interceptor-ref name="debugging"/>
            </interceptor-stack>

なぜdefaultStackが利用されるかは、同じく struts-default.xml の末の方に書かれている

<default-interceptor-ref name="defaultStack"/>

で定義されているからです。

---

ではtokenInterceptorはどのように追加するべきかですが、それは defaultStackをカスタマイズしますが、もっと簡単で確実な方法は、 defaultStackの後に tokenInterceptor を後刺し します。

struts.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC
    "-//Apache Software Foundation//DTD Struts Configuration 2.5//EN"
    "http://struts.apache.org/dtds/struts-2.5.dtd">
<struts>
	<constant name="struts.enable.DynamicMethodInvocation" value="false" />
	<constant name="struts.devMode" value="true" />

	<package name="custom" extends="struts-default">
		<interceptors>
			<interceptor-stack name="tokenStack">
				<interceptor-ref name="defaultStack" />
				<interceptor-ref name="token" />
			</interceptor-stack>
		</interceptors>
		<default-interceptor-ref name="tokenStack"/>
	</package>
</struts>

このstruts.xmlの設定により、struts-default の設定を継承した custom 設定ができ、customのインターセプタスタックで、tokenStack が標準で利用できる準備ができました。

---

これを使うActionクラスは、例えばConventionプラグインを利用した例では、以下のように @ParentPackage で先ほど作成した custom を指定します。

import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Namespace;
import org.apache.struts2.convention.annotation.ParentPackage;
import org.apache.struts2.convention.annotation.Result;
import org.apache.struts2.convention.annotation.Results;

import com.opensymphony.xwork2.ActionSupport;

@Namespace("/sports")
@ParentPackage("custom")
@Results({
    @Result(name = ActionSupport.SUCCESS, type = "dispatcher", location="sports.jsp")
})
public class SportsAction extends ActionSupport {
  .....
}

@ParentPackageを指定せずActionクラスごとにインターセプタを設定する方法もあります。そのときは@InterceptorRefsを利用します。

import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.InterceptorRef;
import org.apache.struts2.convention.annotation.InterceptorRefs;
import org.apache.struts2.convention.annotation.Namespace;
import org.apache.struts2.convention.annotation.Result;
import org.apache.struts2.convention.annotation.Results;

import com.opensymphony.xwork2.ActionSupport;

@Namespace("/sports")
@InterceptorRefs({
	@InterceptorRef("defaultStack"),
	@InterceptorRef("token"),
})
@Results({
    @Result(name = ActionSupport.SUCCESS, type = "dispatcher", location="sports.jsp")
})
public class SportsAction extends ActionSupport {
    ....
}

Comments

[RogerFederer]

ご回答ありがとうございます！
struts.xmlでインターセプタをカスタマイズせず特定の<action>の中に<interceptor-ref name="token"/>だけを直に書くと、そのAction実行時はデフォルト含めその他のインターセプタが全て機能しなくなる、という理解で良いでしょうか？

[A-pZ]

はい、その通りです。

tokenInterceptorだけが動く状態になってしまいます。公式サイトには特に書かれていないのですが、Struts2はすべてのインターセプタが basicStack と名付けられた最低限のインターセプタが搭載されている前提で動作しますので、もしこれを除外をしてしまうと、誤動作や例外が出てしまいます。

[RogerFederer]

＞ tokenInterceptorだけが動く状態になってしまいます。
理解しました！ありがとうございます！！