Spring拦截器过滤器之拦截器详解(一)

前言

相信做web的小伙伴会经常接触到java三大器（拦截器、过滤器和监听器），最近整理的时候，发现想要完整的说清楚，还是有些不明白的地方，在此也边学习边整理，就当是查缺补漏吧（划重点：本文整理的是基于spring框架下的内容）。

热身

想要从头到尾的把事情说清楚和理解，并不容易，lz觉得需要具备一些相关知识和一定的项目经验，不然光说是无法理解的，所以lz建议先了解以下知识点，学习本身就是一个循循渐进的过程，想要了解某一知识，就需要多个知识点的储备:
1.servlet的概念、原理和作用，这里贴出一些前辈的总结：servlet是干什么的，servlet的理解
2.Java中 Tomcat 是干什么的？
3.代理模式及AOP(慕课网的AOP视频讲的不错)
4.责任链模式
5.请求与响应

拦截器

一.概念

百科上的概念介绍很标准：

java里的拦截器是动态拦截Action调用的对象。它提供了一种机制可以使开发者可以定义在一个action执行的前后执行的代码，也可以在一个action执行前阻止其执行，同时也提供了一种可以提取action中可重用部分的方式。在AOP（Aspect-Oriented
Programming）中拦截器用于在某个方法或字段被访问之前，进行拦截然后在之前或之后加入某些操作。

简而言之，拦截器很重要的特性就是在到达controller之前，根据方法返回值【true/false】 判断是否可以执行后面（下一个拦截器或者controller的方法，因此可以做登录实现，判断登录状态。

二.初探拦截器

lz觉得学习拦截器时，要与过滤器对比一下，这样对于重要特性的理解会更好，不至于混淆（过滤器后文会详述，莫急）:
这里先引用两张图
第一张出处
第二张出处

从上述两张图中，基本讲清楚了拦截器和过滤器的区别，以及触发时机，即过滤器是容器级别的支持，拦截器是程序框架支持。

三.实现原理

如果你按照楼主的建议，先学习了代理模式和责任链模式，并且对基于代理模式实现的AOP的有一种“卧槽，原理是这样的”感悟，那么理解拦截器的原理就很容易了，没错，因为拦截器的底层主要使用到了AOP思想和责任链模式！
在springMVC中，自定义一个拦截器可以分为两步：
1.实现HandlerInterceptor接口或者继承抽象类AbstractInterceptor
2.在你项目中的配置文件注册定义的拦截器，通常是在dispatcher-servlet.xml中
在Action对象创建之后，Action方法执行之前，执行默认拦截器，这里用到了AOP思想，在执行拦截器时，会执行很多的拦截器(默认拦截器也有很多拦截器)，这就是责任链模式！
我们再看看HandlerInterceptor接口源码，

public interface HandlerInterceptor {
    boolean preHandle(HttpServletRequest var1, HttpServletResponse var2, Object handler) throws Exception;
    void postHandle(HttpServletRequest var1, HttpServletResponse var2, Object handler, ModelAndView var4) throws Exception;
    void afterCompletion(HttpServletRequest var1, HttpServletResponse var2, Object handler, Exception var4) throws Exception;
}

这里定义了三个方法：

1.boolean preHandle(HttpServletRequest var1, HttpServletResponse var2, Object handler)

详解：这个方法在业务处理器处理请求之前被调用，SpringMVC 中的Interceptor是链式调用的（即责任链模式），在一个应用中或者说是在一个请求中可以同时存在多个Interceptor。每个Interceptor 的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor中的preHandle 方法，所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是布尔值Boolean 类型的，当它返回为false 时，表示请求结束，后续的Interceptor 和Controller都不会再执行；当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法，如果已经是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。通常我们实现我登录功能，就在此方法中写业务

2.void postHandle(HttpServletRequest var1, HttpServletResponse var2, Object handler, ModelAndView var4)

详解：这个方法在当前请求进行处理之后，也就是Controller方法调用之后执行，但是它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller处理之后的ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 是相反的，也就是说先声明的Interceptor 的postHandle 方法反而会后执行。

3.void afterCompletion(HttpServletRequest var1, HttpServletResponse var2, Object handler, Exception var4) 

详解：该方法也是需要当前对应的Interceptor 的preHandle 方法的返回值为true 时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在DispatcherServlet渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。afterCompletion方法被调用的方向和perHandle也是相反的，先声明的Interceptor的afterCompletion方法后执行。
(关于HandlerInterceptor的执行顺序我们可以在HandlerExecutionChain类中找到，后面再说)

先实现一个登录的功能，假设项目的登录请求为xx/toLogin,那么你需要拦截一些请求，并对是否登录做校验：

public classLoginInterceptor implements HandlerInterceptor {
 //定义放行的url，如静态资源、toLogin等
 private List<String> urls;
   //在执行Controller方法之前来执行的
   //用于用户认证校验、用户权限校验
   @Override
   public booleanpreHandle(HttpServletRequest request,
         HttpServletResponseresponse, Object handler) throws Exception {
     
      //得到请求的url
      String uri = request.getRequestURI();
     
      //判断是否是公开地址
      //实际开发中需要公开地址配置在配置文件中
      for(String url : urls){
       if(uri.indexOf(url)>=0){
         //如果是公开地址则放行
         return true;
      }else{
      return false;
      }
      }
     
      //判断用户身份在session中是否存在
      HttpSessionsession = request.getSession();
      Stringusercode = (String) session.getAttribute("usercode");
      //如果用户身份在session中存在放行
      if(usercode!=null){
         return true;
      }
      //执行到这里拦截，跳转到登陆页面，用户进行身份认证
      request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response);
      //如果返回false表示拦截不继续执行handler，如果返回true表示放行
      return false;
   }
   //在执行Controller方法之后返回modelAndView之前来执行
   //如果需要向页面提供一些公用的数据或配置一些视图信息，使用此方法实现从modelAndView入手
   @Override
   public void postHandle(HttpServletRequest request,
         HttpServletResponseresponse, Object handler,
         ModelAndViewmodelAndView) throwsException {
      System.out.println("HandlerInterceptor...postHandle");
   }
   //完成对页面的渲染之后执行此方法
   //作系统统一异常处理，进行方法执行性能监控，在preHandle中设置一个时间点，在afterCompletion设置一个时间，两个时间点的差就是执行时长
   //实现系统统一日志记录
   @Override
   public voidafterCompletion(HttpServletRequest request,
         HttpServletResponseresponse, Object handler, Exception ex)
         throws Exception {
      System.out.println("HandlerInterceptor...afterCompletion");
   }
}

xml文件中的配置

<!--拦截器 -->
   <mvc:interceptors>
      <mvc:interceptor>
         <!-- /**可以拦截路径不管多少层 -->
         <mvc:mapping path="/**" />
          <bean class="xxx拦截器1">
          <bean class="xxx拦截器2">
         <bean class="cn.itcast.ssm.controller.interceptor.LoginInterceptor">
               <property name="exceptUrls">
                <list>
                    <value>/tologin</value>
                    <value>/sys/**</value>
                    <value>/swagger.html</value>
                    <value>/swagger-resources</value>
                    <value>/xxx</value>
                    <value>/xxx/**</value>
                    <value>/xxx</value>
                </list>
            </property>
      </bean>
      </mvc:interceptor>
   </mvc:interceptors>

登录的基本功能就实现了，以上参考资料：
spring 拦截器实现原理
拦截器底层原理
springMVC拦截器实现原理
现在，对于拦截器的使用基本掌握了，但是想更深入了解执行顺序和原理，是远远不够的，lz过些天接着更新拦截器。。。。