メモ

PrepareInterceptorはActionで実際に呼び出されるメソッドの前処理用のメソッドを呼び出す。使用するためにはActionクラスでPreparableを継承する。

前処理用のメソッドとして以下のメソッドが順番に呼び出される（1,2はメソッドが存在する場合のみ、また2は1のメソッドが存在したら呼び出されない。）

1. prepare{メソッド名}()
2. prepareDo(メソッド名}()
3. prepare()
   

import com.opensymphony.xwork2.ActionSupport;
import com.opensymphony.xwork2.Preparable;

public class ProperSample extends ActionSupport implements Preparable{

   public void prepareHoge() throws Exception {
       System.out.println("prepareHoge()")
   }

   public void prepareDoHoge() throws Exception {
       System.out.println("prepareHoge()")
   }

   public void prepare() throws Exception {
       System.out.println("prepare")
   }

   public String hoge() throws Exception{

       return SUCCESS;
   }
}

例えば、上記のようなクラスが存在しhoge()メソッドが呼び出されるURLが叩かれたとすると、
まずprepareHoge()がよばれ、次にprepare()がよばれる。（prepareHoge()が存在するのでprepareDoHoge()は呼び出されない。）その後に、他に積まれているインターセプターがあればそれを実行し、その後hoge()メソッドが呼ばれる。

デフォルトではprepare()は必ず呼び出される。これを止めたい(要するにprepare{メソッド名}()またはprepareDo{メソッド名}()だけを呼び出したい）場合はalwaysInvokePrepareフィールドを"false"にする。で、これを行うためには以下のような記述をする。

<interceptor-ref name="prepare">
    <param name="alwaysInvokePrepare">false</param>
</interceptor-ref>

PrepareInterceptorはstruts-default.xmlで宣言されているinterceptor-stackにはすべて組み込まれている。よって、struts-default.xmlで宣言されているいずれかを使用する場合はstruts.xmlにPrepareInterceptorを使用するための定義を書く必要はない。

ServletConfigInterceptorはActionクラスにHttpServletRequest、HttpServletResponse、ServletContextなどの情報を設定してくれる。ただし、設定される為にはサポートされてるインターフェースをActionで継承しなければならない。サポートされるのは以下のインターフェース。

• ServletContextAware
  
• ServletRequestAware
• ServletResponseAware
• ParameterAware
  
• RequestAware -
  
• SessionAware
• ApplicationAware
• PrincipalAware
  

仮にサポートされるすべてのインターフェースを継承したクラスを作成すると以下のようになる。各setterメソッドに対してServletConfigInterceptorが値を設定してくれる。

import com.opensymphony.xwork2.ActionContext;
import com.opensymphony.xwork2.ActionSupport;
import java.util.Map;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.struts2.interceptor.ApplicationAware;
import org.apache.struts2.interceptor.ParameterAware;
import org.apache.struts2.interceptor.PrincipalAware;
import org.apache.struts2.interceptor.PrincipalProxy;
import org.apache.struts2.interceptor.RequestAware;
import org.apache.struts2.interceptor.ServletRequestAware;
import org.apache.struts2.interceptor.ServletResponseAware;
import org.apache.struts2.interceptor.SessionAware;
import org.apache.struts2.util.ServletContextAware;


public class HogeAction extends ActionSupport implements ServletContextAware,
                                                            ServletRequestAware,
                                                            ServletResponseAware,
                                                            ParameterAware,
                                                            RequestAware,
                                                            SessionAware,
                                                            ApplicationAware,
                                                            PrincipalAware{

    private ServletContext servletContext;
    private HttpServletRequest request;
    private HttpServletResponse response;
    private Map parameterMap;
    private Map requestMap;
    private Map sessionMap;
    private Map applicationMap;
    private PrincipalProxy principalProxy;

    public void setServletContext(ServletContext servletContext) {
        this.servletContext = servletContext;
    }
    public void setServletRequest(HttpServletRequest request) {
        this.request = request;
    }
    public void setServletResponse(HttpServletResponse response) {
        this.response = response;
    }
    public void setParameters(Map parameterMap) {        
        this.parameterMap = parameterMap;
    }
    public void setRequest(Map requestMap) {
        this.requestMap = requestMap;
    }
    public void setSession(Map sessionMap) {
        this.sessionMap = sessionMap;
    }
    public void setApplication(Map applicationMap) {
       this.applicationMap = applicationMap;
    }
    public void setPrincipalProxy(PrincipalProxy principalProxy) {
        this.principalProxy = principalProxy;
    }
}

ServletContextAware、ServletRequestAware、ServletResponseAwareを継承してしまうとservletApiに依存したクラスになってしまうので注意が必要。（テストがしにくくなるとか、フレームワークがせっかく隠してくれてたのに〜 っているのが理由）リクエストの値がとりたい場合はRequestAware、セッションの値がとりたい場合はSessionAwareを継承しとけば値がとれる（かつservletApiにも依存しなくて済む）のでそれらの値がとりたいだけであれば、上記インターフェースの継承は不要。

また、SessionAware,RequestAware、ParameterAware、を継承してServletConfigInterceptorに値を設定してもらわなくても、Action内で直接以下のように書けば同じように値を取得できる(ServletConfigInterceptorがやっていることと一緒だけど。。）
ActionContext.getContext().getSession().get("foo");
ActionContext.getCongext().get("request").get("bar");
ActionContext.getParameters().get("hoge");

Actionに対して使用するインターセプターをstruts-default.xmlで宣言しているinterceptor-stackを使用する場合はstruts.xmlに対して何も記述の必要はない。（struts-default.xmlで宣言されているすべてのinterceptor-stackにServletConfigInterceptorが入っているため）もし、自分でinterceptor-stackをstruts.xmlに宣言して、その中にServletConfigInterceptorを追加したい場合は以下の記述を追加する。
<interceptor-ref name="servletConfig"/>

ExceptionMappingInterceptorは例外処理のハンドリングをやってくれる。
具体的には、例外を補足して遷移先画面の振り分けを行う。

<package name="example" extends="struts-default">
    <global-results>
        <result name="error">error.jsp</result>
    </global-results>

    <global-exception-mappings>
        <exception-mapping exception="java.lang.Exception" result="error"/>
    </global-exception-mappings>

    <action name="Foo" class="example.FooAction" >
        <interceptor-ref name="defaultStack"/>
        <exception-mapping exception="example.HogeException" result="hoge_error"/> 
        <result >/example/Foo.jsp</result>
        <result name="hoge_error">/example/hoge_error.jsp</result>
    </action>
</package>

上記struts.xmlだと、exampleという名前でグループ化したURLでjava.lang.Exceptionが発生した場合、error.jspに飛ばされる。また、example.FooAction呼び出しの際にexample.HogeExceptionが発生した場合、example/hoge_error.jspに飛ばされる。

ExceptionMappingInterceptorを使用する際に気をつけることは、複数のインターセプターを呼ぶ場合は１番最初に呼び出すようにする。つまり<interceptor-ref name="exception"/>を１番最初に書くようにする。
理由は、ExceptionMappingInterceptorよりも前に別のインターセプターを呼び出し、そのインターセプターで例外が発生しても補足ができないため。

上記struts.xmlでは<interceptor-ref name="exception"/>はどこにも書いてない。理由はstruts-defaultパッケージを継承しており、そこに含まれているdefaultStackを使用しているため。defaultStackには<interceptor-ref name="exception"/>が含まれている。
フレームワークが用意しているinterceptor-stackはすべて<interceptor-ref name="exception"/>が含まれており、大抵のものが先頭に書いてある。

もしフレームワークが用意しているinterceptor-stackを使用せず、インターセプターの定義をすべて自分で書くのであれば<interceptor-ref name="exception"/>を書くことと、書く順番に注意する。

ExceptionMappingInterceptorで補足した例外の内容(Throwable.getMessage)をログに出力したい場合は以下のような書き方をする。

<interceptor-ref name="exception">
    <param name="logEnabled">true</param>
    <param name="logCategory">jp.co.hogehoge</param>
    <param name="logLevel">WARN</param>       
</interceptor-ref>

<param name="logEnabled">true</param>は必須で <param name="logLevel">は記載がないとdebugレベルになる。（trace, debug, info, warn, error, fatal以外の値を書くとIllegalArgumentExceptionが発生）

ExceptionMappingInterceptorの処理はexception-mappingのresult要素に関連付けられた画面に飛ばすだけだが、他に何か処理をしたい場合は
publishException(ActionInvocation invocation, ExceptionHolder exceptionHolder)
という拡張ポイントが用意されているのでExceptionMappingInterceptorを継承したクラスを作成し、上記メソッドに処理を書くとよいかもしれない。

AliasInterceptorはパラメータにエイリアスをつける。

<package name="example" namespace="/hogehoge" extends="struts-default">
  <action name="hoge" class="example.HogeAction" method="browse">
    <param name="aliases">#{ 'foo' : 'bar' }</param> - (1)
    <interceptor-ref name="alias"/> - (2)
    <result name="success">/date.jsp</result>
  </action>
</package>

class HogeAction{
  private String foo;
  private String bar;
  public String getFoo() {
    return foo;
  }
  public void setFoo(String foo) {
    this.foo = foo;
  }
  public String getBar() {
    return bar;
  }
  public void setBar(String bar) {
    this.bar = bar;
  }
}

上記のようなstruts.xmlとActionクラスがあるとする。
通常、http://struts2/hogehoge/hoge.action?foo=aaaとリクエストが来たらHogeActionクラスのfooに対して"aaa"が設定されるが、(1)と(2)があることによりHogeActionクラスのbarに対して"aaa"が設定される。複数のパラメータに対してエイリアスをつけたい場合は#{ 'foo' : 'bar', 'foo2' : 'bar2'}のようにカンマで区切れば良い。また、デフォルトのエイリアスキー"aliases"を変更したい場合は、以下のようにすればよい。(以下は"booboo"に変更）

<package name="example" namespace="/hogehoge" extends="struts-default">
  <action name="hoge" class="example.HogeAction" method="browse">
    <param name="booboo">#{ 'foo' : 'bar' }</param>
    <interceptor-ref name="alias">
      <param name="aliasesKey">booboo</param>
    </interceptor-ref>
    <result name="success">/date.jsp</result>
  </action>
</package>