过滤器与拦截器

来源：互联网发布：sql注入入侵网站编辑：程序博客网时间：2024/06/05 11:57

一. 概念认知

Filter：Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截。简单说，就是可以实现web容器对某资源的访问前截获进行相关的处理，还可以在某资源向web容器返回响应前进行截获进行处理。

Interceptor：Spring Web MVC的处理器拦截器（如无特殊说明，下文所说的拦截器即处理器拦截器）类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。

二. 快速入门

如何使用Filter：
1. 新建一个类，实现Filter接口
2. 实现其中的doFilter()方法，打印一句话，来证明能够进行拦截
3. 在web.xml中进行配置（参照Servlet配置）

public class Demo1Filter implements Filter {    private FilterConfig filterConfig;    public void init(FilterConfig filterConfig) throws ServletException {        System.out.println("初始化了");        this.filterConfig = filterConfig;    }    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {        System.out.println("Demo1过滤前");        System.out.println(filterConfig.getInitParameter("param1"));        chain.doFilter(request, response);//放行。让其走到下个链或目标资源中        System.out.println("Demo1过滤后");    }    public void destroy() {        System.out.println("销毁了");    }}

web.xml

    <!--配置过滤器-->    <filter>        <!--用于添加描述信息，该元素的内容可为空，可以不配置。-->        <!--<description>这是一个filter</description>-->        <!--用于为过滤器指定一个名字，该元素的内容不能为空。-->        <filter-name>FilterDemo01</filter-name>        <!--用于指定过滤器的完整的限定类名。-->        <filter-class>com.taolunban.filter.Demo1Filter</filter-class>        <!--用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。如果过滤器不需要指定初始化参数，那么<init-param>元素可以不配置。-->        <init-param>            <param-name>param1</param-name>            <param-value>value在这里呢</param-value>        </init-param>    </filter>    <!--映射过滤器-->    <!--用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径-->    <filter-mapping>    <!--用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字-->        <filter-name>FilterDemo01</filter-name>        <!--设置 filter 所拦截的请求路径(过滤器关联的URL样式)。“/*”表示拦截所有的请求 -->        <url-pattern>/*</url-pattern>        <!--指定过滤器所拦截的Servlet名称-->        <!--<servlet-name>ProductServlet</servlet-name>-->        <!--有例子说还有一个disptcher的标签，查了一下，是servlet2.4加进去的，我用的是3.0，似乎已经去掉了这个标签 -->    </filter-mapping>

如何使用Interceptor:
1. 定义Interceptor实现类，可以实现HandlerInterceptor接口或继承HandlerInterceptorAdapter类
2. 实现其中的preHandle，postHandle和afterCompletion方法
3. 在spring配置文件中进行配置（不是springmvc配置文件）

public class DemoInterceptor extends HandlerInterceptorAdapter {    /**     * 在业务处理器处理请求之前被调用     * 如果返回false     *     从当前的拦截器往回执行所有拦截器的afterCompletion(),再退出拦截器链     * 如果返回true     *    执行下一个拦截器,直到所有的拦截器都执行完毕     *    再执行被拦截的Controller     *    然后进入拦截器链,     *    从最后一个拦截器往回执行所有的postHandle()     *    接着再从最后一个拦截器往回执行所有的afterCompletion()     */    @Override    public boolean preHandle(HttpServletRequest request,                             HttpServletResponse response, Object handler) throws Exception {        System.out.println("==============执行顺序: 1、preHandle================");        String requestUri = request.getRequestURI();        String contextPath = request.getContextPath();        String url = requestUri.substring(contextPath.length());        System.out.println("requestUri:"+requestUri);        System.out.println("contextPath:"+contextPath);        System.out.println("url:"+url);        return true;    }    /**     * 在业务处理器处理请求执行完成后,生成视图之前执行的动作     * 可在modelAndView中加入数据，比如当前时间     */    @Override    public void postHandle(HttpServletRequest request,                           HttpServletResponse response, Object handler,                           ModelAndView modelAndView) throws Exception {        System.out.println("==============执行顺序: 2、postHandle================");        if(modelAndView != null){  //加入当前时间            modelAndView.addObject("var", "测试postHandle");        }    }    /**     * 在DispatcherServlet完全处理完请求后被调用,可用于清理资源等     *     * 当有拦截器抛出异常时,会从当前拦截器往回执行所有的拦截器的afterCompletion()     */    @Override    public void afterCompletion(HttpServletRequest request,                                HttpServletResponse response, Object handler, Exception ex)            throws Exception {        System.out.println("==============执行顺序: 3、afterCompletion================");    }}

spring配置文件

<!--配置拦截器, 多个拦截器,顺序执行 --><mvc:interceptors>    <mvc:interceptor>        <!-- 匹配的是url路径， 如果不配置或/**,将拦截所有的Controller -->        <mvc:mapping path="/**"/>        <!-- 不拦截该请求 -->        <mvc:exclude-mapping path="/index"/>        <bean class="com.taolunban.interceptor.DemoInterceptor"/>    </mvc:interceptor></mvc:interceptors><!-- 当设置多个拦截器时，先按顺序调用preHandle方法，然后逆序调用每个拦截器的postHandle和afterCompletion方法 -->

相关代码可以在这里下载：过滤器与拦截器

三、详解

首先，要理解过滤器和拦截器，就不得不提到一种设计模式——责任链模式。

责任链模式是一种对象的行为模式。在责任链模式里，很多对象由每一个对象对其下家的引用而连接起来形成一条链。请求在这个链上传递，直到链上的某一个对象决定处理此请求。发出这个请求的客户端并不知道链上的哪一个对象最终处理这个请求，这使得系统可以在不影响客户端的情况下动态地重新组织和分配责任。

需要注意的是，严格的责任链模式只允许一个具体的处理者对象只能在两个行为中选择一个：一是承担责任，二是把责任推给下家。不允许出现某一个具体处理者对象在承担了一部分责任后又把责任向下传的情况。也即是说，过滤器和拦截器并不是严格的责任链模式。

参考资料：责任链设计模式（过滤器、拦截器）

1. Filter详解

作用
过滤器是在java web中，你传入的request,response提前过滤掉一些信息，或者提前设置一些参数，然后再传入servlet或者struts的 action进行业务逻辑，比如过滤掉非法url。主要为了减轻服务器负载。减少压力。
内部接口
Servlet过滤器API包含了3个接口，它们都在javax.servlet包中，分别是Filter接口、FilterChain接口和FilterConfig接口。

public Interface Filter
所有的过滤器都必须实现Filter接口。该接口定义了init(),doFilter0，destory()三个方法：
(1) public void init (FilterConfig filterConfig)
当开始使用servlet过滤器服务时，Web容器调用此方法一次，为服务准备过滤器；然后在需要使用过滤器的时候调用doFilter()，传送给此方法的FilterConfig对象，包含servlet过滤器的初始化参数。
(2)public void doFilter(ServletRequest request，ServletResponse response，FilterChain chain)
每个过滤器都接受当前的请求和响应，且FilterChain过滤器链中的过滤器（应该都是符合条件的）都会被执行。doFilter方法中，过滤器可以对请求和响应做它想做的一切，通过调用他们的方法收集数据，或者给对象添加新的行为。过滤器通过传送至此方法的FilterChain参数，调用chain.doFilter()将控制权传送给下一个过滤器。当这个调用返回后，过滤器可以在它的Filter方法的最后对响应做些其他的工作。如果过滤器想要终止请求的处理或得到对响应的完全控制，则可以不调用下一个过滤器，而将其重定向至其它一些页面。当链中的最后一个过滤器调用chain.doFilter()方法时，将运行最初请求的Servlet。
(3)public void destroy()
一旦doFilterO方法里的所有线程退出或已超时，容器调用
此方法。服务器调用destoryO以指出过滤器已结束服务，用于释
放过滤器占用的资源。

public interface FilterChain
public void doFilter(ServletRequest request，ServletResponse response)
此方法是由Servlet容器提供给开发者的，用于对资源请求过滤链的依次调用，通过FilterChain调用过滤链中的下一个过滤器，如果是最后一个过滤器，则下一个就调用目标资源。

public interface FilterConfig
FilterConfig接口检索过滤器名、初始化参数以及活动的Servlet上下文。该接口提供了以下4个方法：
(1)public Java.lang.String getFilterName()
返回web.xml部署文件中定义的该过滤器的名称。
(2)public ServletContext getServletContext()
返回调用者所处的servlet上下文。
(3)public java.lang.String getlnitParameter(java.lang.String name)
返回过滤器初始化参数值的字符串形式，当参数不存在时，返回null。name是初始化参数名。
(4)public java.util.Enumeration getlnitParameterNames()
以Enumeration形式返回过滤器所有初始化参数值，如果没有初始化参数，返回为空。
工作原理
当客户端发出Web资源的请求时，Web服务器根据应用程序配置文件设置的过滤规则进行检查，若客户请求满足过滤规则，则对客户请求／响应进行拦截，对请求头和请求数据进行检查或改动，并依次通过过滤器链，最后把请求／响应交给请求的Web资源处理。请求信息在过滤器链中可以被修改，也可以根据条件让请求不发往资源处理器，并直接向客户机发回一个响应。当资源处理器完成了对资源的处理后，响应信息将逐级逆向返回。同样在这个过程中，用户可以修改响应信息，从而完成一定的任务。

上面说了，当一个请求符合某个过滤器的过滤条件时该请求就会交给这个过滤器去处理。那么当两个过滤器同时过滤一个请求时谁先谁后呢？这就涉及到了过滤链FilterChain。
所有的奥秘都在Filter的FilterChain中。服务器会按照web.xml中过滤器定义的先后循序组装成一条链，然后一次执行其中的doFilter()方法。执行的顺序就如下图所示，执行第一个过滤器的chain.doFilter()之前的代码，第二个过滤器的chain.doFilter()之前的代码，请求的资源，第二个过滤器的chain.doFilter()之后的代码，第一个过滤器的chain.doFilter()之后的代码，最后返回响应。通常我们最终访问的资源就是一个servlet或者一个jsp页面，所以这里请求的资源就是指servlet的service方法，然后根据请求类型的不同去执行doGet()或doPost()等方法。

过滤链的好处是，执行过程中任何时候都可以打断，只要不执行chain.doFilter()就不会再执行后面的过滤器和请求的内容。
针对多个过滤器来说，例如，EncodingFilter负责设置编码，SecurityFilter负责控制权限，服务器会按照web.xml中过滤器定义的先后循序组装成一条链，然后一次执行其中的doFilter()方法，在实际使用时，就要特别注意过滤链的执行顺序问题，像EncodingFilter就一定要放在所有Filter之前，这样才能确保在使用请求中的数据前设置正确的编码。
生命周期
(1) 在应用启动的时候就进行装载Filter类(与Servlet的load-on-startup配置效果相同)。Web容器回调它的无参构造方法。
(2)初始化：实例化完成之后，马上进行初始化工作。Web容器回调init()方法。接着被Web容器保存进应用级的集合容器中去了等待着，用户访问资源。
(3)当用户访问的资源正好被Filter的url-pattern拦截时，容器会取出Filter类调用doFilter方法，下次或多次访问被拦截的资源时，Web容器会直接取出指定Filter对象实例调用doFilter方法(Filter对象常驻留Web容器了)。
(4)当应用服务被停止或重新装载了，则会执行Filter的destroy方法，Filter对象销毁。

注意：init()方法和destroy()方法在整个运行过程中只会执行一次。
应用场景
(1) 鉴权
比如判断用户是否有访问某些资源的权限，有权限放行，没权限不执行chain.doFilter方法。
(2)编码
比如可以在doFilter方法前，执行设置请求编码与响应的编码。甚至可以对request接口进行封装装饰来处理get请求方式的中文乱码问题(重写相应的request.getParameter方法)。
(3)压缩
比如对整个web网站进行压缩，在调用chain.doFilter方法之前用类A对response对象进行封装装饰，重写getOutputStream和重写getWriter方法。在类A内部中，将输出内容缓存进ByteArrayOutputStream流中，然后在chain.doFilter方法执行后，获取类A中ByteArrayOutputStream流缓存数据，用GZIPOutputStream流进行压缩。
总结
对于filter的应用相信大家已经明白了，它主要的作用就是用户在访问某个目标资源之前，对访问的请求和响应进行拦截，做一些处理，然后再调用目标程序，这样做的好处是可以对一些公共的操作进行抽象，就拿设置字符集来说，如果不使用这种方式，我们每个页面都要写设置字符集的语句。不但麻烦而且维护困难，但是如果使用filter的话，只需要添加一个类，在xml中配置一下，如果不想使用了，将配置文件中的内容去除即可。
其实这就是一种AOP（Aspect OrientedProgramming），面向切面编程。它的主要的意图是：将日志记录，性能统计，安全控制，事务处理，异常处理等代码从业务逻辑代码中划分出来，通过对这些行为的分离，我们希望可以将它们独立到非指导业务逻辑的方法中，进而改变这些行为的时候不影响业务逻辑的代码。
对于设置字符集来说，它并非是业务逻辑的内容，对于这些内容的处理我们就可以提取出来，使用filter进行整体设置，这种方式相当于对类中的内容做进一步的抽象，使我们的系统更加灵活，更加能应对变化！

2.Interceptor详解

作用
SpringMVC 中的Interceptor拦截器与上面讲的Fileter过滤器作用有些相似。它的主要作用是拦截用户的请求并进行相应的处理。比如通过它来进行权限验证，或者是来判断用户是否登陆，或者是像12306 那样子判断当前时间是否是购票时间。
内部接口
SpringMVC 中的Interceptor 拦截请求是通过HandlerInterceptor 来实现的。在SpringMVC 中定义一个Interceptor主要有两种方式，第一种方式是要定义的Interceptor类要实现了Spring的HandlerInterceptor接口，或者是这个类继承实现了HandlerInterceptor接口的类，比如Spring已经提供的实现了HandlerInterceptor接口的抽象类HandlerInterceptorAdapter；第二种方式是实现Spring的WebRequestInterceptor接口，或者是继承实现了WebRequestInterceptor的类。
（一）实现HandlerInterceptor接口
HandlerInterceptor 接口中定义了三个方法，我们就是通过这三个方法来对用户的请求进行拦截处理的。
(1)preHandle (HttpServletRequest request, HttpServletResponse response, Object handle) 方法，顾名思义，该方法将在请求处理之前进行调用。SpringMVC 中的Interceptor 是链式的调用的，在一个应用中或者说是在一个请求中可以同时存在多个Interceptor 。每个Interceptor 的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor 中的preHandle 方法，所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是布尔值Boolean 类型的，当它返回为false 时，表示请求结束，后续的Interceptor 和Controller 都不会再执行；当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法，如果已经是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。
(2)postHandle (HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView) 方法，由preHandle 方法的解释我们知道这个方法包括后面要说到的afterCompletion 方法都只能是在当前所属的Interceptor 的preHandle 方法的返回值为true 时才能被调用。postHandle 方法，顾名思义就是在当前请求进行处理之后，也就是Controller 方法调用之后执行，但是它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 是相反的，也就是说先声明的Interceptor 的postHandle 方法反而会后执行，这和Struts2 里面的Interceptor 的执行过程有点类型。Struts2 里面的Interceptor 的执行过程也是链式的，只是在Struts2 里面需要手动调用ActionInvocation 的invoke 方法来触发对下一个Interceptor 或者是Action 的调用，然后每一个Interceptor 中在invoke 方法调用之前的内容都是按照声明顺序执行的，而invoke 方法之后的内容就是反向的。
(3)afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex) 方法，该方法也是需要当前对应的Interceptor 的preHandle 方法的返回值为true 时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。
```
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse;import org.springframework.web.servlet.HandlerInterceptor;    import org.springframework.web.servlet.ModelAndView; public class SpringMVCInterceptor implements HandlerInterceptor {      /**      * preHandle方法是进行处理器拦截用的，顾名思义，该方法将在Controller处理之前进行调用，SpringMVC中的Interceptor拦截器是链式的，可以同时存在多个Interceptor，然后SpringMVC会根据声明的前后顺序一个接一个的执行，而且所有的Interceptor中的preHandle方法都会在Controller方法调用之前调用。SpringMVC的这种Interceptor链式结构也是可以进行中断的，这种中断方式是令preHandle的返回值为false，当preHandle的返回值为false的时候整个请求就结束了。      */      @Override      public boolean preHandle(HttpServletRequest request,HttpServletResponse response, Object handler) throws Exception {          // TODO Auto-generated method stub          return false;      }      /**      * 这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。postHandle是进行处理器拦截用的，它的执行时间是在处理器进行处理之后，也就是在Controller的方法调用之后执行，但是它会在DispatcherServlet进行视图的渲染之前执行，也就是说在这个方法中你可以对ModelAndView进行操作。     这个方法的链式结构跟正常访问的方向是相反的，也就是说先声明的Interceptor拦截器该方法反而会后调用，这跟Struts2里面的拦截器的执行过程有点像，只是Struts2里面的intercept方法中要手动的调用ActionInvocation的invoke方法，Struts2中调用ActionInvocation的invoke方法就是调用下一个Interceptor或者是调用action，然后要在Interceptor之前调用的内容都写在调用invoke之前，要在Interceptor之后调用的内容都写在调用invoke方法之后。     */      @Override      public void postHandle(HttpServletRequest request,              HttpServletResponse response, Object handler,              ModelAndView modelAndView) throws Exception {          // TODO Auto-generated method stub      }      /**      * 该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。该方法将在整个请求完成之后，也就是DispatcherServlet渲染了视图执行，这个方法的主要作用是用于清理资源的，当然这个方法也只能在当前这个Interceptor的preHandle方法的返回值为true时才会执行。     */      @Override      public void afterCompletion(HttpServletRequest request,HttpServletResponse response, Object handler, Exception ex)  throws Exception {          // TODO Auto-generated method stub      }  } 
```
（二）实现WebRequestInterceptor 接口
WebRequestInterceptor 中也定义了三个方法，我们也是通过这三个方法来实现拦截的。这三个方法都传递了同一个参数WebRequest ，那么这个WebRequest 是什么呢？这个WebRequest 是Spring 定义的一个接口，它里面的方法定义都基本跟HttpServletRequest 一样，在WebRequestInterceptor 中对WebRequest 进行的所有操作都将同步到HttpServletRequest 中，然后在当前请求中一直传递。
(1)preHandle(WebRequest request) 方法。该方法将在请求处理之前进行调用，也就是说会在Controller 方法调用之前被调用。这个方法跟HandlerInterceptor 中的preHandle 是不同的，主要区别在于该方法的返回值是void ，也就是没有返回值，所以我们一般主要用它来进行资源的准备工作，比如我们在使用Hibernate 的时候可以在这个方法中准备一个Hibernate 的Session 对象，然后利用WebRequest 的setAttribute(name, value, scope) 把它放到WebRequest 的属性中。这里可以说说这个setAttribute 方法的第三个参数scope ，该参数是一个Integer 类型的。在WebRequest 的父层接口RequestAttributes 中对它定义了三个常量：
SCOPE_REQUEST ：它的值是0 ，代表只有在request 中可以访问。
SCOPE_SESSION ：它的值是1 ，如果环境允许的话它代表的是一个局部的隔离的session，否则就代表普通的session，并且在该session范围内可以访问。
SCOPE_GLOBAL_SESSION ：它的值是2 ，如果环境允许的话，它代表的是一个全局共享的session，否则就代表普通的session，并且在该session 范围内可以访问。
(2)postHandle(WebRequest request, ModelMap model) 方法。该方法将在请求处理之后，也就是在Controller 方法调用之后被调用，但是会在视图返回被渲染之前被调用，所以可以在这个方法里面通过改变数据模型ModelMap 来改变数据的展示。该方法有两个参数，WebRequest 对象是用于传递整个请求数据的，比如在preHandle 中准备的数据都可以通过WebRequest 来传递和访问；ModelMap 就是Controller 处理之后返回的Model 对象，我们可以通过改变它的属性来改变返回的Model 模型。
(3)afterCompletion(WebRequest request, Exception ex) 方法。该方法会在整个请求处理完成，也就是在视图返回并被渲染之后执行。所以在该方法中可以进行资源的释放操作。而WebRequest 参数就可以把我们在preHandle 中准备的资源传递到这里进行释放。Exception 参数表示的是当前请求的异常对象，如果在Controller 中抛出的异常已经被Spring 的异常处理器给处理了的话，那么这个异常对象就是是null 。
下面是一个简单的代码说明：
```
import org.springframework.ui.ModelMap;import org.springframework.web.context.request.WebRequest; importorg.springframework.web.context.request.WebRequestInterceptor;public class AllInterceptor implements WebRequestInterceptor {    /**     * 在请求处理之前执行，该方法主要是用于准备资源数据的，然后可以把它们当做请求属性放到WebRequest中     */    @Override    public void preHandle(WebRequest request) throws Exception {        // TODO Auto-generated method stub        System.out.println("AllInterceptor...............................");        request.setAttribute("request", "request", WebRequest.SCOPE_REQUEST);//这个是放到request范围内的，所以只能在当前请求中的request中获取到        request.setAttribute("session", "session", WebRequest.SCOPE_SESSION);//这个是放到session范围内的，如果环境允许的话它只能在局部的隔离的会话中访问，否则就是在普通的当前会话中可以访问         request.setAttribute("globalSession", "globalSession",        WebRequest.SCOPE_GLOBAL_SESSION);//如果环境允许的话，它能在全局共享的会话中访问，否则就是在普通的当前会话中访问    }    /**     * 该方法将在Controller执行之后，返回视图之前执行，ModelMap表示请求Controller处理之后返回的Model对象，所以可以在     * 这个方法中修改ModelMap的属性，从而达到改变返回的模型的效果。     */    @Override    public void postHandle(WebRequest request, ModelMap map) throws Exception {        //TODO Auto -generated method stub        for (String key : map.keySet())            System.out.println(key + "-------------------------");        map.put("name3", "value3");        map.put("name1", "name1");    }    /**     * 该方法将在整个请求完成之后，也就是说在视图渲染之后进行调用，主要用于进行一些资源的释放     */    @Override    public void afterCompletion(WebRequest request, Exception exception)            throws Exception {        // TODO Auto-generated method stub        System.out.println(exception +                "-=-=--=--=-=-=-=-=-=-=-=-==-=--=-=-=-=");    } }
```
工作原理
SpringMVC具有统一的入口DispatcherServlet，所有的请求都通过DispatcherServlet，所以只需要在DispatcherServlet上做文章即可，DispatcherServlet也没有代理，同时SpringMVC管理的Controller也不有代理。哪不难想到我们在执行controller之前做某些动作，执行完毕做某些动作，render完成做某些动作。SpringMVC的拦截器对应提供了三个preHandle，postHandle，afterCompletion方法。只需在三个方法内写我们需要的逻辑就行了。
同时SpringMVC的拦截器也采用了责任链的思想，将会根据在配置文件中定义的拦截器顺序来进行拦截。先顺序执行preHandle方法，然后逆序执行postHandle方法，最后执行afterCompletion方法。

具体的源码分析可以参考SpringMVC拦截器详解[附带源码分析]

应用场景
(1)性能监控
如记录一下请求的处理时间，得到一些慢请求（如处理时间超过500毫秒），从而进行性能改进，一般的反向代理服务器如apache都具有这个功能，但此处我们演示一下使用拦截器怎么实现。
实现分析：
1、在进入处理器之前记录开始时间，即在拦截器的preHandle记录开始时间；
2、在结束请求处理之后记录结束时间，即在拦截器的afterCompletion记录结束实现，并用结束时间-开始时间得到这次请求的处理时间。
问题：
我们的拦截器是单例，因此不管用户请求多少次都只有一个拦截器实现，即线程不安全，那我们应该怎么记录时间呢？
解决方案是使用ThreadLocal，它是线程绑定的变量，提供线程局部变量（一个线程一个ThreadLocal，A线程的ThreadLocal只能看到A线程的ThreadLocal，不能看到B线程的ThreadLocal）。

package cn.javass.chapter5.web.interceptor;  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();//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));      }          }  }

(2)登录检测
在访问某些资源时（如订单页面），需要用户登录后才能查看，因此需要进行登录检测。
流程：
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;  }

总结
由上面我们可以看出，拦截器是在请求到达方法前及执行方法后对请求进行一定的处理，把公共的部分进行抽象，如事务处理，性能统计等。拦截器也是一种AOP。

四、相同点与不同点

通过对过滤器和拦截器的学习可以发现，它们有很多相似之处：都是用于对处理器进行预处理和后处理、都采用了责任链模式的思想、都是一种面向切面编程。

那它们有什么不同呢？在网上找了很久，大致是以下几点：

执行顺序不同：首先客户端发起的请求进入到web容器中之后，会先经过Filter，然后进入Servlet，被Interceptor处理，之后到达资源，返回的时候先经过Interceptor，然后是Filter，最后返回给客户端。可以参考下图
使用范围不同：Filter是Servlet规范规定的，只能用于Web程序中。而拦截器既可以用于Web程序，也可以用于Application、Swing程序中。拦截器只能对action请求起作用，而过滤器则可以对几乎所有的请求起作用。这点我的理解是，Filter除了能过滤action请求，还能过滤图片、css等。
规范不同：Filter是在Servlet规范中定义的，是Servlet容器支持的。而拦截器是在Spring容器内的，是Spring框架支持的。拦截器不依赖与servlet容器，过滤器依赖于servlet容器。
机制不同：拦截器是基于Java的反射机制的，而过滤器是基于函数回调。Filter里的doFilter()方法就是很明显的函数回调机制。在action的生命周期中，拦截器可以多次被调用，而过滤器只能在容器初始化时被调用一次。Filter是定义在web.xml中，当请求到达的时候会先经过Filter，然后再到达对应的action等，所以过滤器是只有当有请求时才会调用。
但是Interceptor不一样，Interceptor的原理是反射，可以定义为在调用某个方法时调用拦截器中的方法。
```
可以去看一下spring的aop，或者spring中事务的实现方式，关键字可以查一下java的动态代理。
```
使用的资源不同：同其他的代码块一样，拦截器也是一个Spring的组件，归Spring管理，配置在Spring文件中，因此能使用Spring里的任何资源、对象，例如Service对象、数据源、事务管理等，通过IoC注入到拦截器即可；而Filter则不能。拦截器可以访问action上下文、值栈里的对象，而过滤器不能访问。
深度不同：Filter在只在Servlet前后起作用。而拦截器能够深入到方法前后、异常抛出前后等，因此拦截器的使用具有更大的弹性。

其他不同可以参考关于过滤器，拦截器，监听器具体应用上的区别？

参考资料：
1.SpringMVC拦截器详解[附带源码分析]
2.JAVA学习篇–javaweb之Filter详解
3.SpringMVC中使用Interceptor拦截器
4.Spring AOP原理及拦截器
5.Java过滤器与SpringMVC拦截器之间的关系与区别
6.第五章处理器拦截器详解——跟着开涛学SpringMVC

0 0