这两天遇到一个需求:在请求action时,校验一下签名的有效性。为了做到统一,在一处地方做校验而不是分散在各个action里做,就用到了拦截器。个人觉得spring mvc中的拦截器和asp.net里面的HttpModule非常类似,都可以在请求在匹配到action之前做拦截。其他的不多说,直接上干货。
这篇讲基于java config的拦截器的实现,具体怎么做呢,其实非常简单,只要两步就可以完成,最后我会附上源代码:
第一步:自定义拦截器。具体来说就是写一个实现HandlerInterceptor接口的类,这个接口有三个方法,三个方法的执行时机不同,可以根据自己的需求看看实现哪一个。
@Component
public class SystemInterceptor implements HandlerInterceptor {
org.slf4j.Logger logger = LoggerFactory.getLogger("interceptor");
/**
* preHandle方法是进行处理器拦截用的,顾名思义,该方法将在Controller处理之前进行调用,
* SpringMVC中的Interceptor拦截器是链式的,可以同时存在多个Interceptor,
* 然后SpringMVC会根据声明的前后顺序一个接一个的执行,
* 而且所有的Interceptor中的preHandle方法都会在Controller方法调用之前调用。
* SpringMVC的这种Interceptor链式结构也是可以进行中断的,
* 这种中断方式是令preHandle的返回值为false,当preHandle的返回值为false的时候整个请求就结束了。
*/
@Override
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler) throws Exception {
HandlerMethod handlerMethod = (HandlerMethod) handler;
logger.error("拦截的Controller:"+handlerMethod.getBeanType().getName());
logger.error("拦截的action:"+handlerMethod.getMethod().getName());
return true;
}
/**
* 这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。
* postHandle是进行处理器拦截用的,它的执行时间是在处理器进行处理之 后, 也就是在Controller的方法调用之后执行,
* 但是它会在DispatcherServlet进行视图的渲染之前执行,也就是说在这个方法中你可以对ModelAndView进行操作。
* 这个方法的链式结构跟正常访问的方向是相反的,也就是说先声明的Interceptor拦截器该方法反而会后调用,
* 这跟Struts2里面的拦截器的执行过程有点像,
* 只是Struts2里面的intercept方法中要手动的调用ActionInvocation的invoke方法,
* Struts2中调用ActionInvocation的invoke方法就是调用下一个Interceptor或者是调用action,
* 然后要在Interceptor之前调用的内容都写在调用invoke之前,要在Interceptor之后调用的内容都写在调用invoke方法之后。
*/
@Override
public void postHandle(HttpServletRequest request,
HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
}
/**
* 该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。
* 该方法将在整个请求完成之后,也就是DispatcherServlet渲染了视图执行, 这个方法的主要作用是用于清理资源的,
*/
@Override
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response, Object handler, Exception ex)
throws Exception {
}
}
第二步:注册自定义拦截器。这一步是基于《基于JavaConfig配置的Spring MVC的构建》完成的,so,请先看下这篇文章,然后就会明白这一切都那么简单~~。这里就一个方法,看一下就明白了,就只说下addPathPatterns的作用,这个方法的作用就是过滤请求的path,只有符合条件的请求path才会被拦截。
@Configuration
@EnableWebMvc
@ComponentScan("com.deepbatis.web")
public class WebConfig extends WebMvcConfigurerAdapter {
/*配置视图解析器*/
@Bean
public ViewResolver viewResolver(){
InternalResourceViewResolver resolver = new InternalResourceViewResolver();
resolver.setPrefix("/WEB-INF/pages/");
resolver.setSuffix(".jsp");
resolver.setExposeContextBeansAsAttributes(true);
return resolver;
}
/*注册拦截器*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new SystemInterceptor()).addPathPatterns("/*");
}
/*配置静态资源的处理*/
@Override
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
configurer.enable();
}
}
最后,跑一下程序就知道是怎么回事了,老样子,放源码: 拦截器的源码在这里