her~~llo,我是你们的好朋友Lyle,是名梦想成为计算机大佬的男人!
博客是为了记录自我的学习历程,加强记忆方便复习,如有不足之处还望多多包涵!非常欢迎大家的批评指正。
今天主要学习关于拦截器的知识。
目录
WebMvcConfigurationSupport简化开发(注意:侵入式较强)
一、拦截器概念
拦截器( Interceptor )是一种动态拦截方法调用的机制,在SpringMVC中动态拦截控制器方法的执行。
作用︰
- 在指定的方法调用前后执行预先设定的代码阻止原始方法的执行
- 阻止原始方法的执行
拦截器与过滤器区别
归属不同:Filter属于Servlet技术,Interceptor属于SpringMVC技术
拦截内容不同:Filter对所有访问进行增强,Interceptor仅针对SpringMVc的访问进行增强
二、入门案例
①声明拦截器的bean,并实现HandlerInterceptor接口(注意:扫描加载bean)
@Component public class Interceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("preHandle..."); return true; //false会拦截原始操作,只进行preHandle } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println("postHandle..."); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println("afterCompletion..."); } }
②定义配置类,继承webMvcConfigurationSupport,实现addInterceptor方法(注意:扫描加载配置)
③添加拦截器并设定拦截的访问路径,路径可以通过可变参数设置多个
@Configuration public class SpringMvcSupport extends WebMvcConfigurationSupport { @Autowired private Interceptor interceptor; @Override protected void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/pages/**").addResourceLocations("/pages/"); registry.addResourceHandler("/css/**").addResourceLocations("/css/"); registry.addResourceHandler("/js/**").addResourceLocations("/js/"); registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/"); } @Override protected void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(interceptor).addPathPatterns("/books","/books/*"); } }
WebMvcConfigurationSupport简化开发(注意:侵入式较强)
其实可以让SpringMvcConfig继承WebMvcConfigurer
@Configuration @ComponentScan({"test.controller"}) @EnableWebMvc public class SpringMvcConfig implements WebMvcConfigurer { @Autowired private Interceptor interceptor; @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/pages/**").addResourceLocations("/pages/"); registry.addResourceHandler("/css/**").addResourceLocations("/css/"); registry.addResourceHandler("/js/**").addResourceLocations("/js/"); registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/"); } @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(interceptor).addPathPatterns("/books","/books/*"); } }
三、拦截器参数
前置处理
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { String contentType = request.getHeader("Content-Type"); System.out.println(handler);//反射获得方法 HandlerMethod hm=(HandlerMethod) handler; Method method = hm.getMethod(); System.out.println(method); System.out.println("preHandle..."+contentType); return true; //false会拦截原始操作,只进行preHandle }
参数
- request:请求对象
- response:响应对象
- handler:被调用的处理器对象,本质上是一个方法对象,对反射技术中的Method对象进行了再包装
返回值
- 返回值为false,被拦截的处理器将不执行
后置处理
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println(modelAndView);//可以获得的数据与页面信息做文章 System.out.println("postHandle..."); }
参数
- modelAndView:如果处理器执行完成具有返回结果,可以读取到对应数据与页面信息,并进行调整
完成后处理
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println(ex);//可以获得执行过程中的异常 System.out.println("afterCompletion..."); }
参数
- ex:如果处理器执行过程中出现异常对象,可以针对异常情况进行单独处理
四、拦截器工作流程分析
单拦截器执行顺序
多拦截器执行顺序
多个拦截器,就是再写多个Interceptor类,一样的配置方法。
拦截器执行顺序和你在下面这个方法中添加的顺序有关。
public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(interceptor).addPathPatterns("/books","/books/*"); registry.addInterceptor(interceptor2).addPathPatterns("/books","/books/*"); }
三个拦截器执行顺序示意图:(返回false指preHandle方法的返回值)
特征:
- 当配置多个拦截器时,形成拦截器链。
- 拦截器链的运行顺序参照拦截器添加顺序为准
- 当拦截器中出现对原始处理器的拦截,后面的拦截器均终止运行
- 当拦截器运行中断,仅运行配置在前面的拦截器的afterCompletion操作
- preHandle:与配置顺序相同,必定运行
- postHandle:与配置顺序相反,可能不运行
- afterCompletion:与配置顺序相反,可能不运行
结语:
SpringMVC拦截器的学习到此结束,那么到这里呢SpringMVC的主要学习到此结束,我是Lyle,我们下次开始学习Maven。