WebWork2教程（中文版）(5)(完）

5、Interceptors

Interceptors允许在调用堆栈中包含任意在Action处理之前和/或处理之后执行的代码。这是你的代码简单，更能重用。Xwork和WebWork的大部分特性都是Interceptors实现的。你可以通过外部配置，按照你定义的顺序，对指定的Action应用你自己的Interceptors。

当你访问.action URL时，WebWork的ServletDispatcher启动Action对象，在Action被执行之前，启动允许被其它的对象中断，这就称Interceptor。在指定的Action之前（或之后）执行Interceptor，只要在xwork.xml中配置属性。下面是4.1.1节中展示UI标记用法的例子的Interceptor配置：

<action name="formProcessing" class="lesson04_01_01.FormProcessingAction"> 
      
      

       <result name="input" type="dispatcher">ex01-index.jsp</result> 
      
      

       <result name="success" type="dispatcher">ex01-success.jsp</result> 
      
      

       <interceptor-ref name="validationWorkflowStack" /> 
      
      

</action>
      
      

FormProcessingAction使用了validationWorkflowStack。这是一个Interceptor堆，组织一组按顺序执行的Interceptors。ValidationWorkflowStack在webwork-default.xml中配置，所以我们只要使用<interceptor-ref />在Action配置中，或使用<default-interceptor-ref />在package配置中使用它。下面是HelloWebWorld例子的Interceptor配置：

<!DOCTYPE xwork PUBLIC "-//OpenSymphony Group//XWork 1.0//EN" 
      
      

"http://www.opensymphony.com/xwork/xwork-1.0.dtd">
      
      

<xwork>
      
      

       <!-- Include webwork defaults (from WebWork-2.1 JAR). -->
      
      

       <include file="webwork-default.xml" />
      
      

       <!-- Configuration for the default package. -->
      
      

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

              <!-- Default interceptor stack. --> 
      
      

              <default-interceptor-ref name="defaultStack" /> 
      
      

              <!-- Action: Lesson 03: HelloWebWorldAction. --> 
      
      

              <action name="helloWebWorld" class="lesson03.HelloWebWorldAction"> 
      
      

                <result name="success" type="dispatcher">ex01-success.jsp</result> 
      
      

              </action> 
      
      

       </package>
      
      

</xwork>
      
      

看一下Interceptor如何工作的

l         创建Interceptor类，需要扩展com.opensymphony.xwork.interceptor.Interceptor接口（包含在xwork-1.0.jar）；

l         在xwork.xml文件中，使用<interceptors />内嵌的<interceptor />声明Interceptor类；

l         使用<interceptor-stack />创建Interceptor堆（可选）；

l         使用<interceptor-ref /> 或<default-interceptor-ref />哪些Interceptor由哪个Action使用；前者由指定Action使用，后者为所有Action使用

（1）webwork-default.xml

让我们看一下webwork-default.xml的内容：

<!DOCTYPE xwork PUBLIC "-//OpenSymphony Group//XWork 1.0//EN" 
      
      

"http://www.opensymphony.com/xwork/xwork-1.0.dtd">
      
      

<xwork>
      
      

       <package name="webwork-default">
      
      

              <result-types>
      
      

                <result-type name="dispatcher" default="true"
      
      

                       class="com.opensymphony.webwork.dispatcher.ServletDispatcherResult"/>
      
      

                <result-type name="redirect" 
      
      

                       class="com.opensymphony.webwork.dispatcher.ServletRedirectResult"/>
      
      

                <result-type name="velocity" 
      
      

                       class="com.opensymphony.webwork.dispatcher.VelocityResult"/>
      
      

                <result-type name="chain" 
      
      

                       class="com.opensymphony.xwork.ActionChainResult"/>
      
      

                <result-type name="xslt" 
      
      

                       class="com.opensymphony.webwork.views.xslt.XSLTResult"/>
      
      

              </result-types>
      
      

              <interceptors>
      
      

                <interceptor name="timer" 
      
      

                       class="com.opensymphony.xwork.interceptor.TimerInterceptor"/>
      
      

                <interceptor name="logger" 
      
      

                       class="com.opensymphony.xwork.interceptor.LoggingInterceptor"/>
      
      

                <interceptor name="chain" 
      
      

                       class="com.opensymphony.xwork.interceptor.ChainingInterceptor"/>
      
      

                <interceptor name="static-params" 
      
      

                       class="com.opensymphony.xwork.interceptor.StaticParametersInterceptor"/>
      
      

                <interceptor name="params" 
      
      

                       class="com.opensymphony.xwork.interceptor.ParametersInterceptor"/>
      
      

                <interceptor name="model-driven" 
      
      

                       class="com.opensymphony.xwork.interceptor.ModelDrivenInterceptor"/>
      
      

                <interceptor name="component" 
      
      

                       class="com.opensymphony.xwork.interceptor.component.ComponentInterceptor"/>
      
      

                <interceptor name="token" 
      
      

                       class="com.opensymphony.webwork.interceptor.TokenInterceptor"/>
      
      

                <interceptor name="token-session" 
      
      

                       class="com.opensymphony.webwork.interceptor.TokenSessionStoreInterceptor"/>
      
      

                <interceptor name="validation" 
      
      

                       class="com.opensymphony.xwork.validator.ValidationInterceptor"/>
      
      

                <interceptor name="workflow" 
      
      

                       class="com.opensymphony.xwork.interceptor.DefaultWorkflowInterceptor"/>
      
      

                <interceptor name="servlet-config" 
      
      

                       class="com.opensymphony.webwork.interceptor.ServletConfigInterceptor"/>
      
      

                <interceptor name="prepare" 
      
      

                       class="com.opensymphony.xwork.interceptor.PrepareInterceptor"/>
      
      

                <interceptor name="conversionError" 
      
      

                       class="com.opensymphony.webwork.interceptor.WebWorkConversionErrorInterceptor"/>
      
      

                <interceptor-stack name="defaultStack">
      
      

                       <interceptor-ref name="static-params"/>
      
      

                       <interceptor-ref name="params"/>
      
      

                       <interceptor-ref name="conversionError"/>
      
      

                </interceptor-stack>
      
      

                <interceptor-stack name="validationWorkflowStack">
      
      

                       <interceptor-ref name="defaultStack"/>
      
      

                       <interceptor-ref name="validation"/>
      
      

                       <interceptor-ref name="workflow"/>
      
      

                </interceptor-stack>
      
      

              </interceptors>
      
      

       </package>
      
      

</xwork>
      
      

既然在我们的xwork.xml中包含了webwork-default.xml，我们就可以在Action中使用这些Interceptor或Interceptor堆。下面是这些Interceptor做的事情：

l         timer：对Action的执行进行计时（包括嵌套的Interceptor和视图）

l         chain：使前一个Action的属性对当前的Action有效，通常创建Action链

l         static-params：设置xwork.xml中的参数到Action中（<action />内嵌的<param />）

l         params：设置请求参数（POST或GET）到Action中

l         model-driven：如果Action实现ModelDriven，将getModel()的结果推到Value Stack中

l         component：使能和注册组件，使其对Action有效

l         token：检查Action中的有效token，防止重复提交

l         token-session：同上，但是当处理到无效token时，在session中保存提交的数据

l         validation：使用在{Action}-vaildation.xml中定义的验证器进行数据验证

l         workflow：调用Action类中的validate()方法，在发生错误时，返回INPUT视图；应该和validation Interceptor一起使用

l         servlet-config：获得对HttpServletRequest和HttpServletResponse的访问（由于绑定到Servlet API，最好不要使用）

l         prepare

l         conversionError

（2）创建自己的Interceptor

如果上面的Interceptor没有适合你的，你可以创建自己的Interceptor。下面的例子假设我们需要一个Interceptor在session中根据当天时间放置一个欢迎信息：

GreetingInterceptor.java：

package lesson05;
      
      

import java.util.Calendar;
      
      

import com.opensymphony.xwork.interceptor.Interceptor;
      
      

import com.opensymphony.xwork.ActionInvocation;
      
      

public class GreetingInterceptor implements Interceptor {
      
      

       public void init() { }
      
      

       public void destroy() { }
      
      

       public String intercept(ActionInvocation invocation) throws Exception {
      
      

              Calendar calendar = Calendar.getInstance();
      
      

              int hour = calendar.get(Calendar.HOUR_OF_DAY);
      
      

              String greeting = (hour < 6) ? "Good evening" : 
      
      

                ((hour < 12) ? "Good morning": 
      
      

                ((hour < 18) ? "Good afternoon": "Good evening"));
      
      

              invocation.getInvocationContext().getSession().put("greeting", greeting);
      
      

              String result = invocation.invoke();
      
      

              return result;
      
      

       }
      
      

}
      
      

xwork.xml：

<!DOCTYPE xwork PUBLIC "-//OpenSymphony Group//XWork 1.0//EN" 
      
      

"http://www.opensymphony.com/xwork/xwork-1.0.dtd">
      
      

<xwork>
      
      

       <!-- Include webwork defaults (from WebWork-2.1 JAR). -->
      
      

       <include file="webwork-default.xml" />
      
      

       <!-- Configuration for the default package. -->
      
      

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

              <interceptors> 
      
      

                <interceptor name="greeting" class="section02.lesson05.GreetingInterceptor" /> 
      
      

              </interceptors> 
      
      

              <!-- Action: Lesson 5: GreetingInterceptor. --> 
      
      

              <action name="greetingAction" class="lesson05.GreetingAction"> 
      
      

                <result name="success" type="velocity">ex01-result.vm</result> 
      
      

                <interceptor-ref name="greeting" /> 
      
      

              </action> 
      
      

       </package>
      
      

</xwork>
      
      

GreetingAction.java：

package lesson05;
      
      

import com.opensymphony.xwork.ActionSupport;
      
      

public class GreetingAction extends ActionSupport {
      
      

       public String execute() throws Exception {
      
      

              return SUCCESS;
      
      

       }
      
      

}
      
      

ex01-result.vm：

<html>
      
      

<head>
      
      

<title>WebWork Tutorial - Lesson 5 - Example 1</title>
      
      

</head>
      
      

<body>
      
      

#set ($ses = $req.getSession())
      
      

<p><b>${ses.getAttribute('greeting')}!</b></p>
      
      

</body>
      
      

</html>
      
      

Interceptor类要扩展com.opensymphony.xwork.interceptor.Interceptor接口：init()在Interceptor初始化时调用；destroy()在销毁时调用；intercept(ActionInvocation invocation)是处理的中心。

invocation.invoke()用来调用Interceptor堆中下一个Interceptor，或是Action（如果没有的话）。因此，我们完全可以绕开Action而返回结果（不执行Action）。

上面的例子是在Action执行之前调用，如果要在Action执行之后调用Interceptor，只要将执行代码放在invocation.invoke()之后。

WebWork提供一个实现这种方式的抽象类com.opensymphony.xwork.interceptor.AroundInterceptor，你只要实现它的before(ActionInvocation invocation)和 after(ActionInvocation dispatcher, String result)方法就可以了。