Struts2--内建拦截器详解

川长思鸟来 2021-08-13 13:38 368阅读 0赞

Struts2 框架中内置了许多拦截器，这些拦截器以 name-class 对的形式配置在 struts-default.xml 文件中，其中，name 是拦截器的名称，也就是引用的名字；class 指定了该拦截器所对应的实现。

只要自定义的包继承了 Struts2 的 struts-default 包，就可以使用包中定义的内建拦截器，否则需要自行定义拦截器。

#### 内建拦截器介绍 ####

<table> 
 <thead> 
  <tr> 
   <th align="left">名称</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">alias</td> 
   <td align="left">在不同请求之间将请求参数在不同名称间转换，请求内容不变</td> 
  </tr> 
  <tr> 
   <td align="left">autowiring</td> 
   <td align="left">用于实现 Action 的自动装配</td> 
  </tr> 
  <tr> 
   <td align="left">chain</td> 
   <td align="left">让前一个 Action 的属性可以被后一个 Action 访问，现在和 chain 类型的 result() 结合使用</td> 
  </tr> 
  <tr> 
   <td align="left">conversionError</td> 
   <td align="left">将错误从 ActionContext 中添加到 Action 的属性字段中</td> 
  </tr> 
  <tr> 
   <td align="left">cookies</td> 
   <td align="left">使用配置的 Name 和 Value 指定 Cookies</td> 
  </tr> 
  <tr> 
   <td align="left">cookieProvider</td> 
   <td align="left">该类是一个 Cookie 工具，方便开发者向客户端写 Cookie</td> 
  </tr> 
  <tr> 
   <td align="left">clearSession</td> 
   <td align="left">用于清除一个 HttpSession 实例</td> 
  </tr> 
  <tr> 
   <td align="left">createSession</td> 
   <td align="left">自动创建 HttpSession，用于为需要使用</td> 
  </tr> 
  <tr> 
   <td align="left">HttpSession</td> 
   <td align="left">的拦截器服务</td> 
  </tr> 
  <tr> 
   <td align="left">debugging</td> 
   <td align="left">提供不同的调试用的页面展现内部的数据状况</td> 
  </tr> 
  <tr> 
   <td align="left">execAndWait</td> 
   <td align="left">在后台执行 Action，同时将用户带到一个中间的等待页面</td> 
  </tr> 
  <tr> 
   <td align="left">exception</td> 
   <td align="left">将异常定位到一个画面</td> 
  </tr> 
  <tr> 
   <td align="left">fileUpload</td> 
   <td align="left">提供文件上传功能</td> 
  </tr> 
  <tr> 
   <td align="left">il8n</td> 
   <td align="left">记录用户选择的 locale</td> 
  </tr> 
  <tr> 
   <td align="left">logger</td> 
   <td align="left">输出 Action 的名称</td> 
  </tr> 
  <tr> 
   <td align="left">model-driven</td> 
   <td align="left">如果一个类实现了 Model Driven，将 get Model 得到的结果放在 Value Slack 中</td> 
  </tr> 
  <tr> 
   <td align="left">scoped-model-driven</td> 
   <td align="left">如果一个 Action 实现了</td> 
  </tr> 
  <tr> 
   <td align="left">params</td> 
   <td align="left">将请求中的参数设置到 Action 中</td> 
  </tr> 
  <tr> 
   <td align="left">actionMappingParams</td> 
   <td align="left">用于负责在 Action 配置中传递参数</td> 
  </tr> 
  <tr> 
   <td align="left">prepare</td> 
   <td align="left">如果 Action 实现了 Preparable，则该拦截器调用 Action 类的 prepare 方法</td> 
  </tr> 
  <tr> 
   <td align="left">staticParams</td> 
   <td align="left">将 struts.xml 文件中 标签的参数内容设置到对应的 Action 中</td> 
  </tr> 
  <tr> 
   <td align="left">scope</td> 
   <td align="left">将 Action 状态存入 session 和 application 范围</td> 
  </tr> 
  <tr> 
   <td align="left">servletConfig</td> 
   <td align="left">提供访问 HttpServletRequest 和 HttpServletResponse 方法，以 Map 方式访问</td> 
  </tr> 
  <tr> 
   <td align="left">timer</td> 
   <td align="left">输岀 Action 执行的时间</td> 
  </tr> 
  <tr> 
   <td align="left">token</td> 
   <td align="left">通过 Token 避免双击</td> 
  </tr> 
  <tr> 
   <td align="left">tokenSession</td> 
   <td align="left">和 Token Interceptor 一样，不过双击时把请求的数据存储在 Session 中</td> 
  </tr> 
  <tr> 
   <td align="left">validation</td> 
   <td align="left">使用 action-validation.xml 文件中定义的内容校验提交的数据</td> 
  </tr> 
  <tr> 
   <td align="left">workflow</td> 
   <td align="left">调用 Action 的 validate 方法，一旦有错谋返回，则重新定位到 INPUT 画面</td> 
  </tr> 
  <tr> 
   <td align="left">store</td> 
   <td align="left">存储或者访问实现 ValidalionAware 接口的 Action 类出现的消息、错误和字段错误等</td> 
  </tr> 
  <tr> 
   <td align="left">checkbox</td> 
   <td align="left">添加了 checkbox 自动处理代码，将没有选中的 checkbox 的内容设定为 false，而 html 在默认情况下不提交没有选中的 checkbox</td> 
  </tr> 
  <tr> 
   <td align="left">datetime</td> 
   <td align="left">日期拦截器</td> 
  </tr> 
  <tr> 
   <td align="left">profiling</td> 
   <td align="left">通过参数激活 profile</td> 
  </tr> 
  <tr> 
   <td align="left">roles</td> 
   <td align="left">确定用户是否具有 JAAS 指定的 Role，否则不予执行</td> 
  </tr> 
  <tr> 
   <td align="left">annotationWorkflow</td> 
   <td align="left">利用注解代替 XML 配置，使用</td> 
  </tr> 
  <tr> 
   <td align="left">multiselect</td> 
   <td align="left">检测是否有像 标签一样被选中的多个值，然后添加一个空参数</td> 
  </tr> 
  <tr> 
   <td align="left">deprecation</td> 
   <td align="left">当日志级别设置为调试模式（debug）并且没有特殊参数时，在 devMode 模式中，会检查应用程序使用过时或未知的常量，并且显示警告</td> 
  </tr> 
 </tbody> 
</table>

Struts2 框架除了提供这些有用的拦截器以外，还定义了一些拦截器栈，在开发 Web 应用时，可以直接引用这些拦截器栈，而无须自定义拦截器。

注意：随着 Struts2 版本的发展，内建拦截器的数量也在相应地增多，不同版本的 Struts2 拦截器的数量有一些差异，此版本的 Struts2 内建拦截器共有 35 个。这些内建拦截器读者不需要记忆，只需要了解即可。

#### 内建拦截器的配置 ####

在 struts-core-2.3.24.jar 包中的根目录下找到 struts-default.xml 文件，打开后找到 元素下的内建拦截器和拦截器栈，其部分代码如下所示：

<package name="struts-default" abstract="true">
        ...
        <interceptors>
            
            <interceptor name="alias" class="com.opensymphony.xwork2.interceptor.AliasInterceptor"/>
            <interceptor name="autowiring" class="com.opensymphony.xwork2.spring.interceptor.ActionAutowiringInterceptor"/>
            <interceptor name="chain" class="com.opensymphony.xwork2.interceptor.ChainingInterceptor"/>
            ...
            
            <interceptor-stack name="basicStack">
                
                <interceptor-ref name="exception"/>
                ...
            </interceptor-stack>
            ...
            
            <interceptor-stack name="modelDrivenStack">
                
                <interceptor-ref name="modelDriven"/>
                
                <interceptor-ref name="basicStack"/>
            </interceptor-stack>
            ...
            
            <interceptor-stack name="defaultStack">
                <interceptor-ref name="exception"/>
                <interceptor-ref name="alias"/>
                <interceptor-ref name="il8n"/>
                ...
                <interceptor-ref name="validation">
                    <param name="excludeMethods">input,back,cancel,browse</param>
                </interceptor-ref>
                ...
            </interceptor-stack>
        </interceptors>
        
        <default-interceptor-ref name="defaultStack"/>
        
        <default-class-ref class="com.opensymphony.xwork2.ActionSupport" />
    </package>

在上述内建拦截器的配置代码中，defaultStack 拦截器组合了多个拦截器，这些拦截器可以满足大部分 Web 应用程序的需求。使用时，只要在 struts.xml 定义包的过程中继承 struts-default 包，那么 defaultStack 拦截器栈就是默认拦截器的引用。