SpringMVC中的处理器拦截器类似于Servlet开发中的Filter过滤器,用于对处理器进行预处理和后处理。本文主要介绍SpringMVC中的拦截器是如何定义的,以及测试拦截器的执行情况和使用方法。
SpringMVC中拦截器的定义和配置
SpringMVC中拦截器的定义
在SpringMVC中,自定义拦截器需要实现HandlerInterceptor接口,并实现该接口中提供的三个方法。
package com.meimeixia.springmvc.interceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
/**
* 自定义拦截器
* @author liayun
*
*/
public class MyInterceptor implements HandlerInterceptor {
/**
* 该方法执行的时机是在Handler执行之后,在返回ModelAndView之后。注意,只要拦截器放行了,那么该方法就会被执行
*
* 适用场景:Handler执行过程中出现异常,可以在此处理异常,或者是清理资源,或者是记录日志等等
*/
@Override
public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
throws Exception {
System.out.println("MyInterceptor.afterCompletion......");
}
/**
* 该方法执行的时机是在Handler执行之后,在返回ModelAndView之前
*
* 适用场景:可以对ModelAndView做些手脚,例如设置页面的共用参数等等
*/
@Override
public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
throws Exception {
System.out.println("MyInterceptor.postHandle......");
}
/**
* 该方法执行的时机是在Controller类方法执行之前,也就是说是在Handler执行之前
*
* 返回值:
* 如果返回true,那么就放行,不拦截,拦截器放行之后,就会处理Controller类里面的方法,正常执行Handler
* 如果返回false,那么就拦截,Handler就不能被正常执行了
*
* 适用场景:进行登录拦截或者权限校验等等
*/
@Override
public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {
System.out.println("MyInterceptor.preHandle......");
//true:放行,false:拦截
return true;//拦截器放行之后,就会处理Controller类里面的方法,正常执行Handler
}
}
针对这三个方法,我做一下简单的分析:
- preHandle方法:该方法执行的时机是在Controller类方法执行之前,也就是说是在Handler执行之前。其应用场景:可以用于身份认证、身份授权等,比如如果认证没有通过表示用户没有登录,那么需要此方法拦截到不再往下执行(return false),否则就放行(return true);
- postHandle方法:该方法执行的时机是在Handler执行之后,在返回ModelAndView之前,可以看到该方法中有个ModelAndView类型的形参。其应用场景:从ModelAndView出发,将公用的模型数据(比如菜单导航之类的)在这里传到视图,也可以在这里统一指定视图;
- afterCompletion方法:该方法执行的时机是在Handler执行之后,在返回ModelAndView之后。其应用场景:统一异常处理(即Handler执行过程中出现异常,可以在此处理异常)、统一日志处理等。
SpringMVC中拦截器的配置
针对某种HandlerMapping配置拦截器
在SpringMVC中,拦截器是针对具体的HandlerMapping进行配置的,也就是说如果在某个HandlerMapping中配置拦截,经过该HandlerMapping映射成功的Handler最终会使用该拦截器。假设如果我们在springmvc.xml配置文件中配置的映射器是org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping
,那么我们可以像下面这样来配置拦截器。
<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">
<property