在SpringBoot中我们可以使用HandlerInterceptorAdapter这个适配器来实现自己的拦截器。这样就可以拦截所有的请求并做相应的处理。
应用场景:
-
日志记录,可以记录请求信息的日志,以便进行信息监控、信息统计等。
-
权限检查:如登陆检测,进入处理器检测是否登陆,如果没有直接返回到登陆页面。
-
性能监控:典型的是慢日志。
在HandlerInterceptorAdapter中主要提供了以下的方法:
-
preHandle:在方法被调用前执行。在该方法中可以做类似校验的功能。如果返回true,则继续调用下一个拦截器。如果返回false,则中断执行,也就是说我们想调用的方法 不会被执行,但是你可以修改response为你想要的响应。
-
postHandle:在方法执行后调用。
-
afterCompletion:在整个请求处理完毕后进行回调,也就是说视图渲染完毕或者调用方已经拿到响应。
拦截器代码
@Component
@Slf4j
public class AuthorityInterceptor implements HandlerInterceptor {
//方法执行前执行的接口
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
log.info("进入到拦截器中:preHandle(),拦截URL:"+request.getServletPath());
return true;
}
//方法执行后执行的方法
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
//log.info("进入到拦截器中:postHandle(),拦截URL:"+request.getServletPath());
}
//返回处理的方法
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
//log.info("进入到拦截器中:afterCompletion(),拦截URL:"+request.getServletPath());
}
//没登录时返回错误信息
public void noLogin(HttpServletResponse response) throws Exception{
response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
response.setCharacterEncoding("UTF-8");
response.setContentType("application/json; charset=utf-8");
//创建json对象
JSONObject res = new JSONObject();
res.put("status",HttpServletResponse.SC_UNAUTHORIZED);
res.put("msg","请重新登录!");
PrintWriter out = null ;
out = response.getWriter();
out.write(res.toString());
out.flush();
out.close();
}
}
拦截器配置
/**
* 拦截器需要配置才可以使用,也可以在这里注入其他的类
*/
@Configuration
public class InterceptorAdapterConfig implements WebMvcConfigurer {
@Resource
private AuthorityInterceptor authorityInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
List<String> patterns = new ArrayList<>();
patterns.add("/error");
patterns.add("/sys/login");
patterns.add("/sys/getPicCode");
patterns.add("/doc.html");
patterns.add("/swagger-*/**");
patterns.add("/webjars/**");
patterns.add("/v3/*");
patterns.add("/saToken/**");
patterns.add("/synchron/**");
patterns.add("/sysfile/download/**");
patterns.add("/*/login/*");
patterns.add("/");
patterns.add("/index.html");
patterns.add("/static/**");
registry.addInterceptor(authorityInterceptor)
.addPathPatterns("/**") //所有的请求都要拦截。
.excludePathPatterns(patterns); //将不需要拦截的接口请求排除在外
}
}