SpringBoot自定义拦截器

以用户登录拦截为例需要先登录才能访问资源，除了登录页面和根页面

1.编写一个拦截器实HandlerInterceptor接口

public class LoginInterceptor implements HandlerInterceptor {

    /**
     * 执行方法之前的处理
     * 如何进行拦截
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        Object loginUser = request.getSession().getAttribute("loginUser");
        if (loginUser != null) {
            return true;
        }
        request.setAttribute("msg", "请登录");
        RequestDispatcher dispatcher = request.getRequestDispatcher("/");
        dispatcher.forward(request, response);
        return false;
    }
    /**
     * 执行方法之后
     *
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }
    /**
     * 页面渲染之后
     *
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

2.把拦截器注册到容器中，注意指定好拦截规则，静态资源需要放行

实现WebMvcConfigurer中的addInterceptors方法进行填加拦截器和拦截规则
方式一

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**")   // 拦截哪些资源路径 静态资源也会被拦截  
                .excludePathPatterns("/", "/login", "/css/**", "/front/**", "/image/**", "/js/**");  // 排除不需要拦截的资源
    }
}

方式二
当然也可以采用@Bean注解方式，匿名内部类给容器中加一个WebMvcConfigurer

@Bean
    public WebMvcConfigurer webMvcConfigurer() {
        return new WebMvcConfigurer() {

            @Override
            public void addInterceptors(InterceptorRegistry registry) {
                registry.addInterceptor(new LoginInterceptor())
                        .addPathPatterns("/**")   // 静态资源也会被拦截
                        .excludePathPatterns("/", "/login", "/css/**", "/front/**", "/image/**", "/js/**");
            }
        };
    }

3.拦截器原理

1. 根据当前请求，找到HandlerExecutionChain【可以处理请求的handler以及handler的所有 拦截器
2. 先来顺序执行 所有拦截器的 preHandle方法
   2.1 如果当前拦截器prehandler返回为true。则执行下一个拦截器的preHandle
   2.2 如果当前拦截器返回为false。直接 倒序执行所有已经执行了的拦截器的 afterCompletion；
3. 如果任何一个拦截器返回false。直接跳出不执行目标方法
4. 所有拦截器都返回True。执行目标方法
5. 倒序执行所有拦截器的postHandle方法。
6. 前面的步骤有任何异常都会直接倒序触发 afterCompletion
7. 页面成功渲染完成以后，也会倒序触发 afterCompletion