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

相关内容

热门资讯

nova 4刷安卓系统,体验全... 最近手机界可是热闹非凡呢!听说华为nova 4要刷安卓系统了,这可真是让人兴奋不已。你有没有想过,你...
如果当初没有安卓系统,科技世界... 想象如果没有安卓系统,我们的生活会是怎样的呢?是不是觉得有点不可思议?别急,让我们一起穿越时空,探索...
安卓电视装win系统,系统转换... 亲爱的读者们,你是否曾想过,在你的安卓电视上装一个Windows系统,让它瞬间变身成为一台功能强大的...
安卓手机还原系统好处,重拾流畅... 你有没有遇到过安卓手机卡顿、运行缓慢的情况?别急,今天就来给你揭秘一下安卓手机还原系统的那些好处,让...
安卓系统能跑win吗,探索跨平... 你有没有想过,你的安卓手机里能不能装上Windows系统呢?这听起来是不是有点像科幻电影里的情节?别...
安卓车载系统蓝牙设置,畅享智能... 你有没有发现,现在开车的时候,手机和车载系统之间的互动越来越频繁了呢?这不,今天就来给你详细说说安卓...
奥利奥安卓系统,探索新一代智能... 你有没有想过,一块小小的奥利奥饼干竟然能和强大的安卓系统扯上关系?没错,今天就要来聊聊这个跨界组合,...
微信使用安卓系统,功能解析与操... 你有没有发现,现在用微信的人越来越多了呢?尤其是安卓系统的用户,简直就像潮水一样涌来。今天,就让我带...
体验最新原生安卓系统,极致体验... 你有没有想过,手机系统就像是我们生活的调味品,有时候换一种口味,生活都会变得有趣起来呢?最近,我体验...
安卓系统能玩原神,尽享奇幻冒险... 你有没有想过,在安卓系统上也能畅玩《原神》这样的热门游戏呢?没错,就是那个画面精美、角色丰富、玩法多...
安卓写手机银行系统,基于安卓平... 你有没有想过,手机银行系统在我们日常生活中扮演了多么重要的角色呢?每天刷刷手机,就能轻松管理账户,转...
僵尸之夜恐怖安卓系统,揭秘恐怖... 僵尸之夜,恐怖安卓系统来袭!想象一个寂静的夜晚,你正沉浸在美梦中,突然,一阵诡异的铃声打破了夜的宁静...
谷歌框架和安卓系统,构建智能移... 你有没有想过,为什么你的手机那么聪明,能帮你找到路线,还能帮你拍出美美的照片呢?这都要归功于一个超级...
安卓系统和oppo系统哪个流畅... 你有没有想过,手机系统哪个更流畅呢?安卓系统和OPPO系统,这两个名字听起来就让人心动。今天,咱们就...
安卓怎么用微软系统,利用微软系... 你是不是也和我一样,对安卓手机上的微软系统充满了好奇?想象那熟悉的Windows界面在你的安卓手机上...
安卓系统如何安装nfc,安卓系... 你有没有想过,用手机刷公交卡、支付账单,是不是比掏出钱包来得酷炫多了?这就得归功于NFC技术啦!今天...
ios系统可以转安卓,跨平台应... 你有没有想过,你的iPhone手机里的那些宝贝应用,能不能搬到安卓手机上继续使用呢?没错,今天就要来...
iOSapp移植到安卓系统,i... 你有没有想过,那些在iOS上让你爱不释手的app,是不是也能在安卓系统上大放异彩呢?今天,就让我带你...
现在安卓随便换系统,探索个性化... 你知道吗?现在安卓手机换系统简直就像换衣服一样简单!没错,就是那种随时随地、随心所欲的感觉。今天,就...
安卓系统安装按钮灰色,探究原因... 最近发现了一个让人头疼的小问题,那就是安卓手机的安装按钮突然变成了灰色,这可真是让人摸不着头脑。你知...