Spring Boot 拦截器设计HandlerInterceptor（Spring Boot之Web）

妖狐艹你老母 2023-02-28 01:44 7阅读 0赞

HandlerInterceptor 的功能跟过滤器类似，但是提供更精细的的控制能力：在request被响应之前、request被响应之后、视图渲染之前以及request全部结束之后。我们不能通过拦截器修改request内容，但是可以通过抛出异常（或者返回false）来暂停request的执行

只有经过DispatcherServlet 的请求，才会走拦截器链，我们自定义的Servlet 请求是不会被拦截的，比如我们自定义的Servlet地址[http://localhost:8080/myServlet][http_localhost_8080_myServlet]1 是不会被拦截器拦截的。并且不管是属于哪个Servlet 只要复合过滤器的过滤规则，过滤器都会拦截

## 拦截器的设计 ##

首先所有的拦截器都需要实现 HandIerInterceptor 接口

public interface HandlerInterceptor {
        // 处理器执行前方法
        default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            return true;
        }
        //处理器处理后方法
        default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
        }
        //处理器完成后方法
        default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
        }
    }

方法执行流程

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70][]

### 实现拦截器的设计 ###

*  创建自定义拦截器并实现HandlerInterceptor 接口
 *  创建java类继承WebMvcConfigurerAdapter，并重写 addInterceptors 方法（配置拦截器）
 *  实例化我们自定义的拦截器，然后将对像手动添加到拦截器链中（在addInterceptors方法中添加）

### 代码示例： ###

/**
    
     * 自定义拦截器1
    
     * @author  Angel
    
     */
    
    publicclass MyInterceptor1 implements HandlerInterceptor {
        @Override
        publicboolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
    
                throws Exception {
    
            System.out.println(">>>MyInterceptor1>>>>>>>在请求处理之前进行调用（Controller方法调用之前）");
    
            returntrue;// 只有返回true才会继续向下执行，返回false取消当前请求
        }
    
     
    
        @Override
        publicvoid postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
                ModelAndView modelAndView) throws Exception {
    
            System.out.println(">>>MyInterceptor1>>>>>>>请求处理之后进行调用，但是在视图被渲染之前（Controller方法调用之后）");
    
        }
    
        @Override
        publicvoid afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
                throws Exception {
            System.out.println(">>>MyInterceptor1>>>>>>>在整个请求结束之后被调用，也就是在DispatcherServlet 渲染了对应的视图之后执行（主要是用于进行资源清理工作）");
        }

public class MyInterceptor2 implements HandlerInterceptor {
    
        @Override
        publicboolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)throws Exception {
            System.out.println(">>>MyInterceptor2>>>>>>>在请求处理之前进行调用（Controller方法调用之前）");
    
            returntrue;// 只有返回true才会继续向下执行，返回false取消当前请求
        }
    
        @Override
        publicvoid postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,ModelAndView modelAndView) throws Exception {
    
            System.out.println(">>>MyInterceptor2>>>>>>>请求处理之后进行调用，但是在视图被渲染之前（Controller方法调用之后）");
        }
    
        @Override
        publicvoid afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
                throws Exception {
            System.out.println(">>>MyInterceptor2>>>>>>>在整个请求结束之后被调用，也就是在DispatcherServlet 渲染了对应的视图之后执行（主要是用于进行资源清理工作）");
    
        }
    }

@Configuration
    public class MyWebAppConfigurer extends WebMvcConfigurerAdapter {
        @Override
        publicvoid addInterceptors(InterceptorRegistry registry) {
    
            // 多个拦截器组成一个拦截器链
    
            // addPathPatterns 用于添加拦截规则
    
            // excludePathPatterns 用户排除拦截
    
            registry.addInterceptor(new MyInterceptor1()).addPathPatterns("/**");
    
            registry.addInterceptor(new MyInterceptor2()).addPathPatterns("/**");
    
            super.addInterceptors(registry);
        }
    }

### 输出 ###

>>>MyInterceptor1>>>>>>>在请求处理之前进行调用（Controller方法调用之前）
    
    >>>MyInterceptor2>>>>>>>在请求处理之前进行调用（Controller方法调用之前）
    
    >>>MyInterceptor2>>>>>>>请求处理之后进行调用，但是在视图被渲染之前（Controller方法调用之后）
    
    >>>MyInterceptor1>>>>>>>请求处理之后进行调用，但是在视图被渲染之前（Controller方法调用之后）
    
    >>>MyInterceptor2>>>>>>>在整个请求结束之后被调用，也就是在DispatcherServlet 渲染了对应的视图之后执行（主要是用于进行资源清理工作）
    
    >>>MyInterceptor1>>>>>>>在整个请求结束之后被调用，也就是在DispatcherServlet 渲染了对应的视图之后执行（主要是用于进行资源清理工作）

[http_localhost_8080_myServlet]: http://localhost:8080/myServlet
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70]: /images/20230209/747ebd4cbab048b4a2971555216de828.png