Struts2入门（6）： Interceptor 拦截器体系

Struts2 Interceptor 拦截器体系

• 拦截器体系是 struts2 的重要组成部分，可以将是 struts2 理解为一个空容器，其中大量的内建拦截器完成类该框架的大部分工作，如解析请求参数、类型转换、将请求参数封装为DTO（Data Transfer Object）、输入验校等，这些内建拦截器可以在 struts.xml 进行配置单独加载，如果将<package>的 extends 属性设置为 "struts-default"，则该package会加载常用的默认内建拦截器；

• 在 struts1 中是没有拦截器体系的概念的，所有框架动作逻辑都写在核心控制器中，这样的实现其实带来框架的低灵活性和低拓展性；
  

以下是一些常用的比较重要的内建拦截器的说明：

完整的内建拦截器列表可以参见 http://struts.apache.org/download.cgi 下载的 document-zip 文档中查询到；

alias实现在不同请求中相似参数类别名的转换conversionError负责类型转换错误的拦截器createSession负责创建一个HttpSession对象debugging当struts设置为调试模式时，该拦截器负责提供更多的调试信息execAndWait后台执行Action，负责将等待画面发送给用户exception负责将异常映射为结果fileUpload负责文件上传时解析表单中文本框中的内容i18n支持国际化的拦截器，负责将所选的语言、区域信息放置入用户的session中logger负责日志记载的拦截器params最基本的拦截器，负责解析HTTP请求中的参数，并将该参数值设置为Action的属性值prepare如果action实现了prepare()方法，会调用该拦截器的prepare()方法scope范围转化拦截器，将Action的状态信息保存在 HttpSession范围，或者 ServletContext范围ServletConfig负责 Action 访问 Servlet APItimer输出 Action 的执行时间，常用于分析 Action 性能瓶颈时使用token负责阻止重复提交validation负责数据验校

拦截器的使用

对于已存在的拦截器（包括内建拦截器和自定义拦截器），可以通过在 struts.xml 配置相应的拦截器来进行使用，如示例中显示声明使用“logger”，“timer”拦截器；

1

<?xml version="1.0" encoding="UTF-8"?>

2

<!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN" "http://struts.apache.org/dtds/struts-2.0.dtd">

3

<struts>

4

   <constant name="struts.devMode" value="true" />

5

6

   <package name="default" extends="struts-default">

7

      <action name="test" class="demo.TestAction" method="execute">

8

          <!--显示声明使用内建拦截器-->

9

         <interceptor-ref name="params"/>

10

         <interceptor-ref name="timer" />

11

12

         <result name="success">/test.jsp</result>

13

      </action>

14

   </package>

15

</struts>

配置拦截器参数（或覆盖内建拦截器参数）可以使用以下的语法：

1

<action>

2

    <interceptor-ref name="拦截器名称">

3

        <param name="参数名">参数值</param>

4

    </interceptor-ref>

5

</action>

配置拦截器的执行顺序

struts 中的拦截器的执行顺序是按照在 struts.xml 中拦截器栈的顺序执行的，可以使用 <interceptor-ref name="defaultStack"> 来指代默认的拦截器栈；

如下示例：

1

<package name="default" extends="struts-default">

2

    <action name="test" class=".....">

3

        <!--执行默认的拦截器栈-->

4

        <interceptor-ref name="defaultStack" /> 

5

         <!--执行自定义的拦截器栈-->

6

        <interceptor-ref name="my_interceptor1" /> 

7

         <!--执行自定义拦截器栈-->

8

        <interceptor-ref name="my_interceptor2" /> 

9

10

        <result name="...">...</result>

11

</action>

以上的示例中，先执行系统默认的拦截器栈，再执行“my_interceptor1”,再执行“my_interceptor2”；

创建自定义拦截器

要实现一个自定义的拦截器，需要实现一个Interceptor接口，该接口如下，可以直接继承AbstractInterceptor基类来简便实现过程：

1

public interface Interceptor extends Serializable{

2

   void destroy();                         //销毁方法

3

   void init();                           //初始化方法

4

   String intercept(ActionInvocation invocation) throws Exception;  //拦截方法

5

}

以下示例实现一个简单的拦截器

1

import java.util.*;

2

import com.opensymphony.xwork2.ActionInvocation;

3

import com.opensymphony.xwork2.interceptor.AbstractInterceptor;

4

​

5

public class MyInterceptor extends AbstractInterceptor {

6

​

7

   public String intercept(ActionInvocation invocation)throws Exception{

8

​

9

      /* let us do some pre-processing */

10

      String output = "Pre-Processing"; 

11

      System.out.println(output);

12

​

13

      /* let us call action or next interceptor */

14

      String result = invocation.invoke();

15

​

16

      /* let us do some post-processing */

17

      output = "Post-Processing"; 

18

      System.out.println(output);

19

​

20

      return result;

21

   }

22

}

在 struts.xml 中调用

1

<action>

2

    <interceptor-ref name="MyInterceptor" />

3

</action>