在上一篇中介绍了Struts拦截器的原理在这一篇中我们将学习一下如何编写自己的拦截器
拦截器的实现
实现一个拦截器非常简单实际上一个拦截器就是一个普通的类只是这个类必须实现comopensymphonyxworkinterceptorInterceptor接口Interceptor接口有如下三个方法
publicinterfaceInterceptorextendsSerializable{voiddestroy();voidinit();Stringintercept(ActionInvocationinvocation)throwsException;}
其中init和destroy方法只在拦截器加载和释放(都由Struts自身处理)时执行一次而intercept方法在每次访问动作时都会被调用Struts在调用拦截器时每个拦截器类只有一个对象实例而所有引用这个拦截器的动作都共享这一个拦截器类的对象实例因此在实现Interceptor接口的类中如果使用类变量要注意同步问题
下面我们来实现一个简单的拦截器这个拦截器通过请求参数action指定一个拦截器类中的方法并调用这个方法(我们可以使用这个拦截器对某一特定的动作进行预处理)如果方法不存在或是action参数不存在则继续执行下面的代码如下面的URL
访问上面的url后拦截器会就会调用拦截器中的test方法如果这个方法不存在则调用invocationinvoke方法invoke方法和Servlet过滤器中调用FilterChaindoFilter方法类似如果在当前拦截器后面还有其他的拦截器则invoke方法就是调用后面拦截器的intercept方法否则invoke会调用Action类的execute方法(或其他的执行方法)
下面我们先来实现一个拦截器的父类ActionInterceptor这个类主要实现了根据action参数值来调用方法的功能代码如下
packageinterceptor;
importcomopensymphonyxworkActionInvocation;importcomopensymphonyxworkinterceptorInterceptor;importjavaxservlethttp*;importorgapachestruts*;publicclassActionInterceptorimplementsInterceptor{protectedfinalStringINVOKE=##invoke;publicvoiddestroy(){Systemoutprintln(destroy);}publicvoidinit(){Systemoutprintln(init);}publicStringintercept(ActionInvocationinvocation)throwsException{HttpServletRequestrequest=ServletActionContextgetRequest();Stringaction=requestgetParameter(action);Systemoutprintln(thishashCode());if(action!=null){try{javalangreflectMethodmethod=thisgetClass()getMethod(action);Stringresult=(String)methodinvoke(this);if(result!=null){if(!resultequals(INVOKE))returnresult;}elsereturnnull;}catch(Exceptione){}}returninvocationinvoke();}}
从上面代码中的intercept方法可以看出在调用action所指定的方法后来判断返回值可能发生的情况有三种
返回值为null执行return null
返回值为INVOKE执行return invockationinvoke()
其他情况执行return resultresult表示指定方法的返回值如上面代码所示
在实现完上面的拦截器父类后任何继承于ActionInterceptor类的拦截器都可以自动根据action的参数值调用自身的相应方法下面我们来实现一个拥有两个动作方法test和print的拦截器类代码如下
packageinterceptor;
importjavaxservlethttpHttpServletResponse;
importorgapachestrutsServletActionContext;
publicclassMultiMethodInterceptorextendsActionInterceptor
{
publicStringtest()throwsException
{
HttpServletResponseresponse=ServletActionContextgetResponse();
responsegetWriter()println(invoketest);
returnthisINVOKE;
}
publicStringprint()throwsException
{
HttpServletResponseresponse=ServletActionContextgetResponse();
responsegetWriter()println(invokeprint);
returnnull;
}
}
est方法返回了INVOKE因此在执行完这个方法后Struts会接着调用其他拦截器的intercept方法或Action类的execute方法而print方法在执行完后只是返回了null而不再调用其他的方法了也就是访问如下的url时动作的execute方法将不会执行
下面我们来实现一个Action类代码如下
packageaction;
importorgapachestruts*;
importcomopensymphonyxworkActionSupport;
publicclassInterceptorActionextendsActionSupport
{
publicStringabcd()throwsException
{
ServletActionContextgetResponse()getWriter()
println(invokeabcd);
returnnull;
}
}
在这个Action类中只有一个abcd方法实际上这个方法相当于execute方法在下面会设置动作的method属性为abcd下面我们来在strutsxml中定义拦截器类和动作代码如下
<?xmlversion=encoding=UTF?>
<!DOCTYPEstrutsPUBLIC
//ApacheSoftwareFoundation//DTDStrutsConfiguration//EN
dtd>
<struts>
<packagename=demoextends=strutsdefaultnamespace=/test>
<interceptors>
<interceptorname=methodclass=interceptorMultiMethodInterceptor/>
<interceptorstackname=methodStack>
<interceptorrefname=method/>
<interceptorrefname=defaultStack/>
</interceptorstack>
</interceptors>
<actionname=interceptorclass=actionInterceptorActionmethod=abcd>
<interceptorrefname=methodStack/>
</action>
</package>
</struts>
在配置上面的methodStack拦截器时要注意最好在后面引用defaultStack否则很多通过拦截器提供的功能将失去
现在访问如下的URL
在浏览器中将会出现如下的字符串
invoke test
invoke abcd
而如果访问将会只出现如下的字符串
invoke print
大家可以看出访问这个url时并没有调用abcd方法如果随便指定的action值的话则只调用abcd方法如访问就只会输出invoke abcd
拦截器的参数
我们在使用很多Struts内置的拦截器时会发现有很多拦截器都带参数当然我们自己做的拦截器也可以加上同样的参数有两个参数比较常用这两个参数是includeMethods和excludeMethods其中includeMethods指定了拦截器要调用的Action类的执行方法(默认是execute)也就是说只有在includeMethods中指定的方法才会被Struts调用而excludeMethods恰恰相反在这个参数中指定的执行方法不会被Struts调用如果有多个方法中间用逗号()分隔在Struts中提供了一个抽象类来处理这两个参数这个类如下
comopensymphonyxworkinterceptorMethodFilterInterceptor
如有继承于这个类的拦截器类都会自动处理includeMethods和excludeMethods参数如下面的拦截器类所示
packageinterceptor;
importcomopensymphonyxworkActionInvocation;
importcomopensymphonyxworkinterceptor*;
publicclassMyFilterInterceptorextendsMethodFilterInterceptor
{
privateStringname;
publicStringgetName()
{
returnname;
}
publicvoidsetName(Stringname)
{
thisname=name;
}
@Override
protectedStringdoIntercept(ActionInvocationinvocation)throwsException
{
Systemoutprintln(doIntercept);
Systemoutprintln(name);
returninvocationinvoke();
}
}
MethodFilterInterceptor的子类需要实现doIntercept方法(相当于Interceptor的intercept方法)如上面代码所示在上面的代码中还有一个name属性是为了读取拦截器的name属性而设置的如下面的配置代码所示
<?xmlversion=encoding=UTF?>
<!DOCTYPEstrutsPUBLIC
//ApacheSoftwareFoundation//DTDStrutsConfiguration//EN
dtd>
<struts>
<packagename=demoextends=strutsdefaultnamespace=/test>
<interceptors>
<interceptorname=methodclass=interceptorMultiMethodInterceptor/>
<interceptorname=filter
class=interceptorMyFilterInterceptor>
<paramname=includeMethods>abcd</param>
<paramname=name>中国</param>
</interceptor>
<interceptorstackname=methodStack>
<interceptorrefname=method/>
<interceptorrefname=filter/>
<interceptorrefname=defaultStack/>
</interceptorstack>
</interceptors>
<actionname=interceptorclass=actionInterceptorActionmethod=abcd>
<interceptorrefname=methodStack/>
</action>
</package>
</struts>
再次访问 Struts就会调用MyFilterInterceptor的doIntercept方法来输出name属性值如果将上面的includeMethods参数值中的abcd去掉则Action类的abcd方法不会被执行