6.2 预定义的拦截器
6.2.1 预定义的拦截器
一起来看看Struts2中已经定义好的预定义拦截器。Struts2的预定义拦截器都定义在struts-default.xml文件的struts-default包内,定义如下:
java代码:
- <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 name="conversionError" class="org.apache.struts2.interceptor.StrutsConversionErrorInterceptor"/>
- <interceptor name="cookie" class="org.apache.struts2.interceptor.CookieInterceptor"/>
- <interceptor name="clearSession" class="org.apache.struts2.interceptor.ClearSessionInterceptor" />
- <interceptor name="createSession" class="org.apache.struts2.interceptor.CreateSessionInterceptor" />
- <interceptor name="debugging" class="org.apache.struts2.interceptor.debugging.DebuggingInterceptor" />
- <interceptor name="externalRef" 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="modelDriven" class="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"/>
- <interceptor name="scopedModelDriven" class="com.opensymphony.xwork2.interceptor.ScopedModelDrivenInterceptor"/>
- <interceptor name="params" class="com.opensymphony.xwork2.interceptor.ParametersInterceptor"/>
- <interceptor name="actionMappingParams" class="org.apache.struts2.interceptor.ActionMappingParametersInteceptor"/>
- <interceptor name="prepare" class="com.opensymphony.xwork2.interceptor.PrepareInterceptor"/>
- <interceptor name="staticParams" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
- <interceptor name="scope" class="org.apache.struts2.interceptor.ScopeInterceptor"/>
- <interceptor name="servletConfig" 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="tokenSession" class="org.apache.struts2.interceptor.TokenSessionStoreInterceptor"/>
- <interceptor name="validation" class="org.apache.struts2.interceptor.validation.AnnotationValidationInterceptor"/>
- <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" />
- <interceptor name="roles" class="org.apache.struts2.interceptor.RolesInterceptor" />
- <interceptor name="jsonValidation" class="org.apache.struts2.interceptor.validation.JSONValidationInterceptor" />
- <interceptor name="annotationWorkflow" class="com.opensymphony.xwork2.interceptor.annotations.AnnotationWorkflowInterceptor" />
- <interceptor name="multiselect" class="org.apache.struts2.interceptor.MultiselectInterceptor" />
- </interceptors>
由于很多拦截器都是与具体的功能相关联的的,因此这里不去介绍所有的预定义拦截器,只介绍几个常用的,其他的在以后的章节里碰到了再说。
1:params拦截器
这个拦截器是必不可少的,因为就是由它偷偷的把请求参数设置到相应的Action的属性去的,并自动进行类型转换。
2:staticParams拦截器
将struts.xml配置文件里定义的Action参数,设置到对应的Action实例中,Action参数使用<param>标签,是<action>标签的子元素。
struts.xml的示例如下:
java代码:
- <action name="helloworldAction" class="cn.javass.action.action.HelloWorldAction">
- <param name="account">test</param>
- </action>
这要求Action中一定要有一个account的属性,并有相应的getter/setter方法。运行的时候,Action的account属性在初始化过后,会接到这里的赋值“test”。
注意:params拦截器和staticParams拦截器都会为Action的属性赋值,如果碰到了都要赋同一个值呢,比如request里面有account参数,而struts.xml中也有account参数,最终的值是谁?
其实是Action初始化过后,就会把struts.xml中配置的数据设置到Action实例中相应的属性上去。然后,把用户请求的数据设置到Action实例中相应的属性上去。
很明显最后的值是用户请求中account的数据。
3:prepare拦截器
在Action执行之前调用Action的prepare()方法,这个方法是用来准备Action执行之前要做的工作。它要求我们的Action必需实现com.opensymphony.xwork2.Preparable接口
4:modelDriven拦截器
如果Action实现ModelDriven接口,它将getModel()取得的模型对象存入OgnlValueStack中。
5:chain拦截器
将前一个执行结束的Action属性设置到当前的Action中。它被用在ResultType为“chain”所指定的结果的Action中,该结果Action对象会从值栈中获得前一个Action对应的属性,它实现Action链之间的数据传递。
6:execption拦截器
顾名思义,在抛出异常的时候,这个拦截器起作用。它是我们第五章讲的Struts2的错误处理机制(<exception-mapping>)的基础,任何应用都应该引用这个拦截器,而且引用的时候,最好把它放在第一位,让它能捕获所有的异常。
7:validation拦截器
调用验证框架读取 *-validation.xml文件,并且应用在这些文件中声明的校验。
8:token拦截器
核对当前Action请求(request)的有效标识,防止重复提交Action请求 。使用标签<s:token>可以生成表单令牌,该标签会在session中设置一个预期的值并且在表单中创建一个隐藏的input字段。Token拦截器会检查这个令牌,如果不合法,将不会执行action,注意这个拦截器需要手工添加,还需要配置一个invalid.token的result。
9:tokenSession拦截器
扩展了token拦截器的功能,当提交无效的Action请求标识时,它会跳转回到第一次成功后的页面。
10:conversionError拦截器
用来处理框架进行类型转化(Type Conversion)时的出错信息。它将存储在ActionContext中的类型转化(Type Conversion)错误信息转化成相应的Action字段的错误信息,保存在堆栈中。根据需要,可以将这些错误信息在视图中显示出来
11:fileUpload拦截器
用来处理文件上传
12:workflow拦截器
Action默认的工作流,如果action实现了Validateable接口,那么interceptor会调用action的validate()方法;如果action实现了ValidationAware接口,那么interceptor将会检查action是否包含错误信息。如果包含任何错误信息,那么interceptor将会返回input,而不让action执行。
13:servletConfig拦截器
这个拦截器提供Action直接对Servlet API的访问,把Servlet API的对象注入到Action中。包括:ServletRequestAware、ServletResponseAware、ParameterAware、SessionAware、ApplicationAware。
14:timer拦截器
记录ActionInvocation余下部分执行的时间,并做为日志信息记录下来,便于寻找性能瓶颈。
15:logger拦截器
在日志信息中输出要执行的Action信息 ,这样,在调试的时候,就能很快的定位到这个对应的Action了。
先看这么多,其他的预定义拦截器,随着后面的学习再慢慢的展开。
6.2.2 预定义的拦截器栈
在了解了Struts2中预定义的拦截器之后,来看看拦截器栈。
先回顾一下在前面的所有示例,在struts.xml中进行配置的时候,是否有看到任何关于拦截器(interceptor)的身影呢?
答案很明显,是没有看到。也就是说,前面做了这么多示例,既没有声明拦截器,也没有引用拦截器,但是前面又说我们已经使用拦截器了,这到底是怎么回事呢?
其实是因为Struts2有默认的拦截器配置,也就是说,虽然我们没有主动去配置任何关于拦截器的东西,但是Struts2会使用默认引用的拦截器。
由于Struts2的默认拦截器声明和引用都在这个Struts-default.xml里面,因此我们需要到这个文件的struts-default包里去看一下。找到struts-default.xml这个文件中的struts-default包,只留下其中关于拦截器的部分,定义如下:
java代码:
声明:ITeye文章版权属于作者,受法律保护。没有作者书面许可不得转载。