Struts2拦截器(Interceptor)

淡淡的烟草味﹌ 2022-01-17 05:21 307阅读 0赞

[为什么80%的码农都做不了架构师？>>> ][80_] ![hot3.png][]

## 1. 理解拦截器 ##

### 1.1. 什么是拦截器： ###

拦截器，在AOP（Aspect-Oriented Programming）中用于在某个方法或字段被访问之前，进行拦截然后在之前或之后加入某些操作。拦截是AOP的一种实现策略。

在Webwork的中文文档的解释为——拦截器是动态拦截Action调用的对象。它提供了一种机制可以使开发者可以定义在一个action执行的前后执行的代码，也可以在一个action执行前阻止其执行。同时也是提供了一种可以提取action中可重用的部分的方式。

谈到拦截器，还有一个词大家应该知道——拦截器链（Interceptor Chain，在Struts 2中称为拦截器栈Interceptor Stack）。拦截器链就是将拦截器按一定的顺序联结成一条链。在访问被拦截的方法或字段时，拦截器链中的拦截器就会按其之前定义的顺序被调用。

### 1.2. 拦截器的实现原理： ###

大部分时候，拦截器方法都是通过代理的方式来调用的。Struts 2的拦截器实现相对简单。当请求到达Struts 2的ServletDispatcher时，Struts 2会查找配置文件，并根据其配置实例化相对的拦截器对象，然后串成一个列表（list），最后一个一个地调用列表中的拦截器。如下图：

## 2. 拦截器的配置 ##

Struts 2已经为您提供丰富多样的，功能齐全的拦截器实现。大家可以至struts2的jar包内的struts-default.xml查看关于默认的拦截器与拦截器链的配置。

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

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

在struts.xml文件中定义拦截器，拦截器栈：

<table> 
 <tbody> 
 <tr> 
 <td> &lt;package name="my" extends="struts-default" namespace="/manage"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;interceptors&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;interceptor name="拦截器名" class="拦截器实现类"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;interceptor-stack name="拦截器栈名"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp; &lt;interceptor-ref name="拦截器一"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp; &lt;interceptor-ref name="拦截器二"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; interceptor-stack&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; interceptors&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ...... &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

## 3. 使用拦截器 ##

一旦定义了拦截器和拦截器栈后，就可以使用这个拦截器或拦截器栈来拦截Action了。拦截器的拦截行为将会在Action的exceute方法执行之前被执行。

<table> 
 <tbody> 
 <tr> 
 <td> &lt;action name="userOpt" class="org.qiujy.web.struts2.action.UserAction"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;result name="success"&gt;/success.jspresult&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;result name="error"&gt;/error.jspresult&gt; &lt;interceptor-ref name="defaultStack"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;interceptor-ref name="拦截器名或拦截器栈名"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; action&gt; </td> 
 </tr> 
 </tbody> 
</table>

此处需要注意的是，如果为Action指定了一个拦截器，则系统默认的拦截器栈将会失去作用。为了继续使用默认拦截器，所以上面配置文件中手动引入了默认拦截器。

## 4. 自定义拦截器 ##

作为“框架（framework）”，可扩展性是不可或缺的。虽然，Struts 2为我们提供如此丰富的拦截器实现，但是这并不意味我们失去创建自定义拦截器的能力，恰恰相反，在Struts 2自定义拦截器是相当容易的一件事。

**1.**

**2.**

**3.**

**4.**

### 4.1. 实现拦截器类： ###

所有的Struts 2的拦截器都直接或间接实现接口com.opensymphony.xwork2.interceptor.Interceptor。该接口提供了三个方法：

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

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

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

除此之外，继承类com.opensymphony.xwork2.interceptor.AbstractInterceptor是更简单的一种实现拦截器类的方式，因为此类提供了init()和destroy()方法的空实现，这样我们只需要实现intercept方法。

### 4.2. 使用自定义拦截器： ###

两个步骤：

l通过元素来定义拦截器。

l通过元素来使用拦截器。

## 5. 自定义拦截器示例 ##

### 5.1. 问题描述： ###

使用自定义拦截器来完成用户权限的控制：当浏览者需要请求执行某个操作时，应用需要先检查浏览者是否登录，以及是否有足够的权限来执行该操作。

### 5.2. 实现权限控制拦截器类： ###

AuthorizationInterceptor.java

<table> 
 <tbody> 
 <tr> 
 <td> package org.qiujy.common; &nbsp; import java.util.Map; &nbsp; import com.opensymphony.xwork2.Action; import com.opensymphony.xwork2.ActionInvocation; import com.opensymphony.xwork2.interceptor.AbstractInterceptor; &nbsp; /** &nbsp;* 权限检查拦截器 &nbsp;* &nbsp;* @author qiujy &nbsp;* @version 1.0 &nbsp;*/ public class AuthorizationInterceptor extends AbstractInterceptor { &nbsp; &nbsp;&nbsp;&nbsp; /* &nbsp;&nbsp;&nbsp; &nbsp;* 拦截Action处理的拦截方法 &nbsp;&nbsp;&nbsp; &nbsp;* &nbsp;&nbsp;&nbsp; &nbsp;*/ &nbsp;&nbsp;&nbsp; public String intercept(ActionInvocation invocation) throws Exception { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Map session = invocation.getInvocationContext().getSession(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; String userName = (String) session.get("userName"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; if (null != userName &amp;&amp; userName.equals("test")) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; System.out.println("拦截器：合法用户登录---"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; return invocation.invoke(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; } else { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; System.out.println("拦截器：用户未登录---"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; return Action.LOGIN; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; } &nbsp;&nbsp;&nbsp; } } </td> 
 </tr> 
 </tbody> 
</table>

### 5.3. 配置权限控制拦截器： ###

struts.xml：

<table> 
 <tbody> 
 <tr> 
 <td> DOCTYPE struts PUBLIC &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN" &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;n</td> 
 </tr> 
 </tbody> 
</table>

转载于:https://my.oschina.net/sati/blog/9423

[80_]: https://my.oschina.net/u/2663968/blog/3051541
[hot3.png]: /images/20220117/2019b31b146344a0bd02b09f81063702.png