一、Interceptor定义:
拦截器是在面向切面编程中应用的,就是在你的service或者一个方法前调用一个方法,或者在方法后调用一个方法。是基于JAVA的反射机制(在一个服务中定义的话,它会对所有请求进行拦截)
1.拦截器(Interceptor)执行顺序:
1. 请求到达 DispatcherServlet
2. DispatcherServlet 发送至 Interceptor ,执行 preHandle
3. 请求达到 Controller
4. 请求结束后,postHandle 执行
2.拦截器(Interceptor)和过滤器(Filter)的执行顺序
过滤前->拦截前->Action处理->拦截后->过滤后
3.使用方法
1)预处理preHandle()方法
用户发送请求时,先执行preHandle()方法。会先按照顺序执行所有拦截器的preHandle方法,一直遇到return false为止,比如第二个preHandle方法是return false,则第三个以及以后所有拦截器都不会执行。若都是return true,则执行用户请求的url方法。
2)后处理postHandle()方法
调用了Service并返回ModelAndView,但未进行页面渲染,可以在这里继续修改ModelAndView
3)返回处理afterCompletion()方法
已经渲染了页面,在afterCompletion中,可以根据ex是否为null判断是否发生了异常,进行日志记录。
注:一般使用preHandle这个拦截器进行预处理,对url进行请求拦截
使用demo:
package sca.pro.system.common.request;
import cn.hutool.core.net.URLDecoder;
import cn.hutool.json.JSONUtil;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
import sca.pro.common.contants.Contants;
import sca.pro.common.jwt.MapInfo;
import sca.pro.common.response.HttpCode;
import sca.pro.common.response.HttpResult;
import sca.pro.system.common.util.ServletUtils;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.lang.reflect.Method;
/**
* @author shq
* @description Request拦截器
* @createDate 2022-5-27
* @updateUser
* @updateDate
* @updateRemark
*/
public class RequestContextInterceptor extends HandlerInterceptorAdapter {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
if (!(handler instanceof HandlerMethod)) {
return true;
}
Method method = ((HandlerMethod) handler).getMethod();
if (!method.isAnnotationPresent(AuthInfoRequired.class)) {
return true;
}
AuthInfoRequired annotation = method.getAnnotation(AuthInfoRequired.class);
if (!annotation.required()) {
return true;
}
if (initHeaderContext(request)) {
return super.preHandle(request, response, handler);
} else {
returnJson(response, JSONUtil.toJsonStr(new HttpResult().builder()
.code(HttpCode.UNAUTHORIZED).build()));
return false;
}
}
private boolean initHeaderContext(HttpServletRequest request) {
String mapInfoStr = ServletUtils.URLDecoderString(request.getHeader(Contants.JWT_MAP_KEY));
if (mapInfoStr != null) {
try {
MapInfo mapInfo = JSONUtil.toBean(mapInfoStr, MapInfo.class);
new RequestContext.RequestContextBuild()
.mapInfo(mapInfo)
.bulid();
if (mapInfo.getUsername() == null) {
return false;
}
return true;
} catch (Exception e) {
return false;
}
} else {
return false;
}
}
private void returnJson(HttpServletResponse response, String json) throws Exception {
PrintWriter writer = null;
response.setCharacterEncoding("UTF-8");
response.setContentType("text/html; charset=utf-8");
try {
writer = response.getWriter();
writer.print(json);
} catch (IOException e) {
} finally {
if (writer != null)
writer.close();
}
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
RequestContext.clean();
super.postHandle(request, response, handler, modelAndView);
}
}
二,WebMvcConfigurer注册拦截器(WebMvcConfigurer不仅可以配置拦截器,还可以配置过滤器,跨域访问,请求参数格式化,以及请求转发等)
@Configuration
public class MvcConfigurer implements WebMvcConfigurer {
//拦截器
@Override
public void addInterceptors(InterceptorRegistry registry) {
//将加一个拦截器,检查会话,所有的请求都经过此拦截器
registry.addInterceptor(new MyLoginInterceptor()).addPathPatterns("/**");
}
}