集册 SSH要点教程 Struts2拦截器

Struts2拦截器

—— Struts2 拦截器

黑派客     最近更新时间：2020-09-27 05:27:40

505

什么是拦截器

拦截器（Interceptor）是Struts 2的一个强有力的工具，有许多功能都是构建于它之上，如国际化（前两篇博客介绍过）、转换器，校验等。 拦截器是动态拦截Action调用的对象。它提供了一种机制可以使开发者可以定义在一个action执行的前后执行的代码，也可以在一个action执行前阻止其执行。同时也是提供了一种可以提取action中可重用的部分的方式。 说到拦截器有一个东西不能落下——拦截器链（Interceptor Chain，在Struts 2中称为拦截器栈Interceptor Stack）。拦截器链就是将拦截器按一定的顺序联结成一条链。在访问被拦截的方法或字段时，拦截器链中的拦截器就会按其之前定义的顺序被调用。

实现原理

Struts 2的拦截器实现相对简单。当请求到达Struts 2的ServletDispatcher时，Struts 2会查找配置文件，并根据其配置实例化相对的拦截器对象，然后串成一个列表（list），最后一个一个地调用列表中的拦截器。

Struts 2提供了丰富多样的，功能齐全的拦截器实现。大家可以到struts2-all-2.0.1.jar或struts2-core-2.0.1.jar包的struts-default.xml查看关于默认的拦截器与拦截器链的配置。

相关说明如下：

拦截器名字说明
Alias Interceptoralias在不同请求之间将请求参数在不同名字件转换，请求内容不变
Chaining Interceptorchain让前一个Action的属性可以被后一个Action访问，现在和chain类型的result（）结合使用。
Checkbox Interceptorcheckbox添加了checkbox自动处理代码，将没有选中的checkbox的内容设定为false，而html默认情况下不提交没有选中的checkbox。
Cookies Interceptorcookies使用配置的name,value来是指cookies
Conversion Error InterceptorconversionError将错误从ActionContext中添加到Action的属性字段中。
Create Session InterceptorcreateSession自动的创建HttpSession，用来为需要使用到HttpSession的拦截器服务。
Debugging Interceptordebugging提供不同的调试用的页面来展现内部的数据状况。
Execute and Wait InterceptorexecAndWait在后台执行Action，同时将用户带到一个中间的等待页面。
Exception Interceptorexception将异常定位到一个画面
File Upload InterceptorfileUpload提供文件上传功能
I18n Interceptori18n记录用户选择的locale
Logger Interceptorlogger输出Action的名字
Message Store Interceptorstore存储或者访问实现ValidationAware接口的Action类出现的消息，错误，字段错误等。
Model Driven Interceptormodel-driven如果一个类实现了ModelDriven，将getModel得到的结果放在Value Stack中。
Scoped Model Drivenscoped-model-driven如果一个Action实现了ScopedModelDriven，则这个拦截器会从相应的Scope中取出model调用Action的setModel方法将其放入Action内部。
Parameters Interceptorparams将请求中的参数设置到Action中去。
Prepare Interceptorprepare如果Acton实现了Preparable，则该拦截器调用Action类的prepare方法。
Scope Interceptorscope将Action状态存入session和application的简单方法。
Servlet Config InterceptorservletConfig提供访问HttpServletRequest和HttpServletResponse的方法，以Map的方式访问。
Static Parameters InterceptorstaticParams从struts.xml文件中将中的中的内容设置到对应的Action中。
Roles Interceptorroles确定用户是否具有JAAS指定的Role，否则不予执行。
Timer Interceptortimer输出Action执行的时间
Token Interceptortoken通过Token来避免双击
Token Session InterceptortokenSession和Token Interceptor一样，不过双击的时候把请求的数据存储在Session中
Validation Interceptorvalidation使用action-validation.xml文件中定义的内容校验提交的数据。
Workflow Interceptorworkflow调用Action的validate方法，一旦有错误返回，重新定位到INPUT画面
Parameter Filter InterceptorN/A从参数列表中删除不必要的参数
Profiling Interceptorprofiling通过参数激活profile

配置拦截器

定义拦截器

<package name="MyInterceptor" extends="struts-default" namespace="/">  
    <interceptors>  
        <!-- 配置拦截器 -->  
        <interceptor name="拦截器名" class="拦截器实现类完整路径"/>  
        <!-- 配置拦截器栈 -->  
        <interceptor-stack name="拦截器栈名">  
             <interceptor-ref name="拦截器一"/>  
             <interceptor-ref name="拦截器二"/>  
            |..................................  
        </interceptor-stack>  
    </interceptors>  
</package>

将拦截器配置到action

<action name="login" class="com.action.LoginAction">  
    <result name="success">/success.jsp</result>  
    <result name="error">/error.jsp</result>  
    <!-- 引用拦截器,一般配置在result后面 -->    
    <interceptor-ref name="拦截器名或拦截器栈名"/>  
    <!-- 引用Struts默认拦截器 -->  
    <interceptor-ref name="defaultStack"/>  
</action>

需要注意的是，必须要引用Struts默认的拦截器，否则会报错。

实现自定义拦截器：

通过实现接口com.opensymphony.xwork2.interceptor.Interceptor可自定义拦截器。该接口提供了三个方法：

1) void init(); 在该拦截器被初始化之后，在该拦截器执行拦截之前，系统回调该方法。对于每个拦截器而言，此方法只执行一次。

2) void destroy();该方法跟init()方法对应。在拦截器实例被销毁之前，系统将回调该方法。

3) String intercept(ActionInvocation invocation) throws Exception; 该方法是用户需要实现的拦截动作。该方法会返回一个字符串作为逻辑视图。

除此之外，通过继承类com.opensymphony.xwork2.interceptor.AbstractInterceptor等方法也可自定义拦截器，这里不过多介绍。

拦截器实例

自定义拦截器MyInterceptor，实现Interceptor接口

package com.interceptor;  

import java.util.Map;  

import com.opensymphony.xwork2.ActionInvocation;  
import com.opensymphony.xwork2.interceptor.Interceptor;  
import com.sun.org.apache.xml.internal.security.keys.content.RetrievalMethod;  

public class MyInterceptor implements Interceptor {  

    @Override  
    public void destroy() {  
        System.out.println("---------destroy()---------");  
    }  

    @Override  
    public void init() {  
        System.out.println("---------init()---------");  
    }  

    @Override  
    public String intercept(ActionInvocation invocation) throws Exception {  
        System.out.println("---------intercept()---------");  
        Map session = invocation.getInvocationContext().getSession();  
        if (session.get("username") != null) {  
            return invocation.invoke();  
        } else {  
            return "login";  
        }  

    }  

}

拦截器的配置

展开阅读全文