本文为原创,如需转载,请注明作者和出处,谢谢!
Struts2的拦截器和Servlet过滤器类似。在执行Action的execute方法之前,Struts2会首先执行在struts.xml中引用的拦截器,在执行完所有引用的拦截器的intercept方法后,会执行Action的execute方法。
Struts2拦截器类必须从com.opensymphony.xwork2.interceptor.Interceptor接口继承,在Intercepter接口中有如下三个方法需要实现:
void init();
String intercept(ActionInvocation invocation) throws Exception;
其中intercept方法是拦截器的核心方法,所有安装的拦截器都会调用之个方法。在Struts2中已经在struts-default.xml中预定义了一些自带的拦截器,如timer、params等。如果在<package>标签中继承struts-default,则当前package就会自动拥有struts-default.xml中的所有配置。代码如下:
<package name="demo" extends="struts-default" > ... </package>
在 struts-default.xml 中有一个默认的引用,在默认情况下(也就是 <action> 中未引用拦截器时)会自动引用一些拦截器。这个默认的拦截器引用如下:< interceptor-stack name ="defaultStack" >
< interceptor-ref name ="exception" />
< interceptor-ref name ="alias" />
< interceptor-ref name ="servletConfig" />
< interceptor-ref name ="prepare" />
< interceptor-ref name ="i18n" />
< interceptor-ref name ="chain" />
< interceptor-ref name ="debugging" />
< interceptor-ref name ="profiling" />
< interceptor-ref name ="scopedModelDriven" />
< interceptor-ref name ="modelDriven" />
< interceptor-ref name ="fileUpload" />
< interceptor-ref name ="checkbox" />
< interceptor-ref name ="staticParams" />
< interceptor-ref name ="params" >
< param name ="excludeParams" > dojo/..* </ param >
</ interceptor-ref >
< interceptor-ref name ="conversionError" />
< interceptor-ref name ="validation" >
< param name ="excludeMethods" > input,back,cancel,browse </ param >
</ interceptor-ref >
< interceptor-ref name ="workflow" >
< param name ="excludeMethods" > input,back,cancel,browse </ param >
</ interceptor-ref >
</ interceptor-stack >
上面在defaultStack中引用的拦截器都可以在<action>中不经过引用就可以使用(如果在<action>中引用了任何拦截器后,要使用在defaultStack中定义的拦截器,也需要在<action>中重新引用,在后面将详细讲解)。
下面我们来看几个简单的拦截器的使用方法。
一、记录拦截器和execute方法的执行时间(timer)
timer 是 Struts2 中最简单的拦截器,这个拦截器对应的类是 com.opensymphony.xwork2.interceptor.TimerInterceptor 。它的功能是记录 execute 方法和其他拦截器(在 timer 后面定义的拦截器)的 intercept 方法执行的时间总和。如下面的配置代码所示:
< interceptor-ref name ="logger" />
< interceptor-ref name ="timer" />
</ action >
由于在timer后面没有其他的拦截器定义,因此,timer只能记录execute方法的执行时间,在访问first动作时,会在控制台输出类似下面的一条信息:
信息: Executed action [/test/first!execute] took 16 ms.
在使用 timer 拦截器时,需要 commons-logging.jar 的支持。将 logger 引用放到 timer 的后面,就可以记录 logger 拦截器的 intercept 方法和 Action 的 execute 方法的执行时间总和,代码如下:
< interceptor-ref name ="timer" />
< interceptor-ref name ="logger" />
</ action >
大家可以使用如下的 Action 类来测试一下 timer 拦截器:
import com.opensymphony.xwork2.ActionSupport;
public class FirstAction extends ActionSupport
{
public String execute() throws Exception
{
Thread.sleep( 1000 ); // 延迟1秒
return null ;
}
}
如果只记录execute方法的执行时间,一般会输出如下的信息:
信息: Executed action [/test/first!execute] took 1000 ms.
二、通过请求调用Action的setter方法(params)
当客户端的一个 form 向服务端提交请求时,如有一个 textfield ,代码如下:
< s:textfield name ="name" />
< s:submit />
</ s:form >
在提交后,Struts2将会自动调用first动作类中的setName方法,并将name文本框中的值通过setName方法的参数传入。实际上,这个操作是由params拦截器完成的,params对应的类是com.opensymphony.xwork2.interceptor.ParametersInterceptor。由于params已经在defaultStack中定义,因此,在未引用拦截器的<action>中是会自动引用params的,如下面的配置代码,在访问first动作时,Struts2是会自动执行相应的setter方法的。
<action name="first" class="action.FirstAction">
... ...
</action>
但如果在<action>中引用了其他的拦截器,就必须再次引用params拦截器,Struts2才能调用相应的setter方法。如下面的配置代码所示:
< interceptor-ref name ="timer" />
< interceptor-ref name ="params" />
</ action >
三、通过配置参数调用Action的setter方法(static-params)
static-params 拦截器可以通过配置<params>标签来调用 Action 类的相应的 setter 方法,static-params拦截器对应的类是com.opensymphony.xwork2.interceptor.StaticParametersInterceptor。下面配置代码演示了如何使用static-params拦截器:
< interceptor-ref name ="timer" />
< param name ="who" > 比尔 </ param >
< interceptor-ref name ="params" />
< interceptor-ref name ="static-params" />
</ action >
如果first动作使用上面的配置,在访问first动作时,Struts2会自动调用setWho方法将“比尔”作为参数值传入setWho方法。
四、使用拦截器栈
为了能在多个动作中方便地引用同一个或几个拦截器,可以使用拦截器栈将这些拦截器作为一个整体来引用。拦截器栈要在 <package> 标签中使用 <interceptors> 和子标签 <interceptor-stack> 来定义。代码如下:
< interceptors >
< interceptor-stack name ="mystack" >
< interceptor-ref name ="timer" />
< interceptor-ref name ="logger" />
< interceptor-ref name ="params" />
< interceptor-ref name ="static-params" />
</ interceptor-stack >
</ interceptors >
< action name ="first" class ="action.FirstAction" >
< param name ="who" > 比尔 </ param >
< interceptor-ref name ="mystack" />
</ action >
</ package >