08拦截器

u 概述
u 拦截器接口
u 拦截器适配器
u 运行流程图
u 拦截器HelloWorld
u 常见应用之性能监控

1 概述

1.1 简介

Spring Web MVC的处理器拦截器类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。

1.2 常见应用场景

1) 日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page View）等。

2) 权限检查：如登录检测，进入处理器检测检测是否登录，如果没有直接返回到登录页面；

3) 性能监控：有时候系统在某段时间莫名其妙的慢，可以通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间（如果有反向代理，如apache可以自动记录）；

4) 通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都需要的即可使用拦截器实现。

5) OpenSessionInView：如Hibernate，在进入处理器打开Session，在完成后关闭Session。…………本质也是AOP（面向切面编程），也就是说符合横切关注点的所有功能都可以放入拦截器实现。

2 拦截器接口

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;

}

接口方法说明：

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

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

扫描二维码关注公众号，回复： 176710 查看本文章

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

3 拦截器适配器

有时候我们可能只需要实现三个回调方法中的某一个，如果实现HandlerInterceptor接口的话，三个方法必须实现，不管你需不需要，此时spring提供了一个HandlerInterceptorAdapter适配器（一种适配器设计模式的实现），允许我们只实现需要的回调方法。

public abstract class HandlerInterceptorAdapter implements HandlerInterceptor {

//省略代码此处所有三个回调方法都是空实现，preHandle返回true。

}

4 运行流程图

正常流程

中断流程

中断流程中，比如是HandlerInterceptor4中断的流程（preHandle返回false），此处仅调用它之前拦截器的preHandle返回true的afterCompletion方法。

5 拦截器HelloWorld

5.1 先来自定义两个拦截器

public class HandlerInterceptor1 extends HandlerInterceptorAdapter {

  //此处一般继承HandlerInterceptorAdapter适配器即可

  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

     System.out.println("===========HandlerInterceptor1 preHandle");

     return true;

  }

  public void postHandle(HttpServletRequest   request,HttpServletResponse response,

    Object handler, ModelAndView modelAndView) throws Exception {

    System.out.println("===========HandlerInterceptor1 postHandle");

  }

public void afterCompletion(HttpServletRequest request,  HttpServletResponse

  response, Object handler, Exception ex) throws Exception {

      System.out.println("===========HandlerInterceptor1 afterCompletion");

  }

}

以上是HandlerInterceptor1实现，HandlerInterceptor2同理只是输出内容为“HandlerInterceptor2”。

5.2 拦截器演示使用的Controller

@Controller

public class IntercepterTestController {

  @RequestMapping(value = "/ht")

  public ModelAndView handleRequest(HttpServletRequest req,   HttpServletResponse resp)throws Exception {

     System.out.println("===========TestController");

     return new ModelAndView("test");

  }

}

5.3 在Spring的配置文件中配置拦截器

说明：这里只演示使用注解的情况，老版的配置就不讲了

<mvc:interceptors>

  <bean class="cn.javass.springmvc.intercepter.HandlerInterceptor2"/>

  <bean class="cn.javass.springmvc.intercepter.HandlerInterceptor1"/>

</mvc:interceptors>

然后就可以输入url直接测试了

这里演示的是正常的情况，还可以测试一下中断的情况，当然要记得preHandle 方法要returnfalse

6 常见应用之性能监控

u 功能概述

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

u 实现分析

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

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

u 实现存在的问题

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

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

public class StopWatchHandlerInterceptor extends HandlerInterceptorAdapter {

  private NamedThreadLocal<Long> startTimeThreadLocal =

new NamedThreadLocal<Long>("StopWatch-StartTime");

  public boolean preHandle(HttpServletRequest request, HttpServletResponse response,Object handler) throws Exception {

     long beginTime = System.currentTimeMillis();

     //1、开始时间

     startTimeThreadLocal.set(beginTime);

     //线程绑定变量（该数据只有当前请求的线程可见）

     return true;//继续流程

   }

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));

   }}}