SpringMVC处理器拦截器介绍及应用

时间 2019-11-17

原文原文链接

常见应用场景

一、日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page View）等。
二、权限检查：如登陆检测，进入处理器检测检测是否登陆，若是没有直接返回到登陆页面；
三、性能监控：有时候系统在某段时间莫名其妙的慢，能够经过拦截器在进入处理器以前记录开始时间，在处理完后记录结束时间，从而获得该请求的处理时间（若是有反向代理，如apache能够自动记录）；
四、通用行为：读取cookie获得用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都须要的便可使用拦截器实现。
五、OpenSessionInView：如Hibernate，在进入处理器打开Session，在完成后关闭Session。
…………本质也是AOP（面向切面编程），也就是说符合横切关注点的全部功能均可以放入拦截器实现。java

拦截器接口

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来产生响应；web

postHandle：后处理回调方法，实现处理器的后处理（但在渲染视图以前），此时咱们能够经过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。spring

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

运行流程图

正常流程编程

中断流程缓存

DispatcherServlet内部工做解析安全

//doDispatch方法  
//一、处理器拦截器的预处理（正序执行）  
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.一、失败时触发afterCompletion的调用  
            triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);  
            return;  
        }  
        interceptorIndex = i;//1.二、记录当前预处理成功的索引  
}  
}  
//二、处理器适配器调用咱们的处理器  
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());  
//当咱们返回null或没有返回逻辑视图名时的默认视图名翻译（详解4.15.5 RequestToViewNameTranslator）  
if (mv != null && !mv.hasView()) {  
    mv.setViewName(getDefaultViewName(request));  
}  
//三、处理器拦截器的后处理（逆序）  
if (interceptors != null) {  
for (int i = interceptors.length - 1; i >= 0; i--) {  
      HandlerInterceptor interceptor = interceptors[i];  
      interceptor.postHandle(processedRequest, response, mappedHandler.getHandler(), mv);  
}  
}  
//四、视图的渲染  
if (mv != null && !mv.wasCleared()) {  
render(mv, processedRequest, response);  
    if (errorView) {  
        WebUtils.clearErrorRequestAttributes(request);  
}  
//五、触发整个请求处理完毕回调方法afterCompletion  
triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);

// triggerAfterCompletion方法  
private void triggerAfterCompletion(HandlerExecutionChain mappedHandler, int interceptorIndex,  
            HttpServletRequest request, HttpServletResponse response, Exception ex) throws Exception {  
        // 五、触发整个请求处理完毕回调方法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都具备这个功能，但此处咱们演示一下使用拦截器怎么实现。服务器

实现分析：cookie

一、在进入处理器以前记录开始时间，即在拦截器的preHandle记录开始时间；session

二、在结束请求处理以后记录结束时间，即在拦截器的afterCompletion记录结束实现，并用结束时间-开始时间获得此次请求的处理时间。

问题：

咱们的拦截器是单例，所以无论用户请求多少次都只有一个拦截器实现，即线程不安全，那咱们应该怎么记录时间呢？

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

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

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

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

登陆检测

在访问某些资源时（如订单页面），须要用户登陆后才能查看，所以须要进行登陆检测(不适用Shiro或者其余权限框架下)。

流程：

一、访问须要登陆的资源时，由拦截器重定向到登陆页面；

二、若是访问的是登陆页面，拦截器不该该拦截；

三、用户登陆成功后，往cookie/session添加登陆成功的标识（如用户编号）；

四、下次请求时，拦截器经过判断cookie/session中是否有该标识来决定继续流程仍是到登陆页面；

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

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

提示：推荐能使用servlet规范中的过滤器Filter实现的功能就用Filter实现，由于HandlerInteceptor只有在Spring Web MVC环境下才能使用，所以Filter是最通用的、最早应该使用的。如登陆这种拦截器最好使用Filter来实现。可是若是要是能使用一些权限框架的话建议使用一些权限管理框架，框架能够帮咱们作更多的事情，如session管理、权限缓存等，Shiro就是个不错框架。