Struts2拦截器的使用 (详解)

时间 2019-11-13

原文原文链接

如何使用struts2拦截器，或者自定义拦截器。特别注意，在使用拦截器的时候，在Action里面必须最后必定要引用struts2自带的拦截器缺省堆栈defaultStack,以下(这里我是引用了struts2自带的checkbox拦截器)：
<interceptor-ref name="checkbox">
<param name="uncheckedValue">0</param>
</interceptor-ref>
<interceptor-ref name="defaultStack"/>(必须加，不然出错) html

也能够改成对全局Action设置本身须要的拦截器，以下：

在struts.xml里面定义全局的配置设置
<package name="struts-shop" extends="struts-default">
    <interceptors>
      <interceptor-stack name="myStack">
        <interceptor-ref name="checkbox">
          <param name="uncheckedValue">0</param>
       </interceptor-ref>
       <interceptor-ref name="defaultStack"/>
      </interceptor-stack>
    </interceptors>
    <default-interceptor-ref name="myStack"/>（这句是设置全部Action自动调用的拦截器堆栈）
</package>

struts-action.xml里面配置Action以下：
<package name="LogonAdmin" extends="struts-shop">（这里扩展struts.xml里面定义的配置就能够了）
  <action name="logon" class="logonAction">
     <result>/jsp/smeishop/admin/index.jsp</result>
     <result name="error">/jsp/smeishop/admin/logon.jsp</result>
     <result name="input">/jsp/smeishop/admin/logon.jsp</result>
   </action>
   <action name="logout" class="logoutAction">
     <result>/jsp/smeishop/admin/logon.jsp</result>
   </action>
</package> apache

你的拦截器能够正常工做了！！HOHO cookie

如下是参考资料 session

struts2自带的配置及其拦截器配置 app

Struts2 拦截器 [Interceptor] jsp

拦截器的工做原理如上图，每个Action请求都包装在一系列的拦截器的内部。拦截器能够在Action执行直线作类似的操做也能够在Action执行直后作回收操做。 post

每个Action既能够将操做转交给下面的拦截器，Action也能够直接退出操做返回客户既定的画面。 this

如何自定义一个拦截器？ spa

自定义一个拦截器须要三步： debug

1 自定义一个实现Interceptor接口（或者继承自AbstractInterceptor）的类。

2 在strutx.xml中注册上一步中定义的拦截器。

3 在须要使用的Action中引用上述定义的拦截器，为了方便也可将拦截器定义为默认的拦截器，这样在不加特殊声明的状况下全部的Action都被这个拦截器拦截。

Interceptor接口声明了三个方法：

public interface Interceptor extends Serializable {

void destroy();

void init();

String intercept(ActionInvocation invocation) throws Exception;

}

Init方法在拦截器类被建立以后，在对Action镜像拦截以前调用，至关于一个post-constructor方法，使用这个方法能够给拦截器类作必要的初始话操做。

Destroy方法在拦截器被垃圾回收以前调用，用来回收init方法初始化的资源。

Intercept是拦截器的主要拦截方法，若是须要调用后续的Action或者拦截器，只须要在该方法中调用invocation.invoke()方法便可，在该方法调用的先后能够插入Action调用先后拦截器须要作的方法。若是不须要调用后续的方法，则返回一个String类型的对象便可，例如Action.SUCCESS。

另外AbstractInterceptor提供了一个简单的Interceptor的实现，这个实现为：

public abstract class AbstractInterceptor implements Interceptor {

public void init() {

}

public void destroy() {

}

public abstract String intercept(ActionInvocation invocation) throws Exception;

}

在不须要编写init和destroy方法的时候，只须要从AbstractInterceptor继承而来，实现intercept方法便可。

咱们尝试编写一个Session过滤用的拦截器，该拦截器查看用户Session中是否存在特定的属性（LOGIN属性）若是不存在，停止后续操做定位到LOGIN，不然执行原定操做，代码为：

public class CheckLoginInterceptor extends AbstractInterceptor {

public static final String LOGIN_KEY = "LOGIN";

public static final String LOGIN_PAGE = "global.login";

public String intercept(ActionInvocation actionInvocation) throws Exception {

System.out.println("begin check login interceptor!");

// 对LoginAction不作该项拦截

Object action = actionInvocation.getAction();

if (action instanceof LoginAction) {

System.out.println("exit check login, because this is login action.");

return actionInvocation.invoke();

}

// 确认Session中是否存在LOGIN

Map session = actionInvocation.getInvocationContext().getSession();

String login = (String) session.get(LOGIN_KEY);

if (login != null && login.length() > 0) {

// 存在的状况下进行后续操做。

System.out.println("already login!");

return actionInvocation.invoke();

} else {

// 不然终止后续操做，返回LOGIN

System.out.println("no login, forward login page!");

return LOGIN_PAGE;

}

注册拦截器

<interceptor

name="login"

class="com.jpleasure.teamware.util.CheckLoginInterceptor"/>

<interceptor-stack name="teamwareStack">

<interceptor-ref name="login"/>

<interceptor-ref name="defaultStack"/>

</interceptor-stack>

</interceptors>

将上述拦截器设定为默认拦截器：

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

这样在后续同一个package内部的全部Action执行以前都会被login拦截。

Struts2（XWork）提供的拦截器的功能说明：

拦截器	名字	说明
Alias Interceptor	alias	在不一样请求之间将请求参数在不一样名字件转换，请求内容不变
Chaining Interceptor	chain	让前一个Action的属性能够被后一个Action访问，如今和chain类型的result（<result type=”chain”>）结合使用。
Checkbox Interceptor	checkbox	添加了checkbox自动处理代码，将没有选中的checkbox的内容设定为false，而html默认状况下不提交没有选中的checkbox。
Cookies Interceptor	cookies	使用配置的name,value来是指cookies
Conversion Error Interceptor	conversionError	将错误从ActionContext中添加到Action的属性字段中。
Create Session Interceptor	createSession	自动的建立HttpSession，用来为须要使用到HttpSession的拦截器服务。
Debugging Interceptor	debugging	提供不一样的调试用的页面来展示内部的数据情况。
Execute and Wait Interceptor	execAndWait	在后台执行Action，同时将用户带到一个中间的等待页面。
Exception Interceptor	exception	将异常定位到一个画面
File Upload Interceptor	fileUpload	提供文件上传功能
I18n Interceptor	i18n	记录用户选择的locale
Logger Interceptor	logger	输出Action的名字
Message Store Interceptor	store	存储或者访问实现ValidationAware接口的Action类出现的消息，错误，字段错误等。
Model Driven Interceptor	model-driven	若是一个类实现了ModelDriven，将getModel获得的结果放在Value Stack中。
Scoped Model Driven	scoped-model-driven	若是一个Action实现了ScopedModelDriven，则这个拦截器会从相应的Scope中取出model调用Action的setModel方法将其放入Action内部。
Parameters Interceptor	params	将请求中的参数设置到Action中去。
Prepare Interceptor	prepare	若是Acton实现了Preparable，则该拦截器调用Action类的prepare方法。
Scope Interceptor	scope	将Action状态存入session和application的简单方法。
Servlet Config Interceptor	servletConfig	提供访问HttpServletRequest和HttpServletResponse的方法，以Map的方式访问。
Static Parameters Interceptor	staticParams	从struts.xml文件中将<action>中的<param>中的内容设置到对应的Action中。
Roles Interceptor	roles	肯定用户是否具备JAAS指定的Role，不然不予执行。
Timer Interceptor	timer	输出Action执行的时间
Token Interceptor	token	经过Token来避免双击
Token Session Interceptor	tokenSession	和Token Interceptor同样，不过双击的时候把请求的数据存储在Session中
Validation Interceptor	validation	使用action-validation.xml文件中定义的内容校验提交的数据。
Workflow Interceptor	workflow	调用Action的validate方法，一旦有错误返回，从新定位到INPUT画面
Parameter Filter Interceptor	N/A	从参数列表中删除没必要要的参数
Profiling Interceptor	profiling	经过参数激活profile

注册并引用Interceptor

</interceptors>

<interceptor-ref name="timer"/>

<interceptor-ref name="logger"/>

<result name="input">login.jsp</result>

<result name="success"

type="redirect-action">/secure/home</result>

</action>

</package>

能够将多个拦截器合并在一块儿做为一个堆栈调用，当一个拦截器堆栈被附加到一个Action的时候，要想Action执行，必须执行拦截器堆栈中的每个拦截器。

<interceptor-stack name="myStack">

<interceptor-ref name="timer"/>

<interceptor-ref name="logger"/>

</interceptor-stack>

</interceptors>

<interceptor-ref name="myStack"/>

<result name="input">login.jsp</result>

<result name="success"

type="redirect-action">/secure/home</result>

</action>

</package>

上述说明的拦截器在默认的Struts2应用中，根据惯例配置了若干个拦截器堆栈，详细情参看struts-default.xml

其中有一个拦截器堆栈比较特殊，他会应用在默认的每个Action上。

<interceptor-stack name="defaultStack">

<interceptor-ref name="exception"/>

<interceptor-ref name="alias"/>

<interceptor-ref name="servletConfig"/>

<interceptor-ref name="prepare"/>

<interceptor-ref name="i18n"/>

<interceptor-ref name="chain"/>

<interceptor-ref name="debugging"/>

<interceptor-ref name="profiling"/>

<interceptor-ref name="scopedModelDriven"/>

<interceptor-ref name="modelDriven"/>

<interceptor-ref name="fileUpload"/>

<interceptor-ref name="checkbox"/>

<interceptor-ref name="staticParams"/>

<interceptor-ref name="params">

</interceptor-ref>

<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-stack>

每个拦截器均可以配置参数，有两种方式配置参数，一是针对每个拦截器定义参数，二是针对一个拦截器堆栈统必定义全部的参数，例如：

<interceptor-ref name="validation">

<param name="excludeMethods">myValidationExcudeMethod</param>

</interceptor-ref>

<interceptor-ref name="workflow">

<param name="excludeMethods">myWorkflowExcludeMethod</param>

</interceptor-ref>

或者

<interceptor-ref name="defaultStack">

<param name="validation.excludeMethods">myValidationExcludeMethod</param>

<param name="workflow.excludeMethods">myWorkflowExcludeMethod</param>

</interceptor-ref>

每个拦截器都有两个默认的参数：

excludeMethods - 过滤掉不使用拦截器的方法和

includeMethods – 使用拦截器的方法。

须要说明的几点：

1 拦截器执行的顺序按照定义的顺序执行，例如：

<interceptor-stack name="xaStack">

<interceptor-ref name="thisWillRunFirstInterceptor"/>

<interceptor-ref name="thisWillRunNextInterceptor"/>

<interceptor-ref name="followedByThisInterceptor"/>

<interceptor-ref name="thisWillRunLastInterceptor"/>

</interceptor-stack>

的执行顺序为：

thisWillRunFirstInterceptor

thisWillRunNextInterceptor

followedByThisInterceptor

thisWillRunLastInterceptor

MyAction1

MyAction2 (chain)

MyPreResultListener

MyResult (result)

thisWillRunLastInterceptor

followedByThisInterceptor

thisWillRunNextInterceptor

thisWillRunFirstInterceptor

2 使用默认拦截器配置每一个Action都须要的拦截器堆栈，例如：

<interceptor-ref name="timer"/>

<interceptor-ref name="logger"/>

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

<result name="input">login.jsp</result>

<result type="redirect-action">/secure/home</result>

</action>

能够按照以下的方式定义：

<interceptor-stack name="myStack">

<interceptor-ref name="timer"/>

<interceptor-ref name="logger"/>

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

</interceptor-stack>

</interceptors>

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

<result name="input">login.jsp</result>

<result type="redirect-action">/secure/home</result>

</action>

3 如何访问HttpServletRequest，HttpServletResponse或者HttpSession

有两种方法能够达到效果，使用ActionContext：

Map attibutes = ActionContext.getContext().getSession();

或者实现相应的接口：

HttpSession SessionAware

HttpServletRequest ServletRequestAware

HttpServletResponse ServletResponseAware