【Spring Boot2】拦截器
目录
- 实现拦截器步骤
- 一、HandlerInterceptor
- 二、容器
- 三、拦截范围
- 原理
实现拦截器步骤
一、HandlerInterceptor
编写一个拦截器实现HandlerInterceptor接口
/**
* 登录检查
* 1.配置好拦截器要拦哪些请求
* 2.把这些配置放在容器中
*/
@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 requestUrl = request.getRequestURI();
log.info("preHandle拦截的请求路径是{}", requestUrl);
// 登录检查逻辑
HttpSession session = request.getSession();
Object loginUser = session.getAttribute("loginUser");
if (loginUser != null) {
// 放行
return true;
}
// 拦截住 未登录 跳转到登录页面
session.setAttribute("msg", "请先登录");
// response.sendRedirect("/");
request.getRequestDispatcher("/").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("postHandle执行{}", modelAndView);
}
/**
* 页面渲染以后
*
* @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("afterCompletion执行异常{}", ex);
}
}
二、容器
拦截器注册到容器中,实现WebMvcConfigurer的addInterceptors
@Configuration
public class AdminWebConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LoginInterceptor())
// 所有请求都被拦截包括静态资源
.addPathPatterns("/**")
// 不被拦截的资源
.excludePathPatterns("/", "/login","/css/**","/images/**","/js/**");
}
}
三、拦截范围
指定拦截规则,如果是拦截所有,静态资源也会被拦截(如前后端不分离的时候,前端东西会被拦截,目前来说大多数我们都是前后端分离开发,道理明白就好)
原理
- 根据当前请求,找到HandlerExecutionChain。
- 先来顺序执行所有拦截器的preHandle方法。
-
如果当前拦截器preHandler返回为true,则执行下一个拦截器的preHandler。
-
如果当前拦截器返回为false,直接倒序执行所有已经执行了的拦截器的afterCompletion。
-
如果任何一个拦截器返回false,直接跳出不执行目标方法。
-
所有拦截器都返回true,执行目标方法。
-
倒序执行所有拦截器的postHandle方法。
-
前面的步骤有任何异常都会直接倒序触发afterCompletion。
-
页面成功渲染完成以后,也会倒序触发afterCompletion。