WEB三大组件之Filter

在很多项目中通常需要用到filter来实现用户身份识别,并将识别出来的用户信息,保存到ThreadLocal对应的上下文,这样在后续的请求链路中,在任何地方都可以直接获取当前的登录用户了。

来看一下Java WEB三大组件之一的过滤器Filter,是如何在技术派中发挥作用的

使用场景

实现类路径:com/github/paicoding/forum/web/hook/filter/ReqRecordFilter.java

1.Filter基础知识点

来了解一下Filter的基础把。

Filter称为过滤器,主要用来拦截http请求,来做一些其他的事情

流程说明

一个http请求过来之后

  •         首先进入filter,执行相关的业务逻辑
  •         若判定通行,则进入Servlet逻辑,Servlet执行完毕后,又返回Filter,最后在返回给请求方
  •         判定失败,直接返回,不需要将请求发给Servlet

应用场景

通过上面的流程,可以推算下具体的使用场景:

  •         在filter层,来获取用户的身份
  •         可以考虑在filter层做一些常规的校验(如参数校验。referer校验、权限控制等)
  •         可以在filter层做运维、安全防护相关的工作(如全链路打点,可以在filter层分配一个traceId;也可以在这一层做限流等)

2. 实现说明:

filter的基本使用比较简单,实现Filter接口即可,如;

@Slf4j
@WebFilter(urlPatterns = "/*", filterName = "reqRecordFilter", asyncSupported = true)
public class ReqRecordFilter implements Filter {private static Logger REQ_LOG = LoggerFactory.getLogger("req");/*** 返回给前端的traceId,用于日志追踪*/private static final String GLOBAL_TRACE_ID_HEADER = "g-trace-id";@Autowiredprivate GlobalInitService globalInitService;@Autowiredprivate StatisticsSettingService statisticsSettingService;@Overridepublic void init(FilterConfig filterConfig) {}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {long start = System.currentTimeMillis();HttpServletRequest request = null;StopWatch stopWatch = new StopWatch("请求耗时");try {stopWatch.start("请求参数构建");request = this.initReqInfo((HttpServletRequest) servletRequest, (HttpServletResponse) servletResponse);stopWatch.stop();stopWatch.start("cors");CrossUtil.buildCors(request, (HttpServletResponse) servletResponse);stopWatch.stop();stopWatch.start("业务执行");filterChain.doFilter(request, servletResponse);stopWatch.stop();} finally {stopWatch.start("输出请求日志");buildRequestLog(ReqInfoContext.getReqInfo(), request, System.currentTimeMillis() - start);// 一个链路请求完毕,清空MDC相关的变量(如GlobalTraceId,用户信息)MdcUtil.clear();ReqInfoContext.clear();stopWatch.stop();if (!isStaticURI(request) && !EnvUtil.isPro()) {log.info("{} - cost:\n{}", request.getRequestURI(), stopWatch.prettyPrint(TimeUnit.MILLISECONDS));}}}@Overridepublic void destroy() {}

上面有三个方法:

  •         init: 初始化执行
  •         destory: 销毁时执行
  •         dofilter: 重点关注这个,filter规则命中请求,都会走进来

                三个参数,注意第三个FilterChain,这里是经典的责任链模式

                执行filterChain.doFilter(request, servletResponse); 表示会继续将请求执行下去;若不执行这一句,表示这一次的http请求到此为止,后面免得不走下去了。

3.filter注册

过滤注册到Spring容器有多种使用姿势,除上面使用的@WebFilter之外还有其他的使用姿势。

3.1 WebFilter注解

使用WebFilter注解,标注到实现自己额的过滤器上,有几个参数需要注意,其中urlPatterns最为常用,表示这个filter使用与那些url请求(默认场景下全部都被拦截)

属性名 

类型

描述

filterNameString指定过滤器的name属性,等价于<filter-name>

value

String[]该属性等价于urlPatterns属性。但是两者不应该同时使用。
urlPatternsString[]指定一组过滤器的URL匹配模式。等价于<url-pattern>标签
servletNamesString[]

指定过滤器将应用于哪些Servlet。取值是@WebServlet中的name属性的取值,或者是web.xml中<servlet-name>的取值

dispatcherTypesDispatcherTypes指定过滤器的转发模式。具体取值包括: ASYNC、ERROR、FORWARD、INCLUDE、REQUEST
initParamsWebInitParm[]指定一组过滤器初始化参数。等价于<init-param>标签
asyncSupportedboolean声明过滤器是否支持异步操作模式,等价于<async-supported>标签
descriptionString该过滤器的描述信息,等价于<description>
displayNameString该过滤器的显示名,通常配合工具使用,等价于<display-name>

使用这个注解时,请注意,需要在启动类/配置类添加@ServletComponentScan注解来启用

如:

3.2 FilterRegistrationBean

上面这一种比较简单,但是再指定Filter的优先级的时候比较麻烦,不如下面这种方式简单

4.实例说明

接下来我们看一下,filter在技术派中的具体表现,干了那几件事:

身份识别 ,并保存身份到ReqInfoContext上下文中:

记录请求记录:

Filter实现请求日志记录-CSDN博客等。

请求日志的case:

小结

1. Filter使用

自定义Filter的实现

        实现Filter接口

        doFilter方法中,显示调用chain.doFilter(request , response); 表示请求继续;否则表示请求被过滤。

注册生效

@ServletComponentScan自动扫描带有@WebFilter注解的Filter

创建Bean: FilterRegistrationBean来包装自定义的Filter

2. IoC/DI

在SpringBoot中Filter可以和一般的Bean一样使用,直接通过Autowired注入其依赖的Spring Bean对象。

3.优先级

通过创建FilterRegistrationBean的时候指定优先级,如下

此外注意,@WebFilter申明的Filter,优先级为2147483647(优先级最低)

@Order注解不能指定Filter优先级

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/548744.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

云原生(三)、Docker网络

Docker网络 在 Docker 中&#xff0c;不同容器之间的网络访问原理取决于容器所使用的网络模式。下面是 Docker 中常见的两种网络模式下容器间网络访问的原理&#xff1a; 桥接模式&#xff08;Bridge&#xff09;&#xff1a; 在桥接模式下&#xff0c;Docker 使用 Linux 桥接…

【德语常识】分类单词

【德语常识】分类单词 一&#xff0c;Colors二&#xff0c;Countries & Languages三&#xff0c; 一&#xff0c;Colors 二&#xff0c;Countries & Languages 三&#xff0c;

二叉树算法

递归序 每个节点都能回到3次! 相当于2执行完然后返回了代码会往下走,来到3节点 小总结: 也就是4节点先来到自己一次,不会执行if,先调用自己左边的那个函数,但是是null,直接返回。 这个函数执行完了,就会回到自己,调用自己右边的那个函数,结果又是空,又返回,回到…

HarmonyOS NEXT应用开发之Web获取相机拍照图片案例

介绍 本示例介绍如何在HTML页面中拉起原生相机进行拍照&#xff0c;并获取返回的图片。 效果预览图 使用说明 点击HTML页面中的选择文件按钮&#xff0c;拉起原生相机进行拍照。完成拍照后&#xff0c;将图片在HTML的img标签中显示。 实现思路 添加Web组件&#xff0c;设置…

微信小程序 nodejs+vue+uninapp学生在线选课作业管理系统

基于微信小程序的班级作业管理助手使用的是MySQL数据库&#xff0c;nodejs语言和IDEA以及微信开发者工具作为开发工具&#xff0c;这些技术和工具我在日常的作业中都经常的使用&#xff0c;并且因为对编程感兴趣&#xff0c;在闲暇时间也进行的进行编程的提高&#xff0c;所以在…

智能硬件 | XR头显市场只有少数玩家,AI是扭转局面的关键?

苹果头显设备Vision Pro突出2项技术&#xff0c;即“空间计算”和手部、眼部跟踪。“空间计算”使设备能够学习并与物理环境进行交互&#xff1b;手部和眼部跟踪功能通过从设备侧面、前置和底部安装的摄像头收集手部和眼球的感应数据&#xff0c;使用户能够操作虚拟环境并与之交…

VMware workstation pro 16 虚拟机的安装

VMware workstation pro 16 虚拟机的安装 VMware 16下载VMware 16安装VMware 16许可 VMware 16下载 下载地址&#xff1a; VMware workstation pro 16 官网下载地址 VMware 16安装 安装向导&#xff0c;点击下一步勾选我同意许可协议中的条款&#xff0c;点击下一步 更改安…

20.回文链表

给你一个单链表的头节点 head &#xff0c;请你判断该链表是否为 回文链表 。如果是&#xff0c;返回 true &#xff1b;否则&#xff0c;返回 false 。 示例 1&#xff1a; 输入&#xff1a;head [1,2,2,1] 输出&#xff1a;true示例 2&#xff1a; 输入&#xff1a;head …

前端三件套 | 综合练习:模拟抽奖活动,实现一个简单的随机抽取并显示三名获胜者

随机运行结果如下&#xff1a; 参考代码如下&#xff1a; <!DOCTYPE html> <html lang"en"><head><meta charset"UTF-8"><meta name"viewport" content"widthdevice-width, initial-scale1.0"><tit…

Flink源码解析(1)TM启动

网络传输模型 首先在看之前,回顾一下akka模型: Flink通讯模型—Akka与Actor模型-CSDN博客 注:ActorRef就是actor的引用,封装好了actor 下面是jm和tm在通讯上的概念图: RpcGateway 不理解网关的作用,可以先移步看这里:网关_百度百科 (baidu.com) 用于定义RPC协议,是…

深入探索C与C++的混合编程

实现混合编程的技术细节 混合使用C和C可能由多种原因驱动。一方面&#xff0c;现有的大量优秀C语言库为特定任务提供了高效的解决方案&#xff0c;将这些库直接应用于C项目中可以节省大量的开发时间和成本。另一方面&#xff0c;C的高级特性如类、模板和异常处理等&#xff0c;…

函数-Python

师从黑马程序员 函数初体验 str1"asdf" str2"qewrew" str3"rtyuio" def my_len(data):count0for i in data:count1print(f"字符串{data}的长度是{count}")my_len(str1) my_len(str2) my_len(str3) 函数的定义 函数的调用 函数名&a…