struts2拦截器interceptor的配置方法及使用
转:
1
2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
<struts>
<package name="struts2" extends="struts-default"> <interceptors> <interceptor name="myInterceptor" class="edu.hust.interceptor.MyInterceptor"></interceptor> </interceptors> <action name="register" class="edu.hust.action.RegisterAction"> <result name="input">/register.jsp</result> <result>/result.jsp</result> <!-- 在自定义interceptor并将其ref时, 系统会覆盖掉默认的interceptor-stack(defaultStack), 为了保证系统默认的defaultStack不受印象, 我们需要显式的将其引入 --> <!-- 注意两个interceptor-ref的顺序, 顺序不同, 执行效果也不同: 先配置的先执行/后配置的先退出(先进后出) --> <interceptor-ref name="defaultStack"></interceptor-ref> <interceptor-ref name="myInterceptor"></interceptor-ref> </action> </package> </struts> |
方法2. 配置拦截器栈(即将多个interceptor串联的一种元素)。然后在ion>中引入该拦截器栈就可以了。
1
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
<struts>
<package name="struts2" extends="struts-default"> <interceptors> <interceptor name="myInterceptor" class="edu.hust.interceptor.MyInterceptor"></interceptor> <interceptor-stack name="myInterceptorStack"> <interceptor-ref name="myInterceptor"></interceptor-ref> <interceptor-ref name="defaultStack"></interceptor-ref> </interceptor-stack> </interceptors> <action name="register" class="edu.hust.action.RegisterAction"> <result name="input">/register.jsp</result> <result>/result.jsp</result> <interceptor-ref name="myInterceptorStack"></interceptor-ref> </action> </package> </struts> |
1
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
<struts>
<package name="struts2" extends="struts-default"> <interceptors> <interceptor name="myInterceptor" class="edu.hust.interceptor.MyInterceptor"></interceptor> <interceptor-stack name="myInterceptorStack"> <interceptor-ref name="myInterceptor"></interceptor-ref> <interceptor-ref name="defaultStack"></interceptor-ref> </interceptor-stack> </interceptors> <!-- 此默认interceptor是针对所有action的 --> <!-- 如果某个action中引入了interceptor, 则在这个action中此默认interceptor就会失效 --> <default-interceptor-ref name="myInterceptorStack"></default-interceptor-ref> <action name="register" class="edu.hust.action.RegisterAction"> <result name="input">/register.jsp</result> <result>/result.jsp</result> </action> </package> </struts> |
看到网上很多介绍关于拦截器的文章,感觉都不错,但是都没有很详细全面的介绍,所以我就博众家之长,呵呵,写了篇关于struts拦截器的东西。
拦截器的工作原理如上图,在工作的时候每一个Action请求都被包装在一堆拦截器的内部。拦截器可以在Action执行直线做相似的操作也可以在Action执行直后做回收操作。
每一个Action既可以将操作转交给下面的拦截器,Action也可以直接退出操作返回客户既定的画面。
下面我们来讲讲如何使用struts2拦截器,或者是自定义拦截器。
先说说使用Struts自带的拦截器:
在Struts2中已经在struts-default.xml中预定义了一些自带的拦截器,如timer、params等。如果在标签中继承struts-default,则当前package就会自动拥有struts-default.xml中的所有配置。代码如下:
...
在struts-default.xml中有一个默认的引用,在默认情况下(也就是中未引用拦截器时)会自动引用一些拦截器。这个默认的拦截器引用如下:
- <</span>interceptor-stack name="defaultStack">
- <</span>interceptor-ref name="exception"/>
- <</span>interceptor-ref name="alias"/>
- <</span>interceptor-ref name="servletConfig"/>
- <</span>interceptor-ref name="prepare"/>
- <</span>interceptor-ref name="i18n"/>
- <</span>interceptor-ref name="chain"/>
- <</span>interceptor-ref name="debugging"/>
- <</span>interceptor-ref name="profiling"/>
- <</span>interceptor-ref name="scopedModelDriven"/>
- <</span>interceptor-ref name="modelDriven"/>
- <</span>interceptor-ref name="fileUpload"/>
- <</span>interceptor-ref name="checkbox"/>
- <</span>interceptor-ref name="staticParams"/>
- <</span>interceptor-ref name="params">
- <</span>param name="excludeParams">dojo\..*</</span>param>
- </</span>interceptor-ref>
- <</span>interceptor-ref name="conversionError"/>
- <</span>interceptor-ref name="validation">
- <</span>param name="excludeMethods">input,back,cancel,browse</</span>param>
- </</span>interceptor-ref>
- <</span>interceptor-ref name="workflow">
- <</span>param name="excludeMethods">input,back,cancel,browse</</span>param>
- </</span>interceptor-ref>
- </</span>interceptor-stack>
上面在defaultStack中引用的拦截器都可以在中不经过引用就可以使用(如果在中引用了任何拦截器后,要使用在defaultStack中定义的拦截器,也需要在中重新引用,在后面的“二、通过请求调用Action的setter方法(params)”将详细讲解)。
下面我们来看几个简单的拦截器的使用方法。
一、记录拦截器和execute方法的执行时间(timer拦截器)
timer是Struts2中最简单的拦截器,这个拦截器对应的类是com.opensymphony.xwork2.interceptor.TimerInterceptor。它的功能是记录execute方法和其他拦截器(在timer后面定义的拦截器)的intercept方法执行的时间总和。如下面的配置代码所示:
- <</span>action name="first" class="action.FirstAction">
- <</span>interceptor-ref name="logger"/>
- <</span>interceptor-ref name="timer" />
- </</span>action>
由于在timer后面没有其他的拦截器定义,因此,timer只能记录execute方法的执行时间,在访问first动作时,会在控制台输出类似下面的一条信息:
信息: Executed action [/test/first!execute] took 16
ms.
在使用timer拦截器时,需要commons-logging.jar的支持。将logger引用放到timer的后面,就可以记录logger拦截器的intercept方法和Action的execute方法的执行时间总和,代码如下:
- <</span>action name="first" class="action.FirstAction">
- <</span>interceptor-ref name="timer" />
- <</span>interceptor-ref name="logger"/>
- </</span>action>
大家可以使用如下的Action类来测试一下timer拦截器:
- package action;
- import com.opensymphony.xwork2.ActionSupport;
- public class FirstAction extends ActionSupport
- {
- public String execute() throws Exception
- {
- 2000); // 延迟2秒
- return null;
- }
如果只记录execute方法的执行时间,一般会输出如下的信息:
信息: Executed action [/test/first!execute] took 2000
ms.
二、通过请求调用Action的setter方法(params)
当客户端的一个form向服务端提交请求时,如有一个textfield,代码如下:
- "/test">
- "name"/>
在提交后,Struts2将会自动调用first动作类中的setName方法,并将name文本框中的值通过setName方法的参数传入。实际上,这个操作是由params拦截器完成的,params对应的类是com.opensymphony.xwork2.interceptor.ParametersInterceptor。由于params已经在defaultStack中定义,因此,在未引用拦截器的中是会自动引用params的,如下面的配置代码,在访问first动作时,Struts2是会自动执行相应的setter方法的。
...
...
但如果在中引用了其他的拦截器,就必须再次引用params拦截器,Struts2才能调用相应的setter方法。如下面的配置代码所示:
- <</span>action name="first" class="action.FirstAction">
- <</span>interceptor-ref name="timer" />
- <</span>interceptor-ref name="params"/>
- </</span>action>
三、通过配置参数调用Action的setter方法(static-params)
static-params拦截器可以通过配置标签来调用Action类的相应的setter方法,static-params拦截器对应的类是com.opensymphony.xwork2.interceptor.StaticParametersInterceptor。
下面配置代码演示了如何使用static-params拦截器:
- <</span>action name="first" class="action.FirstAction">
- <</span>interceptor-ref name="timer" />
- <</span>param name="who">比尔</</span>param>
- <</span>interceptor-ref name="params"/>
- <</span>interceptor-ref name="static-params"/>
- </</span>action>
如果first动作使用上面的配置,在访问first动作时,Struts2会自动调用setWho方法将“比尔”作为参数值传入setWho方法。
四、使用拦截器栈
为了能在多个动作中方便地引用同一个或几个拦截器,可以使用拦截器栈将这些拦截器作为一个整体来引用。拦截器栈要在标签中使用和子标签来定义。代码如下:
- <</span>package name="demo" extends="struts-default" >
- <</span>interceptors>
- <</span>interceptor-stack name="mystack">
- <</span>interceptor-ref name="timer" />
- <</span>interceptor-ref name="logger" />
- <</span>interceptor-ref name="params" />
- <</span>interceptor-ref name="static-params" />
- </</span>interceptor-stack>
- </</span>interceptors>
- <</span>action name="first" class="action.FirstAction">
- <</span>param name="who">比尔</</span>param>
- <</span>interceptor-ref name="mystack"/>
- </</span>action>
- </</span>package>
这样以来,我们就可以象使用拦截器一样使用拦截器栈。
如何自定义一个拦截器?
自定义一个拦截器,我们需要三步就可以完成了:
1
自定义一个实现Interceptor接口(或者继承自AbstractInterceptor)的类。
2 在strutx.xml中注册上一步中定义的拦截器。
3
在需要使用的Action中引用上述定义的拦截器,为了方便也可将拦截器定义为默认的拦截器,这样在不加特殊声明的情况下所有的Action都被这个拦截器拦截。
Interceptor接口声明了三个方法:
- public interface Interceptor extends Serializable {
- void destroy();
- void init();
- String intercept(ActionInvocation invocation) throws Exception;
- }
Init方法在拦截器类被创建之后,在对Action镜像拦截之前调用,相当于一个post-constructor方法,使用这个方法可以给拦截器类做必要的初始话操作。
Destroy方法在拦截器被垃圾回收之前调用,用来回收init方法初始化的资源。
Intercept是拦截器的主要拦截方法,如果需要调用后续的Action或者拦截器,只需要在该方法中调用invocation.invoke()方法即可,在该方法调用的前后可以插入Action调用前后拦截器需要做的方法。如果不需要调用后续的方法,则返回一个String类型的对象即可,例如Action.SUCCESS。
另外AbstractInterceptor提供了一个简单的Interceptor的实现,这个实现为:
- public abstract class AbstractInterceptor implements Interceptor {
- public void init() {
- public void destroy() {
- public abstract String intercept(ActionInvocation invocation) throws Exception;
- }
在不需要编写init和destroy方法的时候,只需要从AbstractInterceptor继承而来,实现intercept方法即可。
我们尝试编写一个Session过滤用的拦截器,该拦截器查看用户Session中是否存在特定的属性(LOGIN属性)如果不存在,中止后续操作定位到LOGIN,否则执行原定操作,代码为:
- public class CheckLoginInterceptor extends AbstractInterceptor {
- public static final String LOGIN_KEY = "LOGIN";
- public static final String LOGIN_PAGE = "global.login";
- public String intercept(ActionInvocation actionInvocation) throws Exception {
- System.out.println("begin check login interceptor!");
- // 对LoginAction不做该项拦截
- if (action instanceof LoginAction) {
- "exit check login, because this is login action.");
- return actionInvocation.invoke();
- // 确认Session中是否存在LOGIN
- String login = (String) session.get(LOGIN_KEY);
- if (login != null && login.length() > 0) {
- // 存在的情况下进行后续操作。
- "already login!");
- return actionInvocation.invoke();
- else {
- // 否则终止后续操作,返回LOGIN
- "no login, forward login page!");
- return LOGIN_PAGE;
- }
- }
注册拦截器
- <</span>interceptors>
- <</span>interceptor
- class="com.jpleasure.teamware.util.CheckLoginInterceptor"/>
- <</span>interceptor-stack name="teamwareStack">
- <</span>interceptor-ref name="login"/>
- <</span>interceptor-ref name="defaultStack"/>
- </</span>interceptor-stack>
- </</span>interceptors>
将上述拦截器设定为默认拦截器:
- -interceptor-ref name="teamwareStack"/>
这样在后续同一个package内部的所有Action执行之前都会被login拦截。
注册并引用Interceptor
- <</span>package name="default" extends="struts-default">
- <</span>interceptors>
- <</span>interceptor name="timer" class=".."/>
- <</span>interceptor name="logger" class=".."/>
- </</span>interceptors>
- <</span>action name="login" class="tutorial.Login">
- <</span>interceptor-ref name="timer"/>
- <</span>interceptor-ref name="logger"/>
- <</span>result name="input">login.jsp</</span>result>
- <</span>result name="success"
- type="redirect-action">/secure/home</</span>result>
- </</span>action>
- </</span>package>
可以将多个拦截器合并在一起作为一个堆栈调用,当一个拦截器堆栈被附加到一个Action的时候,要想Action执行,必须执行拦截器堆栈中的每一个拦截器。
- <</span>package name="default" extends="struts-default">
- <</span>interceptors>
- <</span>interceptor name="timer" class=".."/>
- <</span>interceptor name="logger" class=".."/>
- <</span>interceptor-stack name="myStack">
- <</span>interceptor-ref name="timer"/>
- <</span>interceptor-ref name="logger"/>
- </</span>interceptor-stack>
- </</span>interceptors>
- <</span>action name="login" class="tutuorial.Login">
- <</span>interceptor-ref name="myStack"/>
- <</span>result name="input">login.jsp</</span>result>
- <</span>result name="success"
- type="redirect-action">/secure/home</</span>result>
- </</span>action>
- </</span>package>
每一个拦截器都可以配置参数,有两种方式配置参数,一是针对每一个拦截器定义参数,二是针对一个拦截器堆栈统一定义所有的参数,例如:
- <</span>interceptor-ref name="validation">
- <</span>param name="excludeMethods">myValidationExcudeMethod</</span>param>
- </</span>interceptor-ref>
- <</span>interceptor-ref name="workflow">
- <</span>param name="excludeMethods">myWorkflowExcludeMethod</</span>param>
- </</span>interceptor-ref>
或者
- <</span>interceptor-ref name="defaultStack">
- <</span>param name="validation.excludeMethods">myValidationExcludeMethod</</span>param>
- <</span>param name="workflow.excludeMethods">myWorkflowExcludeMethod</</span>param>
- </</span>interceptor-ref>
每一个拦截器都有两个默认的参数:
excludeMethods - 过滤掉不使用拦截器的方法和
includeMethods – 使用拦截器的方法。
需要说明的几点:
1 拦截器执行的顺序按照定义的顺序执行,例如:
- <</span>interceptor-stack name="xaStack">
- <</span>interceptor-ref name="thisWillRunFirstInterceptor"/>
- <</span>interceptor-ref name="thisWillRunNextInterceptor"/>
- <</span>interceptor-ref name="followedByThisInterceptor"/>
- <</span>interceptor-ref name="thisWillRunLastInterceptor"/>
- </</span>interceptor-stack>
的执行顺序为:
- thisWillRunNextInterceptor
- thisWillRunLastInterceptor
- MyAction2 (chain)
- MyResult (result)
- followedByThisInterceptor
- thisWillRunFirstInterceptor
2 使用默认拦截器配置每个Action都需要的拦截器堆栈,例如:
- <</span>action name="login" class="tutorial.Login">
- <</span>interceptor-ref name="timer"/>
- <</span>interceptor-ref name="logger"/>
- <</span>interceptor-ref name="default-stack"/>
- <</span>result name="input">login.jsp</</span>result>
- <</span>result type="redirect-action">/secure/home</</span>result>
- </</span>action>
可以按照如下的方式定义:
- <</span>interceptors>
- <</span>interceptor-stack name="myStack">
- <</span>interceptor-ref name="timer"/>
- <</span>interceptor-ref name="logger"/>
- <</span>interceptor-ref name="default-stack"/>
- </</span>interceptor-stack>
- </</span>interceptors>
- <</span>default-interceptor-ref name="myStack"/>
- <</span>action name="login" class="tutorial.Login">
- <</span>result name="input">login.jsp</</span>result>
- <</span>result type="redirect-action">/secure/home</</span>result>
- </</span>action>
3
如何访问HttpServletRequest,HttpServletResponse或者HttpSession
有两种方法可以达到效果,使用ActionContext:
- Map attibutes = ActionContext.getContext().getSession();
或者实现相应的接口:
- HttpServletRequest ServletRequestAware
- HttpServletResponse ServletResponseAware
Struts2(XWork)提供的拦截器的功能说明:
- Alias Interceptor——alias——在不同请求之间将请求参数在不同名字件转换,请求内容不变
- Chaining
Interceptor——chain——让前一个Action的属性可以被后一个Action访问,现在和chain类型的result()结合使用。 - Checkbox
Interceptor——checkbox——添加了checkbox自动处理代码,将没有选中的checkbox的内容设定为false,而html默认情况下不提交没有选中的checkbox。 - Cookies Interceptor—— Cookies—— 使用配置的name,value来是指cookies
- Conversion Error Interceptor—— conversionError——
将错误从ActionContext中添加到Action的属性字段中。 - Create Session Interceptor—— createSession——
自动的创建HttpSession,用来为需要使用到HttpSession的拦截器服务。 - Debugging Interceptor—— Debugging—— 提供不同的调试用的页面来展现内部的数据状况。
- Execute and Wait Interceptor—— execAndWait——
在后台执行Action,同时将用户带到一个中间的等待页面。 - Exception Interceptor—— exception—— 将异常定位到一个画面
- File Upload Interceptor—— fileUpload—— 提供文件上传功能
- I18n Interceptor—— i18n—— 记录用户选择的locale
- Logger Interceptor—— logger—— 输出Action的名字
- Message Store Interceptor—— store——
存储或者访问实现ValidationAware接口的Action类出现的消息,错误,字段错误等。 - Model Driven Interceptor—— model-driven——
如果一个类实现了ModelDriven,将getModel得到的结果放在Value Stack中。 - Scoped Model Driven—— scoped-model-driven——
如果一个Action实现了ScopedModelDriven,则这个拦截器会从相应的Scope中取出model调用Action的setModel方法将其放入Action内部。 - Parameters Interceptor—— params—— 将请求中的参数设置到Action中去。
- Prepare Interceptor—— Prepare——
如果Acton实现了Preparable,则该拦截器调用Action类的prepare方法。 - Scope Interceptor—— Scope——
将Action状态存入session和application的简单方法。 - Servlet Config Interceptor—— servletConfig——
提供访问HttpServletRequest和HttpServletResponse的方法,以Map的方式访问。 - Static Parameters Interceptor—— staticParams——
从struts.xml文件中将中的中的内容设置到对应的Action中。 - Roles Interceptor—— roles—— 确定用户是否具有JAAS指定的Role,否则不予执行。
- Timer Interceptor—— timer—— 输出Action执行的时间
- Token Interceptor—— token—— 通过Token来避免双击
- Token Session Interceptor—— tokenSession—— 和Token
Interceptor一样,不过双击的时候把请求的数据存储在Session中 - Validation Interceptor—— validation——
使用action-validation.xml文件中定义的内容校验提交的数据。 - Workflow Interceptor—— workflow——
调用Action的validate方法,一旦有错误返回,重新定位到INPUT画面 - Parameter Filter Interceptor—— N/A—— 从参数列表中删除不必要的参数
- Profiling Interceptor—— profiling—— 通过参数激活profile
- 拦截器
名字
说明
struts2拦截器interceptor的配置方法及使用的更多相关文章
- struts2拦截器interceptor的三种配置方法
1.struts2拦截器interceptor的三种配置方法 方法1. 普通配置法 <struts> <package name="struts2" extend ...
- struts2 拦截器 interceptor
struts2 拦截器详解:http://struts2.group.iteye.com/group/wiki/1397-deep-into-struts2-interceptors
- Struts2拦截器Interceptor执行顺序理解
invocation.invoke()方法是拦截器框架的实现核心,通过确定invocation.invoke()方法执行位置,来实现Action执行前后处理操作,在invocation.invoke( ...
- Struts2拦截器的配置
struts2拦截器interceptor的三种配置方法方法1. 普通配置法 <struts> <package name="struts2" extends=& ...
- Struts2拦截器的使用 (详解)
Struts2拦截器的使用 (详解) 如何使用struts2拦截器,或者自定义拦截器.特别注意,在使用拦截器的时候,在Action里面必须最后一定要引用struts2自带的拦截器缺省堆栈default ...
- Struts拦截器Interceptor
Struts2 拦截器 [Interceptor] 拦截器的工作原理如上图,每一个Action请求都包装在一系列的拦截器的内部.拦截器可以在Action执行直线做相似的操作也可以在Action执行直后 ...
- SSM-SpringMVC-33:SpringMVC中拦截器Interceptor讲解
------------吾亦无他,唯手熟尔,谦卑若愚,好学若饥------------- 拦截器Interceptor: 对处理方法进行双向的拦截,可以对其做日志记录等 我选择的是实现Handler ...
- Struts2 拦截器配置以及实现
@(Java ThirdParty)[Struts|Interceptor] Struts2 拦截器配置以及实现 Struts2的拦截器应用于Action,可以在执行Action的方法之前,之后或者两 ...
- struts2学习笔记--拦截器(Interceptor)和登录权限验证Demo
理解 Interceptor拦截器类似于我们学过的过滤器,是可以在action执行前后执行的代码.是我们做web开发是经常使用的技术,比如权限控制,日志.我们也可以把多个interceptor连在一起 ...
随机推荐
- SpingMVC的<context:component-scan>包扫描踩坑记录
公司项目配置的Spring项目的包扫描有点问题,出现了一个被Spring容器管理的Bean被创建了2次的现象.在此记录下解决的过程,方便后续查阅. 改动前: 容器启动监听器中会扫描全部包,创建 ...
- pygame 入门实例
本文基于win7(64) + py3.5(64)环境. 本文是这里的一篇学习笔记.加入了自己的理解. 本文最终目的是实现一个飞机躲避导弹的游戏. 1.核心概念 pygame 的核心概念有: Surfa ...
- 蒙提霍尔游戏 python 模拟
本文使用蒙特卡罗方法验证蒙提霍尔游戏的结论. 以下代码,本人原创! 完整代码 import random # 蒙提霍尔游戏 def play_game(strategy='nonchange'): # ...
- 洛咕 P3700 [CQOI2017]小Q的表格
洛咕 P3700 [CQOI2017]小Q的表格 神仙题orz 首先推一下给的两个式子中的第二个 \(b\cdot F(a,a+b)=(a+b)\cdot F(a,b)\) 先简单的想,\(F(a,a ...
- java 自定义异常输出信息(使用构造器)
throw new Exception("上传的脚本类型不匹配,当前只支持类unix系列的远程扫描,请上传后缀名为 .sh .pl 的脚本文件"); 这样就可以了,结合配置的异常信 ...
- mpvue两小时,产出一个《点钞辅助工具》小程序
CoffeeScript,Pug,Sass使用 以下内容门槛较高,如看不懂或觉得需要继续了解,结尾处放置了原视频流程与GitHub地址,欢迎琢磨与Star,谢谢. 文章不做技术语法解读,如不清楚,请前 ...
- C#字符串截取、获取当前电脑时间、判断输入日期对错 随手记
字符串截取:这个就当复习了,看意见就可以 //身份证生日截取 //Console.WriteLine("请输入18位身份证号:"); //string x = Console.Re ...
- 总结com组件问题,随笔记录
一.从 IClassFactory 为 CLSID 为 {00024500-0000-0000-C000-000000000046} 的 COM 组件创建实例失败,原因是出现以下错误:80010001 ...
- hive orc压缩数据异常java.lang.ClassCastException: org.apache.hadoop.io.Text cannot be cast to org.apache.hadoop.hive.ql.io.orc.OrcSerde$OrcSerdeRow
hive表在创建时候指定存储格式 STORED AS ORC tblproperties ('orc.compress'='SNAPPY'); 当insert数据到表时抛出异常 Caused by: ...
- PAT甲题题解-1111. Online Map (30)-PAT甲级真题(模板题,两次Dijkstra,同时记下最短路径)
题意:给了图,以及s和t,让你求s到t花费的最短路程.最短时间,以及输出对应的路径. 对于最短路程,如果路程一样,输出时间最少的. 对于最短时间,如果时间一样,输出节点数最少的. 如果最短路程 ...