【SpringMVC】拦截器

👉 博客主页：准Java全栈开发工程师
👉 00年出生，即将进入职场闯荡，目标赚钱，可能会有人觉得我格局小、觉得俗，但不得不承认这个世界已经不再是以一条线来分割的平面，而是围绕财富旋转的球面，成为有钱人不是为了去掌控球体的转向，而是当有人恶意掌控时，努力保护好家人和自己。

一、拦截器概念

1、什么是拦截器？

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

2、拦截器的作用？

• 在指定方法调用前后执行预先设定的代码。
• 阻止原始方法的执行，当 preHandle 方法返回 false 时会阻止原始方法的执行。
• 总结：拦截器就是用来做增强的。

3、拦截器 VS 过滤器

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

二、自定义拦截器

1、自定义拦截器类

• 该类需要实现 HandlerInterceptor 接口，并重写 3 个方法。

@Component
public class ProjectInterceptor implements HandlerInterceptor {
    // 原始方法调用前执行的方法
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle ...");
        return true;
    }

    // 原始方法调用后执行的方法
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle ...");
    }

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

2、配置拦截器类

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {

    @Autowired
    private ProjectInterceptor projectInterceptor;

    @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) {
    	// 当遇到 /users或/users/* 请求时，会执行拦截器方法进行判断
        registry.addInterceptor(projectInterceptor).addPathPatterns("/users","/users/*");
    }
}

• 在 放行静态资源 时，就涉及到了该类的实现。
• 配置拦截器的方式和配置资源处理器是非常相似的，可类比学习。

3、测试

• 在 Postman 工具中测试，请求路径为 http://localhost:8080/users ，如果拦截器配置成功是能够执行拦截方法的。

4、执行顺序

• 当有拦截器时，请求会先进入 preHandle 方法。
• 如果方法返回 true，则放行继续执行原始方法和拦截器中的 postHandle 和 afterCompletion 方法。
• 如果返回 false，则直接跳过后面方法的执行。

三、拦截器链

1、实现拦截器链

• 自定义多个拦截器，多个拦截器形成一个拦截器链。

@Component
public class ProjectInterceptor2 implements HandlerInterceptor {
    // 原始方法调用前执行的方法
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle22222 ...");
        return true;
    }

    // 原始方法调用后执行的方法
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle22222 ...");
    }

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

• 执行顺序会按照配置顺序进行。

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

• 执行结果。
  

2、执行顺序

• 拦截器链的运行顺序参照拦截器添加顺序。
• 当拦截器中出现对原始处理器的拦截，后面的拦截器均终止运行。
• 当拦截器运行中断，仅运行配置在前面的拦截器的afterCompletion操作。

• 当拦截器 3 的 pre3 方法返回 false 时，会跳过原始方法、所有拦截器 postHandle方法以及 拦截器 3 的 afterCompletion 方法的执行。

• 总结如下：

• preHandle：与配置顺序相同，必定运行

• postHandle：与配置顺序相反，可能不运行

• afterCompletion：与配置顺序相反，可能不运行。

• 最后还是要以运行结果为准。

👉 以上就是文章的全部内容啦，诸佬如果有任何建议都可以提哦。
👉 创作不易，如果觉得对您有帮助的话，欢迎关注✨点赞👍收藏📂哦。