秒懂SpringBoot之Filter与HandlerInterceptor异同
创始人
2024-05-29 22:08:05
0

[版权申明] 非商业目的注明出处可自由转载
出自:shusheng007

文章目录

  • 概述
  • 前置知识
  • Filter
    • 原理及使用场景
    • 使用
    • 执行顺序
    • 设置Filter作用范围
  • HandlerInterceptor
    • 原理及使用场景
    • 使用
      • 实现`org.springframework.web.servlet.HandlerInterceptor` 接口
      • 配置
  • 二者异同
    • 共同点
    • 不同点
  • 总结
  • 源码

概述

在日常开发中,我们会经常用到Filter和HandlerInterceptor,刚接触时感觉二者差不多,那二者有什么异同呢?谁先执行谁后执行呢?分别在什么场景下使用呢?接下来让我们看一下

前置知识

先上一张偶亲手画的图吧,正所谓一图胜千言,不理解无所谓,我们一起来看下。
在这里插入图片描述

你有没有觉得在一个熟悉的领域学习相关的新知识就非常容易理解,因为他们直接环环相扣,互相联系,这就是所谓的经验的优势。例如我们今天要谈论的Filter和HandlerIntercetor,如果你不具备Sevlet以及SpringMvc原理的基础知识就会显得很晦涩,而对于有这部分知识的同学就会显得非常的简单易懂。此处我简单描述一下,作为理解下面内容的背景知识。

  1. 利用SpringMvc开发的Web程序需要运行在Servlet容器中(Web服务器),例如Tomcat。
  2. SpringMvc使用一个叫DispatcherServlet的组件来接收所有的请求,然后分发给我们写得Controller。

假设我们使用springboot写了一个helloworld的web程序,使用内置的Tomcat来运行,那么一个请求过来会按照下面的路径处理。

request-->tomcat-->filter-->dispatcherSevlet-->handlerInterceptor-->controller

Filter

原理及使用场景

首先Filter不属于Spring框架,而是属于WebServer的,例如Tomcat,其位于org.apache.tomcat.embed:tomcat-embed-core中。
在这里插入图片描述
因为请求到达servlet之前都要经过Filter,在此我们可以访问Request和Response,因而可以做很多切面性的工作,最典型的就是授权和认证。例如Spring Security就是使用Filter工作的。

使用

在springboot程序中实现一个Filter非常简单,只需要实现javax.servlet.Filter接口并使用@Componse标记即可

@Slf4j
@Component
public class AuthFilter implements Filter {@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {HttpServletRequest request = (HttpServletRequest) servletRequest;log.info("AuthFilter请求url:{}", request.getRequestURL());filterChain.doFilter(servletRequest, servletResponse);}
}

doFilter方法中我们可以拿到ServletRequest ServletResponse ,因而可以获取到非常多请求相关的信息,然后根据自己的业务来处理即可

执行顺序

既然有多个Filter,那么就会存在执行顺序问题,我们如何控制多个Filter的执行顺序呢?

可以使用@Order注解

@Slf4j
@Order(1)
@Component
public class AuthFilter implements Filter {...
}

order里的数字越小越早执行。

设置Filter作用范围

默认情况下Filter将作用于每个请求,我们可以设置让其只作用于某些特定的请求,例如我我们设置AuthFilter 只作用于/auth开头的请求。在这里也可以设置执行顺序,其优先级高于@Order

@Configuration
public class FilterConfiguration {@Autowiredprivate AuthFilter authFilter;@Beanpublic FilterRegistrationBean filterRegistrationBean() {FilterRegistrationBean registrationBean = new FilterRegistrationBean<>();registrationBean.setFilter(authFilter);registrationBean.addUrlPatterns("/auth/*");registrationBean.setOrder(0);return registrationBean;}
}

通过这种方法还可以使用第三方的Filter。

HandlerInterceptor

原理及使用场景

HandlerInterceptorSpringMvc的组件,其位于DispatcherServletController之间。其位于
org.springframework:spring-webmvc中。

使用

在springboot程序中实现一个HandlerInterceptor较为简单,但是比Filter难一点,需要两步。

实现org.springframework.web.servlet.HandlerInterceptor 接口

其包含3个default方法,我们选择性的实现即可,preHandle使用的频率更高。

  • preHandle:在Controller方法执行之前执行
  • postHandle:在Controller方法执行以后,但是还没有渲染页面之前执行。

这就是它为什么多了一个ModelAndView 类型的参数,但是如今流行前后端分离,所以一般都是返回json数据给前端,不会返回html页面,所以这个参数几乎不怎么用的到。

  • afterCompletion: 在Controller方法完全执行完毕后触发

下面是一个实现。

@Slf4j
public class LogInterceptor implements HandlerInterceptor {@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {log.info("preHandle {}:{}:{}",request.getRequestURL(),response.getStatus(),handler);return true;}@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {log.info("postHandle {}:{}:{}:{}",request,response,handler,modelAndView);}@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {log.info("afterCompletion {}:{}:{}:{}",request,response,handler,ex);}
}

配置

有了Interceptor还需要使其生效,我们需要实现org.springframework.web.servlet.config.annotation.WebMvcConfigurer 。因为SpringBoot已经默认启用了@EnableWebMvc,所以可以使用这个接口的实现类配置web相关的功能,这个接口的可配置项纷繁复杂,幸好SpringBoot已经帮我们配置了默认值,不然就蛋疼了… 这里我们只需要重写addInterceptors即可

@Configuration
public class WebConfig implements WebMvcConfigurer {@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(new LogInterceptor());}
}

二者异同

共同点

在SpringMvc中二者均可以实现切面性的工作。

不同点

首先两个东西隶属于不同的框架,Filter更具通用性,粒度更粗。例如你只能从Filter里面拿到http请求相关的信息,而拿不到应用层面的信息,例如你写的那个Controller里面的信息。HandlerInterceptor属于SpringMvc的,它的通用性更差,但是控制粒度更细,因为可以获取到应用层面的信息了。例如我现在想在log中记录类名和方法名,Filter就做不到,但是SpringSecurity这类业务无关框架却又不能使用Interceptor。

总结

总之二者各有各的适用场景,合适的才是最好的。这就跟找对象是一样一样的,合适当前场景的才是最好的,随着时间的流逝情况也许会有变化,到时候重构就好了。

源码

一如既往,你可以在首发文章文末找到源码地址秒懂SpringBoot之弄懂Filter与HandlerInterceptor

相关内容

热门资讯

oppo安卓11.1系统新功能... 你知道吗?最近OPPO手机又来了一次大升级,安卓11.1系统的新功能简直让人眼前一亮!今天,就让我带...
win10系统和安卓系统的,全... 你有没有发现,现在手机和电脑的操作系统真是五花八门,让人挑花了眼?今天,咱们就来聊聊两个超级热门的系...
安卓怎么设置重力系统,安卓重力... 你有没有发现,有时候手机屏幕上的图标会自动旋转,就像有看不见的小手在帮你翻书一样?这就是安卓手机的重...
图片管家推荐安卓系统,图片管家... 手机里的图片是不是越来越多,乱糟糟的找不到?别急,今天就来给你安利一款超好用的安卓系统图片管家——它...
安卓2.3系统宣传片,无限可能 你有没有注意到,手机的世界里,有时候一个小小的系统更新就能掀起一阵热潮呢?今天,就让我带你穿越回那个...
有关安卓和苹果系统提问,全面对... 你有没有想过,为什么你的手机里装的是安卓系统,而你的朋友用的是苹果?是不是好奇这两个系统有什么不同?...
安卓系统清理排行榜,助你手机焕... 手机里的安卓系统是不是越来越慢了?别急,今天就来给你揭秘一下安卓系统清理排行榜,让你手机瞬间恢复活力...
安卓系统app自动启动不了,安... 手机里的安卓系统APP突然不自动启动了,这可真是让人头疼啊!你是不是也遇到了这种情况?别急,今天就来...
ios系统和安卓系统哪个才是未... 说到手机操作系统,你是不是也和我一样,对iOS系统和安卓系统哪个才是未来充满了好奇呢?毕竟,这两个系...
最丝滑的安卓系统,最丝滑安卓系... 你有没有想过,手机系统就像是我们生活中的调味品,有时候平淡无奇,有时候却让人回味无穷。今天,就让我带...
笔记本安卓系统下载,下载与使用... 你有没有想过,你的安卓笔记本也能拥有一个全新的操作系统呢?没错,就是那种可以让你在笔记本上畅游安卓世...
老年人安卓手机系统,畅享智能生... 你有没有发现,身边越来越多的老年人开始玩起了智能手机呢?这不,最近我注意到,他们中很多人选择了安卓手...
安卓手机系统大改造,重塑未来 你有没有发现,最近你的安卓手机好像变得不一样了?没错,安卓手机系统正在经历一场大改造,就像换上了新装...
能安装安卓应用的系统,探索无限... 你有没有想过,为什么你的手机可以安装那么多好玩的应用,而电脑就只能用那些固定的软件呢?其实,现在有一...
安卓系统备份备忘录,轻松备份与... 你有没有想过,那些藏在安卓手机里的备忘录,它们就像是你生活中的小秘密,随时准备着为你提供帮助?今天,...
欧沃手机安卓系统,畅享智能生活... 你有没有发现,最近手机市场又掀起了一股热潮?没错,就是欧沃手机!这款手机凭借其出色的性能和亲民的价格...
安卓4.4系统tv软件,探索安... 亲爱的读者们,你是否曾为家里的电视屏幕增添一些智能的魔力而烦恼?别担心,今天我要给你带来一个超级实用...
安卓系统的研究人物,安卓系统发... 你知道吗?在科技飞速发展的今天,安卓系统可是占据了智能手机市场的大半壁江山。而在这片广阔的天地里,有...
山寨苹果刷会安卓系统,安卓系统... 你知道吗?在科技圈里,总有一些让人眼前一亮的小秘密。今天,我要给你揭秘一个关于山寨苹果刷安卓系统的神...
安卓系统新用户登录,畅享智能生... 你刚刚入手了一台全新的安卓手机,是不是有点小激动呢?别急,别急,让我来给你详细介绍一下安卓系统新用户...