首页 > 代码库 > SpringMVC的拦截器
SpringMVC的拦截器
SpringMVC 中的Interceptor 拦截器也是相当重要和相当有用的,它的主要作用是拦截用户的请求并进行相应的处理。比如通过它来进行权限验证,或者是来判断用户是否登陆,或者是像12306 那样子判断当前时间是否是购票时间。
一、定义Interceptor实现类
SpringMVC 中的Interceptor 拦截请求是通过HandlerInterceptor 来实现的。在SpringMVC 中定义一个Interceptor 非常简单,主要有两种方式,
1.第一种:要定义的Interceptor类实现spring中的HandlerInterceptor接口,或者继承一个实现了HandlerInterceptor接口的类,比如Spring 已经提供的实现了HandlerInterceptor 接口的抽象类HandlerInterceptorAdapte
2.第二种方式是实现Spring的WebRequestInterceptor接口,或者是继承实现了WebRequestInterceptor的类。
(一)实现HandlerInterceptor接口
HandlerInterceptor 接口中定义了三个方法,我们就是通过这三个方法来对用户的请求进行拦截处理的。
(1 )preHandle (HttpServletRequest request, HttpServletResponse response, Object handle) 方法,顾名思义,该方法将在请求处理之前进行调用。当它返回为true时,postHandle和afterCompletion方法才会被执行。
(2)postHandle (HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView)方法,顾名思义就是在当前请求进行处理之后,也就是Controller 方法调用之后执行。
(3)afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex) 方法,顾名思义,该方法将在整个请求结束之后,也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。
1 import javax.servlet.http.HttpServletRequest; 2 import javax.servlet.http.HttpServletResponse; 3 4 import org.springframework.web.servlet.HandlerInterceptor; 5 import org.springframework.web.servlet.ModelAndView; 6 7 public class SpringMVCInterceptor implements HandlerInterceptor { 8 9 10 /** 11 * preHandle方法是进行处理器拦截用的,顾名思义,该方法将在Controller处理之前进行调用,SpringMVC中的Interceptor拦截器是链式的,可以同时存在 12 * 多个Interceptor,然后SpringMVC会根据声明的前后顺序一个接一个的执行,而且所有的Interceptor中的preHandle方法都会在 13 * Controller方法调用之前调用。SpringMVC的这种Interceptor链式结构也是可以进行中断的,这种中断方式是令preHandle的返 14 * 回值为false,当preHandle的返回值为false的时候整个请求就结束了。 15 */ 16 @Override 17 public boolean preHandle(HttpServletRequest request, 18 HttpServletResponse response, Object handler) throws Exception { 19 // TODO Auto-generated method stub 20 return false; 21 } 22 23 /** 24 * 这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。postHandle是进行处理器拦截用的,它的执行时间是在处理器进行处理之 25 * 后,也就是在Controller的方法调用之后执行,但是它会在DispatcherServlet进行视图的渲染之前执行,也就是说在这个方法中你可以对ModelAndView进行操 26 * 作。这个方法的链式结构跟正常访问的方向是相反的,也就是说先声明的Interceptor拦截器该方法反而会后调用,这跟Struts2里面的拦截器的执行过程有点像, 27 * 只是Struts2里面的intercept方法中要手动的调用ActionInvocation的invoke方法,Struts2中调用ActionInvocation的invoke方法就是调用下一个Interceptor 28 * 或者是调用action,然后要在Interceptor之前调用的内容都写在调用invoke之前,要在Interceptor之后调用的内容都写在调用invoke方法之后。 29 */ 30 @Override 31 public void postHandle(HttpServletRequest request, 32 HttpServletResponse response, Object handler, 33 ModelAndView modelAndView) throws Exception { 34 // TODO Auto-generated method stub 35 36 } 37 38 /** 39 * 该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。该方法将在整个请求完成之后,也就是DispatcherServlet渲染了视图执行, 40 * 这个方法的主要作用是用于清理资源的,当然这个方法也只能在当前这个Interceptor的preHandle方法的返回值为true时才会执行。 41 */ 42 @Override 43 public void afterCompletion(HttpServletRequest request, 44 HttpServletResponse response, Object handler, Exception ex) 45 throws Exception { 46 // TODO Auto-generated method stub 47 48 } 49 50 }
(二)使用mvc:interceptors标签来声明需要加入到SpringMVC拦截器链中的拦截器
1 <mvc:interceptors> 2 <!-- 使用bean定义一个Interceptor,直接定义在mvc:interceptors根下面的Interceptor将拦截所有的请求 --> 3 <bean class="com.host.app.web.interceptor.AllInterceptor"/> 4 <mvc:interceptor> 5 <mvc:mapping path="/test/number.do"/> 6 <!-- 定义在mvc:interceptor下面的表示是对特定的请求才进行拦截的 --> 7 <bean class="com.host.app.web.interceptor.LoginInterceptor"/> 8 </mvc:interceptor> 9 </mvc:interceptors>
在mvc:interceptors标签下声明interceptor主要有两种方式:
(1)直接定义一个Interceptor实现类的bean对象。使用这种方式声明的Interceptor拦截器将会对所有的请求进行拦截。
(2)使用mvc:interceptor标签进行声明。使用这种方式进行声明的Interceptor可以通过mvc:mapping子标签来定义需要进行拦截的请求路径。
经过上述两步之后,定义的拦截器就会发生作用对特定的请求进行拦截了
SpringMVC的拦截器