SpringMVC——拦截器

拦截器概念

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

 

拦截器与过滤器的区别

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

 

入门案例

声明拦截器的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...");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...");
    }
}

 

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

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
       ...
    }
}

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

@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/*"); // 参数可设置多个
    }
}

或者直接使用标准接口WebMvcConfigurer简化开发（注意：侵入式较强）

@Configuration
@ComponentScan("com.cqupt.controller")
@EnableWebMvc
public class SpringMvcConfig implements WebMvcConfigurer {

    @Autowired
    private ProjectInterceptor projectInterceptor;

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

}

 

执行流程

无拦截器

有拦截器

拦截器参数

前置处理

@Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String contentType = request.getHeader("Content-Type");
        System.out.println(contentType);
        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：如果处理器执行完成具有返回结果，可以读取到对应数据与页面信息，并进行调整

 

多拦截器执行顺序

• 当配置多个拦截器时，新城拦截器链
• 拦截器链的运行顺序参照拦截器添加顺序为准
• 当拦截器中出现对原始处理器的拦截（即返回false），后面的拦截器均终止运行
• 当拦截器运行中断，仅运行配置在见面的拦截器的afterCompletion操作