一篇文章教你弄懂 SpringMvc中的HandlerInterceptor

tech2025-01-15  7

文章列表

一、HandlerInterceptor简介一、HandlerInterceptor应用实例

写在前面: 我是「境里婆娑」。我还是从前那个少年,没有一丝丝改变,时间只不过是考验,种在心中信念丝毫未减,眼前这个少年,还是最初那张脸,面前再多艰险不退却。 写博客的目的就是分享给大家一起学习交流,如果您对 Java感兴趣,可以关注我,我们一起学习。

前言:HandlerInterceptor在项目中经常用到,比如发送一个请求希望在调用业务代码之前对这个请求做一些操作,或者调用业务完成之后做一些操作。实现HandlerInterceptor 接口做具体的业务即可。

一、HandlerInterceptor简介

spring mvc的拦截器是只拦截controller而不拦截jsp,html 页面文件的。这就用到过滤器filter了,filter是在servlet前执行的,你也可以理解成过滤器中包含拦截器,一个请求过来 ,先进行过滤器处理,看程序是否受理该请求 。 过滤器放过后 , 程序中的拦截器进行处理 。

HandlerInterceptor拦截的是请求地址,所以针对请求地址做一些验证、预处理等操作比较合适。

定义一个Interceptor 非常简单方式也有几种,我这里简单列举两种

类要实现Spring 的HandlerInterceptor 接口类继承实现了HandlerInterceptor 接口的类,例如 已经提供的实现了HandlerInterceptor 接口的抽象类HandlerInterceptorAdapter

HandlerInterceptor执行顺序图: SpringMvc5.0版本HandlerInterceptor接口里面方法已经改为默认方法

public interface HandlerInterceptor { /** * 预处理回调方法,实现处理器的预处理(如检查登陆),第三个参数为响应的处理器,自定义Controller * 返回值:true表示继续流程(如调用下一个拦截器或处理器);    * false表示流程中断(如登录检查失败),不会继续调用其他的拦截器或处理器,此时我们需要通过response来产生响应; */ default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { return true; } /** * 后处理回调方法,实现处理器的后处理(但在渲染视图之前),此时我们可以通过modelAndView(模型和视图对象)对模型数据进行处理或对视图进行处理,modelAndView也可能为null。 */ default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception { } /** * 整个请求处理完毕回调方法,即在视图渲染完毕时回调,如性能监控中我们可以在此记录结束时间并输出消耗时间,还可以进行一些资源清理,类似于try-catch-finally中的finall    * 但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion。 */ default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception { } }

运行流程图:

正常流程图: 异常流程图:  运行流程总结如下:

拦截器执行顺序是按照Spring配置文件中定义的顺序而定的。

会先按照顺序执行所有拦截器的preHandle方法,一直遇到return false为止,比如第二个preHandle方法是return false,则第三个以及以后所有拦截器都不会执行。若都是return true,则按顺序加载完preHandle方法。

然后执行主方法(自己的controller接口),若中间抛出异常,则跟return false效果一致,不会继续执行postHandle,只会倒序执行afterCompletion方法。

在主方法执行完业务逻辑(页面还未渲染数据)时,按倒序执行postHandle方法。若第三个拦截器的preHandle方法return false,则会执行第二个和第一个的postHandle方法和afterCompletion(postHandle都执行完才会执行这个,也就是页面渲染完数据后,执行after进行清理工作)方法。(postHandle和afterCompletion都是倒序执行)

一、HandlerInterceptor应用实例

自定义HandlerInterceptor

@Component public class RememberAuthenticationInterceptor implements HandlerInterceptor { @Autowired private SysUserService userService; @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { Subject subject = SecurityUtils.getSubject(); if (subject.isAuthenticated()) { return true; } Session session = subject.getSession(true); if (session.getAttribute(SessionConst.USER_SESSION_KEY) != null) { return true; } if(!subject.isRemembered()) { log.warn("未设置“记住我”,跳转到登录页..."); response.sendRedirect(request.getContextPath() + "/passport/login"); return false; } try { Long userId = Long.parseLong(subject.getPrincipal().toString()); User user = userService.getByPrimaryKey(userId); UsernamePasswordToken token = new UsernamePasswordToken(user.getUsername(), PasswordUtil.decrypt(user.getPassword(), user.getUsername()), true); subject.login(token); session.setAttribute(SessionConst.USER_SESSION_KEY, user); log.info("[{}] - 已自动登录", user.getUsername()); } catch (Exception e) { log.error("自动登录失败", e); response.sendRedirect(request.getContextPath() + "/passport/login"); return false; } return true; } }

HandlerInterceptor配置

@Configuration public class WebMvcConfig implements WebMvcConfigurer { @Autowired private RememberAuthenticationInterceptor rememberAuthenticationInterceptor; @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(rememberAuthenticationInterceptor) .excludePathPatterns("/passport/**", "/error/**", "/assets/**", "/getKaptcha/**", "/websocket", "favicon.ico") .addPathPatterns("/**"); } }

addPathPatterns需要拦截的路径,excludePathPatterns拦截时候需要排除的路径。

HandlerInterceptor应用场景

日志记录,可以记录请求信息的日志,以便进行信息监控、信息统计、计算PV(Page View)等等。权限检查:如登陆检测,进入处理器检测是否登陆,如果没有直接返回到登陆页面。性能监控:有时候系统在某段时间莫名其妙的慢,可以通过拦截器在进入处理器之前记录开始时间,在处理完后记录结束时间,从而得到该请求的处理时间(如果有反向代理,如apache可以自动记录);

到此SpringMvc中的HttpMessageConverter介绍完毕。如果还有不明白的可以留言。 ————————————————————————————————— 由于本人水平有限,难免有不足,恳请各位大佬不吝赐教!

最新回复(0)