SSH Struts2拦截器

Struts2 拦截器

什么是拦截器

拦截器（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查看关于默认的拦截器与拦截器链的配置。

相关说明如下：

配置拦截器

定义拦截器

<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";  
        }  

    }  

}  

拦截器的配置

<?xml version="1.0" encoding="UTF-8" ?>  
<!DOCTYPE struts PUBLIC  
    "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"  
    "http://struts.apache.org/dtds/struts-2.0.dtd">  

<struts>  
    <constant name="struts.action.extension" value=","></constant>  
    <package name="testLogin" namespace="/" extends="struts-default"  >  
        <interceptors>  

            <interceptor name="MyInterceptor" class="com.interceptor.MyInterceptor"></interceptor>  

            <interceptor-stack name="defaultInterceptorStack">  
                <interceptor-ref name="MyInterceptor"></interceptor-ref>  
                <interceptor-ref name="defaultStack"></interceptor-ref>  
            </interceptor-stack>  
        </interceptors>  

        <!--配置默认拦截器，所有该包内的action如果没有单独配置拦截器，则默认执行默认拦截器-->  
        <default-interceptor-ref name="defaultInterceptorStack"></default-interceptor-ref>  

        <action name="login" class="com.action.LoginAction">  
            <result name="success" type="redirect">/success.jsp</result>  
            <result name="error" type="redirect">/error.jsp</result>  
            <result name="login">login.jsp</result>  
        </action>  
    </package>  
</struts>  

进入系统的时候，拦截器检查是否登录，如未登录，转到登录页；如已登录，转到成功页。

拦截器是Struts 2比较重要的一个功能。通过正确地使用拦截器，我们可以编写可复用性很高的代码。