博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
SpringMVC处理器拦截器介绍及应用
阅读量:6378 次
发布时间:2019-06-23

本文共 6471 字,大约阅读时间需要 21 分钟。

hot3.png

常见应用场景

1、日志记录:记录请求信息的日志,以便进行信息监控、信息统计、计算PV(Page View)等。
2、权限检查:如登录检测,进入处理器检测检测是否登录,如果没有直接返回到登录页面;
3、性能监控:有时候系统在某段时间莫名其妙的慢,可以通过拦截器在进入处理器之前记录开始时间,在处理完后记录结束时间,从而得到该请求的处理时间(如果有反向代理,如apache可以自动记录);
4、通用行为:读取cookie得到用户信息并将用户对象放入请求,从而方便后续流程使用,还有如提取Locale、Theme信息等,只要是多个处理器都需要的即可使用拦截器实现。
5、OpenSessionInView:如Hibernate,在进入处理器打开Session,在完成后关闭Session。
…………本质也是AOP(面向切面编程),也就是说符合横切关注点的所有功能都可以放入拦截器实现。

拦截器接口

package org.springframework.web.servlet;  public interface HandlerInterceptor {      boolean preHandle(              HttpServletRequest request, HttpServletResponse response,               Object handler)               throws Exception;        void postHandle(              HttpServletRequest request, HttpServletResponse response,               Object handler, ModelAndView modelAndView)               throws Exception;        void afterCompletion(              HttpServletRequest request, HttpServletResponse response,               Object handler, Exception ex)              throws Exception;  }

preHandle预处理回调方法,实现处理器的预处理(如登录检查),第三个参数为响应的处理器(如我们上一章的Controller实现);返回值:true表示继续流程(如调用下一个拦截器或处理器);false表示流程中断(如登录检查失败),不会继续调用其他的拦截器或处理器,此时我们需要通过response来产生响应;

postHandle后处理回调方法,实现处理器的后处理(但在渲染视图之前),此时我们可以通过modelAndView(模型和视图对象)对模型数据进行处理或对视图进行处理,modelAndView也可能为null。

afterCompletion整个请求处理完毕回调方法,即在视图渲染完毕时回调,如性能监控中我们可以在此记录结束时间并输出消耗时间,还可以进行一些资源清理,类似于try-catch-finally中的finally,但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion

运行流程图

正常流程

中断流程

DispatcherServlet内部工作解析

//doDispatch方法  //1、处理器拦截器的预处理(正序执行)  HandlerInterceptor[] interceptors = mappedHandler.getInterceptors();  if (interceptors != null) {      for (int i = 0; i < interceptors.length; i++) {      HandlerInterceptor interceptor = interceptors[i];          if (!interceptor.preHandle(processedRequest, response, mappedHandler.getHandler())) {              //1.1、失败时触发afterCompletion的调用              triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);              return;          }          interceptorIndex = i;//1.2、记录当前预处理成功的索引  }  }  //2、处理器适配器调用我们的处理器  mv = ha.handle(processedRequest, response, mappedHandler.getHandler());  //当我们返回null或没有返回逻辑视图名时的默认视图名翻译(详解4.15.5 RequestToViewNameTranslator)  if (mv != null && !mv.hasView()) {      mv.setViewName(getDefaultViewName(request));  }  //3、处理器拦截器的后处理(逆序)  if (interceptors != null) {  for (int i = interceptors.length - 1; i >= 0; i--) {        HandlerInterceptor interceptor = interceptors[i];        interceptor.postHandle(processedRequest, response, mappedHandler.getHandler(), mv);  }  }  //4、视图的渲染  if (mv != null && !mv.wasCleared()) {  render(mv, processedRequest, response);      if (errorView) {          WebUtils.clearErrorRequestAttributes(request);  }  //5、触发整个请求处理完毕回调方法afterCompletion  triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);
// triggerAfterCompletion方法  private void triggerAfterCompletion(HandlerExecutionChain mappedHandler, int interceptorIndex,              HttpServletRequest request, HttpServletResponse response, Exception ex) throws Exception {          // 5、触发整个请求处理完毕回调方法afterCompletion (逆序从1.2中的预处理成功的索引处的拦截器执行)          if (mappedHandler != null) {              HandlerInterceptor[] interceptors = mappedHandler.getInterceptors();              if (interceptors != null) {                  for (int i = interceptorIndex; i >= 0; i--) {                      HandlerInterceptor interceptor = interceptors[i];                      try {                          interceptor.afterCompletion(request, response, mappedHandler.getHandler(), ex);                      }                      catch (Throwable ex2) {                          logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);                      }                  }              }          }      }

应用

性能监控

如记录一下请求的处理时间,得到一些慢请求(如处理时间超过500毫秒),从而进行性能改进,一般的反向代理服务器如apache都具有这个功能,但此处我们演示一下使用拦截器怎么实现。

实现分析:

1、在进入处理器之前记录开始时间,即在拦截器的preHandle记录开始时间;

2、在结束请求处理之后记录结束时间,即在拦截器的afterCompletion记录结束实现,并用结束时间-开始时间得到这次请求的处理时间。

问题:

我们的拦截器是单例,因此不管用户请求多少次都只有一个拦截器实现,即线程不安全,那我们应该怎么记录时间呢?

解决方案是使用ThreadLocal,它是线程绑定的变量,提供线程局部变量(一个线程一个ThreadLocal,A线程的ThreadLocal只能看到A线程的ThreadLocal,不能看到B线程的ThreadLocal)。

public class StopWatchHandlerInterceptor extends HandlerInterceptorAdapter {      private NamedThreadLocal
startTimeThreadLocal = new NamedThreadLocal
("StopWatch-StartTime"); @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { long beginTime = System.currentTimeMillis();//1、开始时间 startTimeThreadLocal.set(beginTime);//线程绑定变量(该数据只有当前请求的线程可见) return true;//继续流程 } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { long endTime = System.currentTimeMillis();//2、结束时间 long beginTime = startTimeThreadLocal.get();//得到线程绑定的局部变量(开始时间) long consumeTime = endTime - beginTime;//3、消耗的时间 if(consumeTime > 500) {//此处认为处理时间超过500毫秒的请求为慢请求 //TODO 记录到日志文件 System.out.println( String.format("%s consume %d millis", request.getRequestURI(), consumeTime)); } } }

NamedThreadLocal:Spring提供的一个命名的ThreadLocal实现。

在测试时需要把stopWatchHandlerInterceptor放在拦截器链的第一个,这样得到的时间才是比较准确的。

登录检测

在访问某些资源时(如订单页面),需要用户登录后才能查看,因此需要进行登录检测(不适用Shiro或者其他权限框架下)。

流程:

1、访问需要登录的资源时,由拦截器重定向到登录页面;

2、如果访问的是登录页面,拦截器不应该拦截;

3、用户登录成功后,往cookie/session添加登录成功的标识(如用户编号);

4、下次请求时,拦截器通过判断cookie/session中是否有该标识来决定继续流程还是到登录页面;

5、在此拦截器还应该允许游客访问的资源。

@Override  public boolean preHandle(HttpServletRequest request, HttpServletResponse response,   Object handler) throws Exception {      //1、请求到登录页面 放行      if(request.getServletPath().startsWith(loginUrl)) {          return true;      }                //2、TODO 比如退出、首页等页面无需登录,即此处要放行 允许游客的请求                //3、如果用户已经登录 放行        if(request.getSession().getAttribute("username") != null) {          //更好的实现方式的使用cookie          return true;      }                //4、非法请求 即这些请求需要登录后才能访问      //重定向到登录页面      response.sendRedirect(request.getContextPath() + loginUrl);      return false;  }

提示:推荐能使用servlet规范中的过滤器Filter实现的功能就用Filter实现,因为HandlerInteceptor只有在Spring Web MVC环境下才能使用,因此Filter是最通用的、最先应该使用的。如登录这种拦截器最好使用Filter来实现。但是如果要是能使用一些权限框架的话建议使用一些权限管理框架,框架可以帮我们做更多的事情,如session管理、权限缓存等,Shiro就是个不错框架。

转载于:https://my.oschina.net/liuyuantao/blog/805421

你可能感兴趣的文章
RHEL6.3实现基于加密的用户认证验证访问
查看>>
SCCM2012 R2实战系列之十一:解决OSD分发Windows7 系统盘盘符为’D’问题
查看>>
经验分享:我是如何在网店无货源情况下快速出单?
查看>>
限免的Mac App套件,工程师绝对不可错过
查看>>
Skype for Business Server 2015-05-监控和存档服务器-配置
查看>>
浅谈物化视图
查看>>
安装SQL Server 2017
查看>>
超融合超越企业传统存储绕不开的六个问题
查看>>
医院CIO的一幅工作对联
查看>>
DPM灾难切换应用场景
查看>>
简单配置Oracle10g DataGuard物理备库
查看>>
网曝支付宝漏洞:手机丢了,支付宝也就完了
查看>>
4 在vCenter Server安装View Composer组件
查看>>
SFB 项目经验-24-为持久聊天室-查询或者增加成员
查看>>
Linux下配置Squid基础教程
查看>>
当Cacti遭遇大流量
查看>>
Outlook Anywhere 客户端配置详解
查看>>
《Windows Server 2008 R2系统管理实战》前言与内容提要
查看>>
轻巧的网络流量实时监控工具NTOPNG
查看>>
Access、Sql 获取当前插入的主键ID
查看>>