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

相关内容

热门资讯

系统如何与安卓互通,技术融合与... 你有没有想过,你的手机系统竟然能和安卓系统这么默契地互通有无?这就像是一场跨越科技界的友谊赛,让我们...
安卓系统 扫码枪,安卓系统下扫... 你有没有想过,在繁忙的超市收银台,那些快速流畅的扫码操作,背后其实隐藏着一个小小的英雄——安卓系统扫...
平板插卡推荐安卓系统,安卓系统... 你有没有想过,你的平板电脑是不是也能像智能手机一样,随时随地扩充存储空间呢?没错,这就是今天我要跟你...
安卓系统固件安装失败,原因排查... 最近是不是你也遇到了安卓系统固件安装失败的问题?别急,让我来给你详细说说这个让人头疼的小麻烦,让你一...
ios系统和安卓区别,系统差异... 你有没有发现,现在手机市场上,iOS系统和安卓系统就像是一对双胞胎,长得差不多,但性格却截然不同。今...
安卓系统2.3优酷,优酷的崛起... 你有没有发现,安卓系统2.3时代的那股怀旧风?那时候,优酷可是视频界的巨头,多少人都是看着优酷长大的...
安卓导航系统密封,安卓导航系统... 你有没有发现,现在手机导航系统越来越智能了?尤其是安卓系统的导航,简直就像一个贴心的导航小助手,带你...
a版安卓11系统,a版深度解析... 你知道吗?最近手机界可是炸开了锅,各大品牌纷纷发布了搭载a版安卓11系统的手机。这可不是什么小打小闹...
安卓系统的模拟吉他,随时随地弹... 你有没有想过,在手机上也能弹奏吉他呢?没错,就是那种模拟吉他的安卓系统应用,让你随时随地都能享受音乐...
王者适配的安卓系统,深度解析适... 你有没有发现,最近玩《王者荣耀》的小伙伴们都在议论纷纷,说新出的安卓系统简直是为王者量身定做的!没错...
安卓系统自动定位关闭,隐私保护... 你有没有发现,手机里的安卓系统有时候会自动定位,这可真是让人又爱又恨啊!有时候,我们并不想让别人知道...
安卓系统电量耗尽测试,全面解析... 手机电量耗尽,这可是每个手机用户都头疼的问题。你有没有想过,你的安卓手机在电量耗尽前,到底经历了哪些...
如何升级车载安卓系统,车载安卓... 亲爱的车主朋友们,你是不是也和我一样,对车载安卓系统升级这件事充满了好奇和期待呢?想象当你驾驶着爱车...
安卓办公哪个系统好,深度解析哪... 你有没有想过,在安卓办公的世界里,哪个系统才是你的最佳拍档呢?在这个信息爆炸的时代,选择一个既强大又...
安卓系统差劲怎么解决,重拾流畅... 你有没有发现,安卓系统有时候真的让人头疼得要命?手机卡顿、应用崩溃、电池续航短,这些问题是不是让你抓...
喜欢安卓系统的原因,探索用户偏... 你有没有发现,身边的朋友、同事,甚至家人,越来越多的人开始使用安卓手机了呢?这可不是简单的潮流,而是...
安卓系统金立手机,品质生活新选... 你有没有发现,最近安卓系统下的金立手机突然火了起来?没错,就是那个曾经陪伴我们走过无数时光的金立手机...
无安卓系统的电视,新型无系统电... 亲爱的读者们,你是否厌倦了那些充斥着安卓系统的电视?想要尝试一些新鲜玩意儿?那就跟我一起探索一下无安...
麒麟系统能刷安卓系统吗,轻松刷... 你有没有想过,你的麒麟手机能不能装上安卓系统呢?这可是个让人好奇不已的问题。现在,就让我来带你一探究...
手机公司安卓系统吗,手机公司引... 你有没有想过,为什么你的手机里装的是安卓系统而不是苹果的iOS呢?这背后可是有着不少故事和门道的哦!...