引言
在Web开发中,经常需要对请求进行预处理或在响应后进行后处理,Spring Boot提供了过滤器和拦截器两种机制来实现这一需求。虽然它们都可以用来处理HTTP请求和响应,但在使用场景、执行顺序和配置方式上存在明显的差异。本文将详细讲解Spring Boot中过滤器和拦截器的概念、使用方法和它们之间的区别。
一、过滤器(Filter)的配置
方式 一 :使用spring boot提供的FilterRegistrationBean注册Filter
1. 实现Filter接口:
创建一个类并实现javax.servlet.Filter接口,重写doFilter方法。
public class LogCostFilter implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {long start = System.currentTimeMillis();filterChain.doFilter(servletRequest,servletResponse);System.out.println("Execute cost="+(System.currentTimeMillis()-start));}@Overridepublic void destroy() {}
}
2. 注册自定义Filter
在Spring boot中,我们需要FilterRegistrationBean来完成配置。其实现过程如下:
@Configuration
public class FilterConfig {@Beanpublic FilterRegistrationBean registFilter() {FilterRegistrationBean registration = new FilterRegistrationBean();registration.setFilter(new LogCostFilter());registration.addUrlPatterns("/*");registration.setName("LogCostFilter");registration.setOrder(1);return registration;}}
方式二:使用原生servlet注解定义Filter
除了通过 FilterRegistrationBean 来配置以外,还有一种更直接的办法,直接通过注解就可以完成了:
@WebFilter(urlPatterns = "/*", filterName = "logFilter2")
public class LogCostFilter2 implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {long start = System.currentTimeMillis();filterChain.doFilter(servletRequest, servletResponse);System.out.println("LogFilter2 Execute cost=" + (System.currentTimeMillis() - start));}@Overridepublic void destroy() {}
}
这里直接用@WebFilter
就可以进行配置,同样,可以设置url匹配模式,过滤器名称等。这里需要注意一点的是**@WebFilter这个注解是Servlet3.0的规范**,并不是Spring boot提供的。除了这个注解以外,我们还需在配置类中加另外一个注解:@ServletComponetScan
,指定扫描的包。
@SpringBootApplication
@MapperScan("com.dz.blog.dao")
@ServletComponentScan("com.dz.blog.filters")
public class Application {public static void main(String[] args) throws Exception {SpringApplication.run(Application.class, args);}
}
二、拦截器(Interceptor)的配置
拦截器是Spring MVC框架中的一部分,用于在请求处理前后执行一些操作,如权限验证、日志记录等。拦截器通过实现HandlerInterceptor接口
或继承HandlerInterceptorAdapter类
来实现。
我们使用拦截器来实现上面同样的功能,记录请求的执行时间。
1. 首先我们实现拦截器类:
public class LogCostInterceptor implements HandlerInterceptor {long start = System.currentTimeMillis();@Overridepublic boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {// 请求前处理逻辑 start = System.currentTimeMillis();// 如果返回false,则请求终止return true;}@Overridepublic void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {// 请求后处理逻辑System.out.println("Interceptor cost="+(System.currentTimeMillis()-start));}@Overridepublic void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {// 整个请求处理完毕后调用 }
}
2. 注册Interceptor:
在配置类中通过实现WebMvcConfigurer接口并重写addInterceptors方法来注册拦截器。
@Configuration
public class InterceptorConfig extends WebMvcConfigurerAdapter {@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(new LogCostInterceptor()).addPathPatterns("/**");super.addInterceptors(registry);}
}
三、过滤器和拦截器的区别
- 参考标准
- 过滤器是 JavaEE 的标准,依赖于 Servlet 容器,生命周期也与容器一致,利用这一特性可以在销毁时释放资源或者数据入库。
- 拦截器是SpringMVC中的内容,依赖于web框架,通常用于验证用户权限或者记录日志,但是这些功能也可以利用 AOP 来代替。
- 实现方式
-
过滤器是基于回调函数实现,无法注入 ioc 容器中的 bean。
-
拦截器是基于反射来实现,因此拦截器中可以注入 ioc 容器中的 bean,例如注入 Redis 的业务层来验证用户是否已经登录。
-
过滤器(Filter) :可以拿到原始的http请求,但是拿不到你请求的控制器和请求控制器中的方法的信息。
-
拦截器(Interceptor):可以拿到请求的控制器和方法,却拿不到请求方法的参数。
-
切片(Aspect): 可以拿到方法的参数,但是却拿不到http请求和响应的对象
参考文献:
https://developer.aliyun.com/article/1271920