记录一下springboot拦截器

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

/**
 * 拦截器实现HandlerInterceptor接口
 */
@Slf4j
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 {
        String requestURI = request.getRequestURI();
        log.info("LoginInterceptor:preHandle拦截的请求路径是{}",requestURI);

        HttpSession session = request.getSession();
        Object loginUser = session.getAttribute("user");
        if(loginUser != null){
            //放行
            return true;
        }

        //拦截住。
        request.setAttribute("msg","请先登录");
        //response.sendRedirect("/login");
        request.getRequestDispatcher("/login").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 {
        log.info("LoginInterceptor：postHandle执行");
    }

    /**
     *执行过程中发生异常  或  页面渲染成功以后
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("LoginInterceptor：afterCompletion执行");
    }
}

 

/**
 * 拦截器要实现HandlerInterceptor接口
 * 1、将拦截器注册到容器中（实现WebMvcConfigurer的addInterceptors）
 * 2、指定拦截规则【如果是拦截所有，静态资源也会被拦截】
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                //所有请求都被拦截包括静态资源
                .addPathPatterns("/**")
                //放行的请求
                .excludePathPatterns("/login","/css/**","/fonts/**","/images/**","/js/**");
    }
}

 拦截器执行过程：

1、根据当前请求，找到HandlerExecutionChain(可以处理请求的handler以及handler的所有拦截器)

2、先来顺序执行 所有拦截器的 preHandle方法

• 1、如果当前拦截器prehandler返回true，则执行下一个拦截器的preHandle方法。
• 2、如果当前拦截器返回为false。直接倒序执行所有已经执行过了的拦截器的 afterCompletion方法。

3、如果任何一个拦截器的preHandle方法返回false，则直接跳出，不执行目标方法

4、所有拦截器的preHandle方法都返回True，则执行目标方法

5、倒序执行所有拦截器的postHandle方法。

6、前面的步骤有任何异常都会直接倒序执行 afterCompletion方法

7、页面成功渲染完成以后，也会倒序执行 afterCompletion方法