Struts2的基石--拦截器

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

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

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

实现原理
Struts 2的拦截器实现相对简单。当请求到达Struts 2的ServletDispatcher时，Struts 2会查找配置文件，并根据其配置实例化相对的拦截器对象，然后串成一个列表（list），最后一个一个地调用列表中的拦截器，如图1所示。

图１　拦截器调用序列图

已有的拦截器

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

在本文使用是Struts 2的最新发布版本2.0.1。需要下载的朋友请点击以下链接： http://apache.justdn.org/struts/binaries/struts-2.0.1-all.zip

以下部分就是从struts-default.xml文件摘取的内容：

 

< 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 name ="conversionError" class ="org.apache.struts2.interceptor.StrutsConversionErrorInterceptor" /> 
< interceptor name ="createSession" class ="org.apache.struts2.interceptor.CreateSessionInterceptor" /> 
< interceptor name ="debugging" class ="org.apache.struts2.interceptor.debugging.DebuggingInterceptor" /> 
< interceptor name ="external-ref" class ="com.opensymphony.xwork2.interceptor.ExternalReferencesInterceptor" /> 
< interceptor name ="execAndWait" class ="org.apache.struts2.interceptor.ExecuteAndWaitInterceptor" /> 
< interceptor name ="exception" class ="com.opensymphony.xwork2.interceptor.ExceptionMappingInterceptor" /> 
< interceptor name ="fileUpload" class ="org.apache.struts2.interceptor.FileUploadInterceptor" /> 
< interceptor name ="i18n" class ="com.opensymphony.xwork2.interceptor.I18nInterceptor" /> 
< interceptor name ="logger" class ="com.opensymphony.xwork2.interceptor.LoggingInterceptor" /> 
< interceptor name ="model-driven" class ="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor" /> 
< interceptor name ="scoped-model-driven" class ="com.opensymphony.xwork2.interceptor.ScopedModelDrivenInterceptor" /> 
< interceptor name ="params" class ="com.opensymphony.xwork2.interceptor.ParametersInterceptor" /> 
< interceptor name ="prepare" class ="com.opensymphony.xwork2.interceptor.PrepareInterceptor" /> 
< interceptor name ="static-params" class ="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor" /> 
< interceptor name ="scope" class ="org.apache.struts2.interceptor.ScopeInterceptor" /> 
< interceptor name ="servlet-config" class ="org.apache.struts2.interceptor.ServletConfigInterceptor" /> 
< interceptor name ="sessionAutowiring" class ="org.apache.struts2.spring.interceptor.SessionContextAutowiringInterceptor" /> 
< interceptor name ="timer" class ="com.opensymphony.xwork2.interceptor.TimerInterceptor" /> 
< interceptor name ="token" class ="org.apache.struts2.interceptor.TokenInterceptor" /> 
< interceptor name ="token-session" class ="org.apache.struts2.interceptor.TokenSessionStoreInterceptor" /> 
< interceptor name ="validation" class ="com.opensymphony.xwork2.validator.ValidationInterceptor" /> 
< interceptor name ="workflow" class ="com.opensymphony.xwork2.interceptor.DefaultWorkflowInterceptor" /> 
< interceptor name ="store" class ="org.apache.struts2.interceptor.MessageStoreInterceptor" /> 
< interceptor name ="checkbox" class ="org.apache.struts2.interceptor.CheckboxInterceptor" /> 
< interceptor name ="profiling" class ="org.apache.struts2.interceptor.ProfilingActivationInterceptor" /> 

 

配置和使用拦截器

在struts-default.xml中已经配置了以上的拦截器。如果您想要使用上述拦截器，只需要在应用程序struts.xml文件中通过“<include file="struts-default.xml" />”将struts-default.xml文件包含进来，并继承其中的struts-default包（package），最后在定义Action时，使用“<interceptor-ref name="xx" />”引用拦截器或拦截器栈（interceptor stack）。一旦您继承了struts-default包（package），所有Action都会调用拦截器栈 ——defaultStack。当然，在Action配置中加入“<interceptor-ref name="xx" />”可以覆盖defaultStack。

 

Struts2常用的内置拦截器
alias：实现不同请求中相似参数别名的转换
autowiring：自动装配。主要用于Struts2和Spring整合时，Struts2可以使用自动装配的方式访问Spring容器中的Bean
chain：构建一个Action链，使当前Action可以访问前一个Action的属性。一般与<result type="chain"….../>一起使用
conversionError：处理类型转换错误。负责将类型转换错误从ActionContext中取出，并转换成Action的FieldError错误
createSession：负责创建一个HttpSession对象，主要用于那些需要提供HttpSession对象才能正常工作的拦截器中
debugging：当使用Struts2的开发模式时，该拦截器会提供更多的调试信息
execAndWait：后台执行Action，负责将等待画面发送给用户
exception：负责处理异常。它会将异常映射为结果
fileUpload：用于文件上传。负责解析表单中文件域的内容
i18n：支持国际化。它负责把所选的语言和区域放入用户Session中
logger：负责日志记录。主要是输出Action的名字
modelDriven：用于模型驱动。当Action实现了ModelDriven接口时，它负责把getModel()方法的结果推入ValueStack中
scopedModelDriven：若Action实现ScopedModelDriven接口，它负责从指定生存范围中找出指定Model，并通过setModel()将该Model传给Action实例
params：最基本的一个拦截器，它负责解析HTTP请求中的参数，并将参数值设置成Action对应的属性值
              主要用于在提交表单后，将表单中的参数自动赋值到Action的属性中
prepare：如果Action实现了Preparable接口，将会调用该拦截器的prepare()方法
staticParams：负责将XML中<action/>标签下<param/>标签中的参数传入Action
scope：范围转换拦截器，可以将Action状态信息保存到HttpSession范围或ServletContext范围内
servletConfig：如果某个Action需要直接访问Servlet API，就是通过该拦截器实现的
                        用于将HTTP请求中的HttpServletRequest和HttpServletResponse对象传递给Action对象
roles：JAAS拦截器。Java授权和认证服务Java Authentication and Authorization Service
          只有当浏览者取得合适的授权后，才可以调用被该拦截器拦截的Action
timer：负责输出Action的执行时间。它在分析Action的性能瓶颈时比较有用
token：阻止表单重复提交。它检查传到Action中的token，从而防止多次提交
tokenSession：作用与token基本类似，只是它把token保存在HttpSession中
validation：通过执行在XxxAction-validation.xml中定义的校验器，从而完成数据校验
workflow：负责调用Action类的validate()方法。如果校验失败，则返回input逻辑视图