Spring MVC 拦截器

SpringMVC 中的 Interceptor 拦截器是非常重要和相当有用的，它的主要作用是拦截指定的用户请求，并进行相应的预处理与后处理

拦截器，其拦截的时间点在“处理器映射器根据用户提交的请求映射出了所要执行的处理器类，并且也找到了要执行该处理器类的处理器适配器，在处理器适配器执行处理器之前”。 当然，在处理器映射器映射出所要执行的处理器类时，已经将拦截器与处理器组合为了一个处理器执行链，并返回给了中央调度器。

拦截器和过滤器的区别

  • 过滤器是servlet规范的一部分，任何javaweb工具都能够使用。

  • 过滤器基于回调函数。

  • 拦截器是spring的AOP思想的具体应用，拦截器是基于反射机制。

  • 拦截器是springmvc自己的，只有springmvc框架的工程才能使用。

  • 拦截器只会拦截访问的控制方法，对静态资源，不走controller的资源是不用的。

  • 拦截器可以获取IOC容器中的各个bean，而过滤器就不行，这点很重要，在拦截器里注入一个service，可 以调用业务逻辑。

拦截器的实现

自定义拦截器，需要实现 HandlerInterceptor 接口。而该接口中含有三个方法：

➢ preHandle(request,response, Object handler)： 该方法在处理器方法执行之前执行。其返回值为 boolean，若为 true，则紧接着会执行处理器方法，且会将 afterCompletion()方法放入到一个专门的方法栈中等待执行。

➢ postHandle(request,response, Object handler,modelAndView)： 该方法在处理器方法执行之后执行。处理器方法若最终未被执行，则该方法不会执行。 由于该方法是在处理器方法执行完后执行，且该方法参数中包含 ModelAndView，所以该方法可以修改处理器方法的处理结果数据，且可以修改跳转方向。

➢ afterCompletion(request,response, Object handler, Exception ex)： 当 preHandle()方法返回 true 时，会将该方法放到专门的方法栈中，等到对请求进行响应的所有工作完成之后才执行该方法。即该方法是在中央调度器渲染（数据填充）了响应页面之后执行的，此时对 ModelAndView 再操作也对响应无济于事。 afterCompletion 最后执行的方法，清除资源，例如在 Controller 方法中加入数据

实现

/**
* 创建自定义拦截器实现HandlerInterceptor接口
*/
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("拦截器在处理器方法执行前拦截。");
        return true;
    }
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("拦截器在处理器方法执行后处理");
    }
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("拦截器一定会执行的方法");
    }
}
/**
* 注册自定义拦截器
*/
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
     @Autowired
    private MyInterceptor myInterceptor;
    
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //注册注入的自定义拦截器
        //excludePathPatterns 表示排除的路径,addPathPatterns表示拦截路径
        registry.addInterceptor(myInterceptor).
                excludePathPatterns("/index").
                addPathPatterns("/**");
    }
}

当有多个拦截器时，形成拦截器链。拦截器链的执行顺序，与其注册顺序一致。需要再次强调一点的是，当某一个拦截器的 preHandle()方法返回 true 并被执行到时，会向一个专门的方法栈中放入该拦截器的 afterCompletion()方法。

注意：每次通过servlet，也就是处理器controller的请求都会经过拦截器。（指定路径的情况下）