Spring Interceptor vs Filter 拦截器和过滤器区别

最新推荐文章于 2024-07-16 15:34:15 发布

chaiyu2002

最新推荐文章于 2024-07-16 15:34:15 发布

阅读量951

点赞数

分类专栏： Java 文章标签： Spring interceptor filter

原文链接：http://einverne.github.io/post/2017/08/spring-interceptor-vs-filter.html

版权

Java 专栏收录该内容

42 篇文章 3 订阅

订阅专栏

前言

转载一篇介绍 Spring 的 Interceptor 和 Filter 的文章，转自：http://einverne.github.io/post/2017/08/spring-interceptor-vs-filter.html。

这篇文章感觉讲的不错，还需要深度去理解和分析一下，所以这里摘抄一下原文，同时记录一下笔记，同时感觉有些格式或者标点符号或者大小写存在一点问题，也随之修改一下。

正文

Spring Interceptor vs Filter 拦截器和过滤器区别

Posted on 08/14/2017 by Ein Verne | View revision history

Spring 的 Interceptor（拦截器）与 Servlet 的 Filter 有相似之处，都能实现权限检查、日志记录等。不同的是：

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

Interceptor 使用

Interceptor 的执行顺序大致为：

请求到达 DispatcherServlet
DispatcherServlet 发送至 Interceptor ，执行 preHandle
请求达到 Controller
请求结束后，postHandle 执行

Spring 中主要通过 HandlerInterceptor 接口来实现请求的拦截，实现 HandlerInterceptor 接口需要实现下面三个方法：

preHandle() – 在handler执行之前，返回 boolean 值，true 表示继续执行，false 为停止执行并返回。
postHandle() – 在handler执行之后, 可以在返回之前对返回的结果进行修改。
afterCompletion() – 在请求完全结束后调用，可以用来统计请求耗时等等。

统计请求耗时

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.log4j.Logger;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

public class ExecuteTimeInterceptor extends HandlerInterceptorAdapter{

	private static final Logger logger = Logger.getLogger(ExecuteTimeInterceptor.class);

	//before the actual handler will be executed
	public boolean preHandle(HttpServletRequest request,
		HttpServletResponse response, Object handler)
		throws Exception {

		long startTime = System.currentTimeMillis();
		request.setAttribute("startTime", startTime);

		return true;
	}

	//after the handler is executed
	public void postHandle(
		HttpServletRequest request, HttpServletResponse response,
		Object handler, ModelAndView modelAndView)
		throws Exception {

		long startTime = (Long)request.getAttribute("startTime");

		long endTime = System.currentTimeMillis();

		long executeTime = endTime - startTime;

		//modified the exisitng modelAndView
		modelAndView.addObject("executeTime",executeTime);

		//log it
		if(logger.isDebugEnabled()){
		   logger.debug("[" + handler + "] executeTime : " + executeTime + "ms");
		}
	}
}

例子来源 mkyong

使用mvc:interceptors标签来声明需要加入到SpringMVC拦截器链中的拦截器

<mvc:interceptors>  
<!-- 使用bean定义一个Interceptor，直接定义在mvc:interceptors根下面的Interceptor将拦截所有的请求 -->  
<bean class="com.company.app.web.interceptor.AllInterceptor"/>  
	<mvc:interceptor>  
		 <mvc:mapping path="/**"/>  
		 <mvc:exclude-mapping path="/parent/**"/>  
		 <bean class="com.company.authorization.interceptor.SecurityInterceptor" />  
	</mvc:interceptor>  
	<mvc:interceptor>  
		 <mvc:mapping path="/parent/**"/>  
		 <bean class="com.company.authorization.interceptor.SecuritySystemInterceptor" />  
	</mvc:interceptor>  
</mvc:interceptors>

可以利用 mvc:interceptors 标签声明一系列的拦截器，然后它们就可以形成一个拦截器链，拦截器的执行顺序是按声明的先后顺序执行的，先声明的拦截器中的 preHandle 方法会先执行，然而它的 postHandle 方法和 afterCompletion 方法却会后执行。

在 mvc:interceptors 标签下声明 Interceptor 主要有两种方式：

直接定义一个 Interceptor 实现类的 bean 对象。使用这种方式声明的 Interceptor 拦截器将会对所有的请求进行拦截。
使用 mvc:interceptor 标签进行声明。使用这种方式进行声明的 Interceptor 可以通过 mvc:mapping 子标签来定义需要进行拦截的请求路径。

经过上述两步之后，定义的拦截器就会发生作用对特定的请求进行拦截了。

Filter 使用

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

void init(FilterConfig paramFilterConfig) – 当容器初始化 Filter 时调用，该方法在 Filter 的生命周期只会被调用一次，一般在该方法中初始化一些资源，FilterConfig 是容器提供给 Filter 的初始化参数，在该方法中可以抛出 ServletException 。init 方法必须执行成功，否则 Filter 可能不起作用，出现以下两种情况时，web 容器中 Filter 可能无效： 1）抛出 ServletException 2）超过 web 容器定义的执行时间。
doFilter(ServletRequest paramServletRequest, ServletResponse paramServletResponse, FilterChain paramFilterChain) – Web 容器每一次请求都会调用该方法。该方法将容器的请求和响应作为参数传递进来， FilterChain 用来调用下一个 Filter。
void destroy() – 当容器销毁 Filter 实例时调用该方法，可以在方法中销毁资源，该方法在 Filter 的生命周期只会被调用一次。
FrequencyLimitFilter com.company.filter.FrequencyLimitFilter FrequencyLimitFilter /login/*

Filter 和 Interceptor 的一些用途

Authentication Filters
Logging and Auditing Filters
Image conversion Filters
Data compression Filters
Encryption Filters
Tokenizing Filters
Filters that trigger resource access events
XSL/T filters
Mime-type chain Filter

Request Filters 可以:

执行安全检查 perform security checks
格式化请求头和主体 reformat request headers or bodies
审查或者记录日志 audit or log requests
根据请求内容授权或者限制用户访问 Authentication-Blocking requests based on user identity.
根据请求频率限制用户访问

Response Filters 可以:

压缩响应内容，比如让下载的内容更小 Compress the response stream
追加或者修改响应 append or alter the response stream
创建或者整体修改响应 create a different response altogether
根据地方不同修改响应内容 Localization-Targeting the request and response to a particular locale.