SpringMVC拦截器

拦截器

底层就是AOP

• 拦截器（Interceptor）是一种动态拦截方法调用的机制，在SpringMVC中动态拦截控制器方法的执行
• 作用
  在指定的方法调用前后执行预先设定的代码
  阻止原始方法的执行

拦截器与过滤器区别

归属不同：Filter属于Servlet技术，Interceptor属于SpringMVC技术
拦截内容不同：Filter对所有访问进行增强，Interceptor仅针对SpringMVC的访问进行增强

拦截器入门案例

1. 声明拦截器的bean，并实现HandlerInterceptor接口（注意：扫描加载bean）

@Component
public class ProjectInterceptor implements HandlerInterceptor {
    //在原始被拦截的操作之前运行
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle");
        return true;
    }

    //在原始被拦截的操作之后运行
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");
    }

    //在原始被拦截的操作之后运行，并且在postHandle之后运行
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion");
    }
}

2. 定义配置类，继承WebMvcConfigurationSupport，实现addInterceptor方法（注意：扫描加载配置）

3. 添加拦截器并设定拦截的访问路径，路径可以通过可变参数设置多个

@Configuration
public class SpringMVCSupport extends WebMvcConfigurationSupport {
    @Autowired
    private ProjectInterceptor projectInterceptor;

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
    }

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");
    }
}

执行流程

拦截器参数

前置处理

    //在原始被拦截的操作之前运行
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle");
        return true;
    }

• 参数
  request：请求对象
  response：响应对象
  handler：被调用的处理器对象，本质上是一个方法对象，对反射技术中的Method对象进行了再包装

• 返回值
  返回值为false，被拦截的处理器将不执行

后置处理

    //在原始被拦截的操作之后运行
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");
    }

• 参数
  modelAndView：如果处理器执行完成具有返回结果，可以读取到对应数据与页面信息，并进行调整

完成后处理

    //在原始被拦截的操作之后运行，并且在postHandle之后运行
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion");
    }

• 参数
  ex：如果处理器执行过程中出现异常对象，可以针对异常情况进行单独处理

多个拦截器的执行顺序

与下面类中的addInterceptors中定义顺序有关

@Configuration
public class SpringMVCSupport extends WebMvcConfigurationSupport {
    @Autowired
    private ProjectInterceptor projectInterceptor;

    @Autowired
    private ProjectInterceptor2 projectInterceptor2;

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
    }

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");
        registry.addInterceptor(projectInterceptor2).addPathPatterns("/books","/books/*");
    }
}

执行顺序

• 当配置多个拦截器时，形成拦截器链
• 拦截器链的运行顺序参照拦截器添加顺序为准
• 当拦截器中出现对原始拦截器的拦截，后面的拦截器均终止运行
• 当拦截器运行中断，仅运行配置在前的拦截器的afterCompletion操作
  

拦截器链的运行顺序

• preHandle：与配置顺序相同，必定运行
• postHandle：与配置顺序相反，可能不运行
• afterCompletion：与配置顺序相反，可能不运行