秒懂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

相关内容

热门资讯

王者定位怎么关安卓系统,轻松实... 你是不是也和我一样,对王者荣耀这款游戏爱得深沉呢?不过,有时候游戏里的设置让人头疼,比如安卓系统的王...
树莓派安卓系统流畅,打造便携式... 亲爱的读者们,你是否曾想过,将树莓派与安卓系统结合,会擦出怎样的火花呢?今天,就让我带你一起探索这个...
安卓系统智能机顶盒,引领家庭娱... 你有没有想过,家里的电视也能变得智能起来?没错,就是那个陪伴我们多年的老电视,现在也能摇身一变,成为...
安卓系统很差了吗现在,性能优劣... 最近是不是有不少朋友在讨论安卓系统的问题呢?有人说它越来越差了,也有人觉得它还是那个熟悉的“老朋友”...
安卓系统uc安装包,Andro... 你有没有发现,手机里的安卓系统越来越强大了?今天,咱们就来聊聊这个话题——安卓系统中的UC安装包。你...
安卓系统谷歌能删吗,谷歌能否删... 你有没有想过,那个一直陪伴你手机生活的安卓系统,它背后的谷歌爸爸,是不是也能被你随意删掉呢?这可不是...
安卓系统会不会更耗电,解析其功... 你有没有发现,手机用着用着,电池就有点不给力了?尤其是那些用安卓系统的手机,有时候感觉电就像流水一样...
安卓系统中无效目录,安卓系统无... 你有没有遇到过在安卓系统中,明明文件夹就在那里,但是就是找不到的情况?别急,今天就来给你揭秘安卓系统...
国产安卓机哪个系统好用,探寻最... 你有没有想过,国产安卓机哪个系统最好用呢?这可是个让人纠结的问题,毕竟每个系统都有它的特色和亮点。今...
安卓系统cpua9,引领性能与... 你有没有发现,最近你的安卓手机运行得是不是比以前顺畅多了?这可多亏了那个强大的安卓系统CPUA9啊!...
安卓系统usb驱动程序,功能、... 你有没有遇到过这种情况:手机里存了那么多宝贝照片和视频,想传输到电脑上保存,结果电脑却像个小顽皮,死...
安卓操作系统怎么关闭,轻松关闭... 手机里的安卓操作系统是不是有时候让你觉得有点儿烦呢?别急,今天就来手把手教你如何轻松关闭安卓操作系统...
追星手机壳推荐安卓系统,盘点热... 你有没有发现,现在追星族们对手机壳的热爱简直到了疯狂的地步?没错,就是那种能让你一秒变身偶像迷妹的手...
ios系统用安卓系统游戏下载软... 你有没有想过,明明是iOS系统的手机,却想玩安卓系统的游戏?这可不是什么天方夜谭,现在就有这么神奇的...
安卓高系统怎么用美化,打造专属... 亲爱的安卓用户们,你是不是也和我一样,对手机系统美化情有独钟呢?想要让你的安卓手机焕然一新,变得个性...
安卓系统怎么开夜间模式,安卓系... 亲爱的手机控们,你是不是在夜晚使用安卓手机时,眼睛感到有些不适?别担心,今天我要给你揭秘一个超级实用...
王者安卓系统用苹果人脸,一场视... 你知道吗?最近在手机圈里可是掀起了一股不小的波澜呢!那就是王者安卓系统竟然用上了苹果人脸识别技术!是...
安卓444怎么升级系统,轻松迈... 你那安卓444的小家伙是不是已经有点儿落伍了?别急,今天就来给你详细说说怎么给它来个系统升级,让它焕...
安卓系统raw修图软件,探索安... 你有没有发现,手机拍照越来越方便了,但有时候拍出来的照片还是不够完美呢?别急,今天就来给你安利几款安...
安卓系统的王者切换苹果,从安卓... 你知道吗?最近身边的朋友圈里掀起了一股热潮,那就是安卓系统的王者们纷纷切换到苹果阵营。这可真是让人大...