SpringMVC拦截器Interceptor

拦截器

概念：

是一种动态的拦截方法调用的机制，在SpringMVC中动态拦截控制器方法的执行

作用：

• 在指定方法调用的前后执行预先设定好的代码
• 阻止原始方法的执行

拦截器与过滤器区别

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

拦截器入门案例

• 第一步：创建一个拦截器bean类并且实现接口HandlerInterceptor，SpringMVC容器上要加载bean，建议创建在controller包下，SpringMVC配置类上不用加载，简化开发

  • @Component
    //定义拦截器类，实现HandlerInterceptor接口
    //注意当前类必须受Spring容器控制
    public class ProjectInterceptor implements HandlerInterceptor {
    }

• 第二步：在Servlel自定义过滤器配置类中重写 addInterceptors 方法，并加载拦截器bena（使用自动装配）和设置需要拦截的路径

@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/*");
//  /books 表示只拦截/books的请求，/books后的请求不会拦截，比如/books/100
//而/books/*会拦截/books后的所有请求
    }
}

拦截器详解

实现HandlerInterceptor接口的拦截器bean类可以重写preHandle ，postHandle ，afterCompletion这三个方法

public class ProjectInterceptor implements HandlerInterceptor {
    @Override
    //原始方法调用前执行的内容
    //返回值类型可以拦截控制的执行，true放行，false终止
    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...");
    }

    @Override
    //原始方法调用完成后执行的内容
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...");
    }
}

这三个方法分别代表，前置处理，后置处理，完成后处理，对应方法里可以写入业务代码，比如前置处理的放法里可以判断是否符合相关条件如果符合条件，就返回ture，代表可以通过，那请求也会得到对应的响应，并且后面的两个方法都会被执行，如果返回false，代表不符合条件，请求会被拦截，之后的两个方法也不会被执行。

简化开发

Servlet自定义过滤器配置类和SpringMVC配置类是在同一层的，让SpringMVC配置类实现接口WebMvcConfigurer

@Configuration
@ComponentScan({"com.itheima.controller"})
@EnableWebMvc
//实现WebMvcConfigurer接口可以简化开发，但具有一定的侵入性
public class SpringMvcConfig implements WebMvcConfigurer{
    @Autowired
    private ProjectInterceptor projectInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");

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

可以看到，实现WebMvcConfigurer接口也是可以重写addInterceptors和addResourceHandlers这两个方法的

这写以下写法作用相同，但侵入性较强

@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/*");
    }
}

拦截器执行流程

拦截器参数

在拦截器bena里，分别有三个方法

ublic class ProjectInterceptor implements HandlerInterceptor {
    @Override
    //原始方法调用前执行的内容
    //返回值类型可以拦截控制的执行，true放行，false终止
    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...");
    }

    @Override
    //原始方法调用完成后执行的内容
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...");
    }
}

• 前置处理方法preHandle
  • 参数：
    • request:
    • response :这两个参数，一个可以获取请求参数，一个可以对请求参数做出响应
    • handler:被调用处理器对象，本质上是一个方法对象，对反射技术的Method都对象进行了再包装
  • 返回值：false被拦截的处理器不执行，反之执行
• 后置处理方法postHandle
  • 参数
    • modelAndView：当拦截后的处理器有返回结果，可以读取对应的数据与视图信息，进调整
• 完成后处理方法afterCompletion
  • 参数
    • Exception ex ：如果处理器执行过程中出现异常，可以针对异常情况进行 单独处理

多拦截器

• 多拦截器执行顺序
• 当配置多个拦截器时，形成拦截器链
• 拦截器链的运行顺序按照拦截器添加顺序为准
• 当拦截器中出现对与那是处理器拦截，后面的拦截器均终止运行
• 当拦截器运行中断，仅运行配置在前面的拦截器的afterCompletion方法里的操作
• preHandle方法里的操作是按照添加拦截器的顺序来执行的，其余两个方法是反顺序执行