过滤器与拦截器

谁借莪１个温暖的怀抱￠ 2022-12-15 11:25 189阅读 0赞

**过滤器（Filter）**

一般所说的Filter都是指Servlet中的过滤器Filter。Servlet中的过滤器Filter是实现了javax.servlet.Filter接口的服务器端程序，其主要的用途是设置字符集、控制权限、控制转向、做一些业务逻辑判断等。其工作原理是，只要我们在web.xml文件配置好要拦截的客户端请求，它都会帮我们拦截到请求，此时我们就可以对请求（Request）或响应(Request)统一设置编码，简化操作；同时还可进行逻辑判断，如用户是否已经登陆、有没有权限访问该页面等等。它是随我们的web应用启动而启动的，只初始化一次，以后就可以拦截相关请求，只有当我们的web应用停止或重新部署的时候才销毁。

Filter通常被认为是Servlet的一种“加强版”，它主要用于对用户的请求进行预处理，也可以对HttpServletResponse进行后处理，是个典型的处理链。Filter也可以对用户的请求生成响应，这一点与Servlet相同，但实际上很少会使用Filter向用户请求生成响应。

使用Filter完整的流程是：首先Filter对用户请求进行预处理，接着将请求交给Servlet进行处理并生成响应，最后Filter再对服务器响应进行后处理。

Filter有以下几个用处：

*  在HttpServletRequest到达Servlet之前，拦截客户的HttpServletRequest。
 *  根据需要检查HttpServletRequest，也可以修改HttpServletRequest头和数据。
 *  在HttpServletResponse到达客户端之前，拦截HttpServletResponse。
 *  根据需要检查HttpServletResponse，也可以修改HttpServletResponse头和数据。

Filter有以下几个种类：

*  用户授权的Filter：该Filter负责检查用户请求，根据请求过滤用户的非法请求。
 *  日志Filter：详细记录某些特殊用户的请求。
 *  负责解码的Filter：包括对非标准编码的请求解码。
 *  能改变XML内容的XSLT Filter等。
 *  Filter可以负责拦截多个请求或响应；一个请求或响应也可以被多个Filter拦截。

需要注意的是，一个Filter可以负责拦截多个请求或响应，同时一个请求或响应也可以被多个Filter拦截。

实际使用时，创建一个Filter只需两个步骤：

1.  创建Filter处理类
2.  web.xml文件中配置Filter

创建Filter必须实现javax.servlet.Filter接口，在该接口中定义了如下三个方法：

*  void init(FilterConfig filterConfig)：用于完成Filter的初始化。当容器初始化 Filter 时调用，该方法在 Filter 的生命周期只会被调用一次，一般在该方法中初始化一些资源，FilterConfig 是容器提供给 Filter 的初始化参数，在该方法中可以抛出 ServletException 。init 方法必须执行成功，否则 Filter 可能不起作用，出现以下两种情况时，web 容器中 Filter 可能无效： 1）抛出 ServletException；2）超过 web 容器定义的执行时间
 *  void destroy()：用于Filter销毁前，完成某些资源的回收。当容器销毁 Filter 实例时调用该方法，可以在方法中销毁资源，该方法在 Filter 的生命周期中只会被调用一次。
 *  void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)：实现过滤功能，该方法就是对每个请求及响应增加具体的额外处理。该方法可以实现对用户请求(ServletRequest request)进行预处理，也可实现对服务器响应进行后处理(ServletResponse response)。它们的分界线为是否调用了chain.doFilter()，执行chain.doFilter()之前，就是对用户请求进行预处理；执行chain.doFilter()之后，就是对服务器响应进行后处理。Web 容器每一次请求都会调用该方法。该方法将容器的请求和响应作为参数传递进来， FilterChain 用来调用下一个 Filter。

public class FilterName implements Filter {
    
        public static Logger logger = LoggerFactory.getLogger(FilterName .class);
    
        @Override
        public void init(FilterConfig filterConfig) {
    
        //完成某些初始化功能
    
        }
    
        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    
        //实现过滤功能
    
        }
    
        @Override
        public void destroy() {
    
        //销毁，完成某些资源的回收
    
        }
    }

**拦截器（Interceptor）**

拦截器是在面向切面编程中应用的，就是在我们的service或者一个方法前调用一个方法，或者在方法后调用一个方法。是基于JAVA的反射机制。拦截器，在AOP(Aspect-Oriented Programming)中用于在某个方法或字段被访问之前，进行拦截，然后在之前或之后加入某些操作。拦截是AOP的一种实现策略。

拦截器将Action共用的行为独立出来，在Action执行前后执行。这也就是我们所说的AOP，它是分散关注的编程方法，它将通用需求功能从不相关类之中分离出来；同时，能够共享一个行为，一旦行为发生变化，不必修改很多类，只要修改这个行为就可以。

当我们提交对Action(默认是.action结尾的url)的请求时，ServletDispatcher会根据我们的请求，去调度并执行相应的Action。在Action执行之前，调用被Interceptor截取，Interceptor在Action执行前后执行。

SpringMVC 中的Interceptor 拦截请求是通过HandlerInterceptor 来实现的。在SpringMVC 中定义一个Interceptor 非常简单，主要有两种方式，第一种方式是要定义的Interceptor类要实现了Spring 的HandlerInterceptor 接口，或者是这个类继承实现了HandlerInterceptor 接口的类，比如Spring 已经提供的实现了HandlerInterceptor 接口的抽象类HandlerInterceptorAdapter ；第二种方式是实现Spring的WebRequestInterceptor接口，或者是继承实现了WebRequestInterceptor的类。通常使用第一种方法进行拦截其的定义。

（1 ）preHandle (HttpServletRequest request, HttpServletResponse response, Object handle) 方法，顾名思义，preHandle()，说明该方法将在请求处理之前进行调用。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 方法的解释我们知道这个方法只能是在当前所属的Interceptor 的preHandle 方法的返回值为true 时才能被调用。postHandle 方法，顾名思义就是在当前请求进行处理之后，也就是Controller 方法调用之后执行，但是它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 是相反的，也就是说先声明的Interceptor 的postHandle 方法反而会后执行。

（3 ）afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex) 方法，该方法也是需要当前对应的Interceptor 的preHandle 方法的返回值为true 时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

public class InterceptorName implements HandlerInterceptor {
        public static Logger logger = LoggerFactory.getLogger(InterceptorName .class);
    
        @Override
        public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
            
        }
    
        @Override
        public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
    
        }
    
        @Override
        public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
    
        }
    
    }

**拦截器与过滤器的区别**

<table> 
 <thead> 
  <tr> 
   <th style="text-align:center;vertical-align:middle;">Filter</th> 
   <th style="text-align:center;vertical-align:middle;">Interceptor</th> 
   <th style="text-align:center;vertical-align:middle;">Summary</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="text-align:center;vertical-align:middle;">Filter 接口定义在 javax.servlet 包中</td> 
   <td style="text-align:center;vertical-align:middle;">接口 HandlerInterceptor 定义在org.springframework.web.servlet 包中</td> 
   <td style="text-align:center;vertical-align:middle;">&nbsp;</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:middle;">Filter 定义在 web.xml 中</td> 
   <td style="text-align:center;vertical-align:middle;">&nbsp;</td> 
   <td style="text-align:center;vertical-align:middle;">&nbsp;</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:middle;">Filter在只在 Servlet 前后起作用。Filters 通常将 请求和响应（request/response） 当做黑盒子，Filter 通常不考虑servlet 的实现</td> 
   <td style="text-align:center;vertical-align:middle;">拦截器能够深入到方法前后、异常抛出前后等，因此拦截器的使用具有更大的弹性。允许用户介入（hook into）请求的生命周期，在请求过程中获取信息，Interceptor 通常和请求更加耦合</td> 
   <td style="text-align:center;vertical-align:middle;">在Spring构架的程序中，要优先使用拦截器。几乎所有 Filter 能够做的事情， interceptor 都能够轻松的实现</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:middle;">Filter 是 Servlet 规范规定的</td> 
   <td style="text-align:center;vertical-align:middle;">而拦截器既可以用于Web程序，也可以用于Application、Swing程序中</td> 
   <td style="text-align:center;vertical-align:middle;">使用范围不同</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:middle;">Filter 是在 Servlet 规范中定义的，是 Servlet 容器支持的</td> 
   <td style="text-align:center;vertical-align:middle;">而拦截器是在 Spring容器内的，是Spring框架支持的</td> 
   <td style="text-align:center;vertical-align:middle;">规范不同</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:middle;">Filter 不能够使用 Spring 容器资源</td> 
   <td style="text-align:center;vertical-align:middle;">拦截器是一个Spring的组件，归Spring管理，配置在Spring文件中，因此能使用Spring里的任何资源、对象，例如 Service对象、数据源、事务管理等，通过IoC注入到拦截器即可</td> 
   <td style="text-align:center;vertical-align:middle;">Spring 中使用 interceptor 更容易</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:middle;">Filter 是被 Server(like Tomcat) 调用</td> 
   <td style="text-align:center;vertical-align:middle;">Interceptor 是被 Spring 调用</td> 
   <td style="text-align:center;vertical-align:middle;">因此 Filter 总是优先于 Interceptor 执行</td> 
  </tr> 
 </tbody> 
</table>

参考文章：[过滤器（Filter）与拦截器（Interceptor )区别][Filter_Interceptor]

[https://www.cnblogs.com/junzi2099/p/8022058.html][Filter_Interceptor]

[Filter_Interceptor]: https://www.cnblogs.com/junzi2099/p/8022058.html