springboot 中 HandlerInterceptor和Filter区别及使用

蔚落 2023-05-30 03:52 19阅读 0赞

#     引言   #

经常在项目中看到 filter和HandlerInterceptor，很时候感觉很像，但那只是那感觉 ，真正可不一样，那它们两个到底兄弟还是陌生人呢？请看下方，让我细细道来，

## 过滤器（Filter） ##

Servlet中的过滤器Filter是实现了javax.servlet.Filter接口的服务器端程序，主要的用途是设置字符集、控制权限、控制转向、做一些业务逻辑判断等。其工作原理是，只要你在web.xml文件配置好要拦截的客户端请求，它都会帮你拦截到请求，此时你就可以对请求或响应(Request、Response)统一设置编码，简化操作；同时还可进行逻辑判断，如用户是否已经登陆、有没有权限访问该页面等等工作。它是随你的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有四种方法

具体参考 ：[https://blog.csdn.net/yb546822612/article/details/102950981][https_blog.csdn.net_yb546822612_article_details_102950981]

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

*  void init(FilterConfig config):用于完成Filter的初始化。
 *  void destory():用于Filter销毁前，完成某些资源的回收。
 *  void doFilter(ServletRequest request,ServletResponse response,FilterChain chain):实现过滤功能，该方法就是对每个请求及响应增加的额外处理。该方法可以实现对用户请求进行预处理(ServletRequest request)，也可实现对服务器响应进行后处理(ServletResponse response)—它们的分界线为是否调用了chain.doFilter(),执行该方法之前，即对用户请求进行预处理；执行该方法之后，即对服务器响应进行后处理。

# HandlerInterceptor （拦截器） #

HandlerInterceptor 的功能跟过滤器类似，但是提供更精细的的控制能力：在request被响应之前、request被响应之后、视图渲染之前以及request全部结束之后。我们不能通过拦截器修改request内容，但是可以通过抛出异常（或者返回false）来暂停request的执行。

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

（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 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

<table> 
 <tbody> 
 <tr> 
 <td style="border-color:#000000;vertical-align:middle;width:124.2pt;">Filter接口定义在Javax.servlet包中</td> 
 <td style="border-color:#000000;vertical-align:middle;width:198pt;">接口HandlerInterceptor定义在org.springframework.web.servlet包中。</td> 
 <td style="border-color:#000000;vertical-align:middle;width:259.8pt;">所在包不同</td> 
 </tr> 
 <tr> 
 <td style="border-color:#000000;vertical-align:middle;width:124.2pt;">Filter在Servlet前后起作用,Filters通常将请求和相应当做黑盒，Filter通常不考虑servlet的实现</td> 
 <td style="border-color:#000000;vertical-align:middle;width:198pt;">拦截器能够深入到方法前后、异常抛出前后等，因此拦截器的使用具有更大的弹性。允许用户介入（hook into）请求的生命周期，在请求过程中获取信息，Interceptor 通常和请求更加耦合。</td> 
 <td style="border-color:#000000;vertical-align:middle;width:259.8pt;">在Spring构架的程序中，要优先使用拦截器。几乎所有 Filter 能够做的事情， interceptor 都能够轻松的实现</td> 
 </tr> 
 <tr> 
 <td style="border-color:#000000;vertical-align:middle;width:124.2pt;">Filter 是 Servlet 规范规定的。&nbsp;&nbsp; &nbsp;</td> 
 <td style="border-color:#000000;vertical-align:middle;width:198pt;">而拦截器既可以用于Web程序，也可以用于Application、Swing程序中。&nbsp;&nbsp; &nbsp;</td> 
 <td style="border-color:#000000;vertical-align:middle;width:259.8pt;">使用范围不同</td> 
 </tr> 
 <tr> 
 <td style="border-color:#000000;vertical-align:middle;width:124.2pt;">Filter是Servlet规范中定义的，是Servlet容器支持的&nbsp;&nbsp; &nbsp;</td> 
 <td style="border-color:#000000;vertical-align:middle;width:198pt;">拦截器在Spring容器内，由Spring进行管理&nbsp;&nbsp; &nbsp;</td> 
 <td style="border-color:#000000;vertical-align:middle;width:259.8pt;">规范不同</td> 
 </tr> 
 <tr> 
 <td style="border-color:#000000;vertical-align:middle;width:124.2pt;">Filter不能够使用Spring容器资源&nbsp;&nbsp; &nbsp;</td> 
 <td style="border-color:#000000;vertical-align:middle;width:198pt;">拦截器是Spring的组件，归Spring管理，配置在Spring文件中，因此可以使用Spring里的任何资源，对象等&nbsp;&nbsp; &nbsp;</td> 
 <td style="border-color:#000000;vertical-align:middle;width:259.8pt;">Spring中使用Interceptor更加容易</td> 
 </tr> 
 <tr> 
 <td style="border-color:#000000;vertical-align:middle;width:124.2pt;">Filter是被Server(tomcat etc)调用&nbsp;&nbsp; &nbsp;</td> 
 <td style="border-color:#000000;vertical-align:middle;width:198pt;">Interceptor是被Spring调用&nbsp;&nbsp; &nbsp;</td> 
 <td style="border-color:#000000;vertical-align:middle;width:259.8pt;">Filter总是优先于Intreceptor执行</td> 
 </tr> 
 </tbody> 
</table>

因为Filter是作用在Servlet前。Interceptor执行在controller前。所以正确的处理流程是

**   Filter前处理 --> Interceptor前处理 --> controller--> Interceptor后处理 --> Filter后处理**

### Interceptor实现 ###

下面将介绍如何使用Interceptor实现拦截功能

1、定义Interceptor

@Component
    public class LoginInterceptor implements HandlerInterceptor {
    	@Override
    	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
    			throws Exception {
    		Object obj = request.getSession().getAttribute(MaydayConst.USER_SESSION_KEY);
    		// 如果user不为空则放行
    		if (null != obj) {
    			return true;
    		}
    		// 否则拦截并跳转到登录
    		response.sendRedirect("/admin/login");
    		return false;
    	}
    
    	@Override
    	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
    			ModelAndView modelAndView) throws Exception {
    	}
    
    	@Override
    	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
    			throws Exception {
    	}
    }

##   2、注册拦截器 ##

@Configuration
    public class WebMvcConfig implements WebMvcConfigurer {
    	@Autowired
    	private LoginInterceptor loginAuthenticator;
    
    	/**
    	 * 注册拦截器
    	 */
    	@Override
    	public void addInterceptors(InterceptorRegistry registry) {
    		registry.addInterceptor(loginAuthenticator).addPathPatterns("/admin/**").excludePathPatterns("/admin/login")
    				.excludePathPatterns("/admin/getLogin");//自定义拦截的url路径，
    	}
    
    }

## 过滤器（Filter）使用 ##

Servlet 的 Filter 接口需要实现如下方法：

具体参考 ：[https://blog.csdn.net/yb546822612/article/details/102950981][https_blog.csdn.net_yb546822612_article_details_102950981]

![format_png][]

[https_blog.csdn.net_yb546822612_article_details_102950981]: https://blog.csdn.net/yb546822612/article/details/102950981
[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi8xaFJlSGFxYWZhZXQ3V0Q1bU1lcldlOGVwVzFNRm02YUU2c0tyc08wdjhwSktDaWJETFJEZDFtTFppYURTeTFxRGpPaGFMdmVZZEl5N3gzb3plbkkxdG5RLzY0MD93eF9mbXQ9Z2lm?x-oss-process=image/format,png