1. 什么是拦截器
拦截器,在AOP(Aspect-Oriented Programming)中用于在某个方法或字段被访问之前,进行拦截然后在之前或之后加入某些操作。拦截是AOP的一种实现策略。
在Webwork的中文文档的解释为——拦截器是动态拦截Action调用的对象。它提供了一种机制可以使开发者可以定义在一个action执行的前后执行的代码,也可以在一个action执行前阻止其执行。同时也是提供了一种可以提取action中可重用的部分的方式。
谈到拦截器,还有一个词大家应该知道——拦截器链(Interceptor Chain,在Struts 2中称为拦截器栈Interceptor Stack)。拦截器链就是将拦截器按一定的顺序联结成一条链。在访问被拦截的方法或字段时,拦截器链中的拦截器就会按其之前定义的顺序被调用。
2.拦截器实现原理
大部分时候,拦截器方法都是通过代理的方式来调用的。Struts 2的拦截器实现相对简单。当请求到达Struts 2的ServletDispatcher时,Struts 2会查找配置文件,并根据其配置实例化相对的拦截器对象,然后串成一个列表(list),最后一个一个地调用列表中的拦截器。
3.拦截器的配置
Struts 2已经为您提供丰富多样的,功能齐全的拦截器实现。可以到struts2的struts2-core-2.1.8.jar包内的struts-default.xml查看关于默认的拦截器与拦截器链的配置,如下:
1. <interceptor-stack name="defaultStack">
2. <interceptor-ref name="exception"/>
3. <interceptor-ref name="alias"/>
4. <interceptor-ref name="servletConfig"/>
5. <interceptor-ref name="i18n"/>
6. <interceptor-ref name="prepare"/>
7. <interceptor-ref name="chain"/>
8. <interceptor-ref name="debugging"/>
9. <interceptor-ref name="scopedModelDriven"/>
10. <interceptor-ref name="modelDriven"/>
11. <interceptor-ref name="fileUpload"/>
12. <interceptor-ref name="checkbox"/>
13. <interceptor-ref name="multiselect"/>
14. <interceptor-ref name="staticParams"/>
15. <interceptor-ref name="actionMappingParams"/>
16. <interceptor-ref name="params">
17. <param name="excludeParams">dojo\..*,^struts\..*</param>
18. </interceptor-ref>
19. <interceptor-ref name="conversionError"/>
20. <interceptor-ref name="validation">
21. <param name="excludeMethods">input,back,cancel,browse</param>
22. </interceptor-ref>
23. <interceptor-ref name="workflow">
24. <param name="excludeMethods">input,back,cancel,browse</param>
25. </interceptor-ref>
26. </interceptor-stack>
<interceptor-stack name="defaultStack">
<interceptor-ref name="exception"/>
<interceptor-ref name="alias"/>
<interceptor-ref name="servletConfig"/>
<interceptor-ref name="i18n"/>
<interceptor-ref name="prepare"/>
<interceptor-ref name="chain"/>
<interceptor-ref name="debugging"/>
<interceptor-ref name="scopedModelDriven"/>
<interceptor-ref name="modelDriven"/>
<interceptor-ref name="fileUpload"/>
<interceptor-ref name="checkbox"/>
<interceptor-ref name="multiselect"/>
<interceptor-ref name="staticParams"/>
<interceptor-ref name="actionMappingParams"/>
<interceptor-ref name="params">
<param name="excludeParams">dojo\..*,^struts\..*</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>
在struts.xml文件中定义拦截器,拦截器栈:
1. <package name="my" extends="struts-default" namespace="/manage">
2.
3. <interceptors>
4.
5. <!-- 定义拦截器 -->
6.
7. <interceptor name="拦截器名" class="拦截器实现类"/>
8.
9. <!-- 定义拦截器栈 -->
10.
11. <interceptor-stack name="拦截器栈名">
12.
13. <interceptor-ref name="拦截器一"/>
14.
15. <interceptor-ref name="拦截器二"/>
16.
17. </interceptor-stack>
18.
19. </interceptors>
20.
21. ......
22.
23. </package>
<package name="my" extends="struts-default" namespace="/manage">
<interceptors>
<!-- 定义拦截器 -->
<interceptor name="拦截器名" class="拦截器实现类"/>
<!-- 定义拦截器栈 -->
<interceptor-stack name="拦截器栈名">
<interceptor-ref name="拦截器一"/>
<interceptor-ref name="拦截器二"/>
</interceptor-stack>
</interceptors>
......
</package>
4.使用拦截器
一旦定义了拦截器和拦截器栈后,就可以使用这个拦截器或拦截器栈来拦截Action了。拦截器的拦截行为将会在Action的exceute方法执行之前被执行。
1. <action name="userOpt" class="org.qiujy.web.struts2.action.UserAction">
2.
3. <result name="success">/success.jsp</result>
4. <result name="error">/error.jsp</result>
5. <!-- 使用拦截器,一般配置在result之后, -->
6. <!-- 引用系统默认的拦截器 -->
7. <interceptor-ref name="defaultStack"/>
8. <interceptor-ref name="拦截器名或拦截器栈名"/>
9.
10. </action>
<action name="userOpt" class="org.qiujy.web.struts2.action.UserAction">
<result name="success">/success.jsp</result>
<result name="error">/error.jsp</result>
<!-- 使用拦截器,一般配置在result之后, -->
<!-- 引用系统默认的拦截器 -->
<interceptor-ref name="defaultStack"/>
<interceptor-ref name="拦截器名或拦截器栈名"/>
</action>
Action指定了一个拦截器,则系统默认的拦截器栈将会失去作用。为了继续使用默认拦截器,所以上面配置文件中手动引入了默认拦截器。
5.自定义拦截器
5.2.使用自定义拦截器
两个步骤:
l通过<interceptor …>元素来定义拦截器。
l通过<interceptor-ref …>元素来使用拦截器。
作为“框架(framework)”,可扩展性是不可或缺的。虽然,Struts 2为我们提供如此丰富的拦截器实现,但是这并不意味我们失去创建自定义拦截器的能力,恰恰相反,在Struts 2自定义拦截器是相当容易的一件事。
5.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方法。