Spring Cloud Zuul 基本原理

news2024/10/5 17:25:06

Spring Cloud Zuul 底层是基于Servlet实现的,核心是通过一系列的ZuulFilter来完成请求的转发。

1、核心组件注册

1.1. EnableZuulProxy注解

启用Zuul作为微服务网关,需要在Application应用类加上@EnableZuulProxy注解,而该注解核心是利用@Import注解往Spring容器导入了ZuulProxyConfiguration配置类
image.png

1.2. ZuulProxyConfiguration

ZuulProxyConfiguration继承了ZuulConfiguration。

1.2.1. ZuulConfiguration:

ZuulConfuguration主要是利用@Import往Spring容器注入了ServerPropertiesAutoConfiguration配置类(下一小节介绍),并且作为配置类往Spring容器注入了CompositeRouteLocator、SimpleRouteLocator、ZuulController、ZuulHandlerMapping、ZuulServlet等组件,基于Spring DispatcherServlet实现请求转发入口。
image.png
还有ServletDetectionFilter、Servlet30WrapperFilter、SendResponseFilter、SendErrorFilter、SendForwardFilter等pre、post类型的过滤器,是Zuul实现路由转发的核心过滤器。
image.png
还有ZuulRefreshListener监听器,同于监听应用内部事件,设置路由信息状态为dirty,实现动态更新。
image.png

1.2.2. ZuulProxyConfiguration

当然了,ZuulProxyConfiguration本身也注入了实现路由转发的核心过滤器,包含route类型的过滤器:RibbonRoutingFilter、SimpleHostRoutingFilter。
image.png
还有路由定位器DiscoveryClientRouteLocator,先调用父类SimpleRouteLocator获取配置文件中的路由配置,然后再从注册中心中补充路由信息。
image.png
还有一个非常重要的Listener:ZuulDiscoveryRefreshListener,它实现了ApplicationListener接口,主要监听InstanceRegisteredEvent、ParentHearbeatEvent和HeartbeatEvent,根据注册中心发送的事件来更新最新的路由信息(设置路由信息状态为dirty)。
image.png

2、路由配置注册

上面已经提到,Zuul是基于Servlet实现的,而根据请求URL找到对应Handler是利用HandlerMapping完成的,而Zuul也根据此实现了ZuulHandlerMapping实现类。

2.1. ZuulHandlerMapping

DispatcherServlet#initHandlerMappings
image.png

2.2. ZuulHandlerMapping#lookupHandler

在DispatcherServlet在首次请求分发时,就会遍历所有HandlerMapping,然后根据请求去获取对应的Handler(HandlerExecutionChain,包含Handler和拦截器),当遍历到ZuulHandlerMapping时,会调用lookupHandler方法,如果是首次调用,会触发上面的registerHandlers方法,进行路由配置注册。
image.png

2.3. ZuulHandlerMapping#registerHandlers

ZuulHandlerMapping首次根据url查找Handler时,会先找到所有的路由配置,然后遍历注册Handler(ZuulController);这里查找所有路由配置就是上面提到的DiscoveryClientRouteLocator。
image.png

3、请求处理

DispatcherServlet分发请求的流程:

图片拿自网络

image.png

3.1. ZuulController

在2.3.中,ZuulHandlerMapping给路由配置注册Handler时,对应的Handler是ZuulController。ZuulController继承了ServletWrappingController,底层是实现Controller接口。

3.2. SimpleControllerHandlerAdapter

根据上面流程图,找到HandlerMapping后,会继续找到能执行对应Handler的HandlerAdapter;而上面也提到,ZuulController是实现于Controller接口,所以最后定位到的是SimpleControllerHandlerAdapter。
image.png
SimpleControllerAdapter执行请求逻辑非常简单,就是执行Handler的handleRequest方法,即执行ZuulController的handleRequest方法。
image.png

3.3. ZuulController#handleRequest

ZuulController的handleRequest很简单,调用的是父类的handleRequestInternal方法。
但是我们需要注意ZuulController的构造函数,里面给servletClass、servletName和supportedMethods赋值了,其中servletClass尤为关键,因为后续处理就是调用此类实例的方法。
image.png

3.4. ServletWrappingController

ServletWrappingController重写了InitializingBean#afterPropertiesSet方法,在设置实例属性后,根据servletClass实例化了servletInstance对象,这里就是ZuulServlet的实例。
ServletWrappingController的handleRequestInternal方法也很简单,就是调用servletInstance的service方法,这里就是ZuulServlet#service方法。
image.png

3.5. ZuulServlet#service

ZuulServlet的service方法逻辑很简单,都是利用ZuulRunner来完成的;在ServletWrappingController实例化servletInstance时,同时调用了servletInstance的init方法,此时ZuulServlet同时会创建一个ZuulRunner实例。
service方法逻辑:

  1. 执行ZuulRunner#init方法,创建请求上下文RequestContext,并将利用HttpServletRequestWrapper和HttpServletResponseWrapper分别将HttpServletRequest和HttpServletResponse包装起来。
  2. 调用ZuulRunner#preRoute方法执行前置过滤器
  3. 调用ZuulRunner#route方法执行路由过滤器
  4. 调用ZuulRunner#postRoute方法执行后置过滤器
  5. 如果步骤2到步骤4出现错误,则执行ZuulRunner的error方法
  6. 最后,清理RequestContext内容(ThreadLocal)

image.png

3.6. ZuulRunner

ZuulRunner实现也是非常简单,底层是利用FilterProcessor来实现的。
image.png

3.7. FilterProcessor

FilterProcessor执行过滤器的逻辑也非常简单,就是根据过滤器类型找到所有的过滤器,然后遍历调用processZuulFilter方法执行,里面只要是执行ZuulFilter的runFilter方法,并且对错误信息和成功信息做统计。
image.png

3.8. FilterLoader和FilterRegistry

FilterProcessor中是利用FilterLoader来完成过滤器的加载的,而FilterLoader最终是利用FilterRegistry来完成过滤器的加载。
image.pngimage.png
FilterLoader和FilterRegistry都是单例,在ZuulFilterConfiguration中创建,并注入到ZuulFilterInitializer中,最后并将ZuulFilterInitializer注入到Spring容器中。
image.png
ZuulFilterInitializer实现了ServletContextListener接口,在Spring容器完成初始化时,会将ZuulFilter集合注入到FilterRregistry中。
image.png

4. 核心过滤器

这里只要分析核心过滤器,不包含所有的过滤器。

4.1. 前置过滤器

4.1.1. ServletDetectionFilter

执行顺序为-3,主要是区分请求是通过Spring的DispatcherServlet处理运行的还是ZuulServlet来处理运行的。
image.png

4.1.2. Servlet30WrapperFilter

执行顺序为-2,主要是将HttpServletRequest包装成Servlet30RequestWrapper。
image.png

4.1.3. FormBodyWrapperFilter

执行顺序为-1,条件要么是Context-Type为application/x-www-form-urlencoded的请求,要么是Context-Type为multipart/form-data,且是由String的DispatcherServlet处理的请求,主要是将HttpServletRequest包装成FormBodyRequestWrapper。
image.png

4.1.4. DebugFilter

执行顺序为1,条件要么配置里指定zuul.debug.request为true,要么请求参数debug为true。主要用来将当前请求上下文中的debugRouting和debugRequest参数设置为true;主要是做到灵活开关debug模式,开启debug模式时,会打印一些日志方便分析问题。
image.png

4.1.5. PreDecorationFilter

执行顺序为5,条件要求请求上下文中不存在forward.do和serviceId参数,主要是做一个预处理,将相关信息存到上下文中,包含路由、后置、错误过滤器的过滤条件判断信息。
image.png

4.2. 路由过滤器

4.2.1. RibbonRoutingFilter

执行顺序为10,条件是请求上下文中routeHost为null并且serviceId不为null,主要是构建Ribbon命令上下文,并且发起请求转发。
image.png
在发起请求转发的时候,需要构建HTTP客户端,这里会根据配置和依赖来选用指定的HTTP客户端。
image.png

4.2.2. SimpleHostRoutingFilter

执行顺序为100,条件是请求上下文中routeHost不为null,主要是直接根据物理地址发送请求,这里是直接调用原生的HttpClient包的客户端。
image.png

image.png

4.2.3. SendForwardFilter

执行顺序为500,条件是请求上下文中forward.do不为null并且sendForwardFilter.ran为false,主要是做本地转发。
image.png

4.3. 后置过滤器

4.3.1. SendResponseFilter

执行顺序为1000,条件是请求上下文中异常为null,并且响应头或响应体不为null,主要是将响应写回给客户端。
image.png

4.4. 错误过滤器

4.4.1 SendErrorFilter

执行顺序为0,条件是请求上下文中异常不为null,并且sendErrorFilter.ran为false,主要是将异常写回给客户端。
image.png

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

国庆假期day5

作业:请写出七层模型及每一层的功能,请绘制三次握手四次挥手的流程图 1.OSI七层模型: 应用层--------提供函 表示层--------表密缩 会话层--------会话 传输层--------进程的接收和发送 网络层--------寻主机 数据链路层----相邻节点的可靠传…

Qt+openCV学习笔记(十六)Qt6.6.0rc+openCV4.8.1+emsdk3.1.37编译静态库

前言: 有段时间没来写文章了,趁编译库的空闲,再写一篇记录文档 WebAssembly的发展逐渐成熟,即便不了解相关技术,web前端也在不经意中使用了相关技术的库,本篇文档记录下如何编译WebAssembly版本的openCV&…

TouchGFX之文本和字体

TouchGFX可将动态值作为文本的一部分来使用。 这可以通过在文本中使用通配符来实现。 按给定格式<*>指定通配符&#xff0c;其中的*表示不会包含在结果文本中的可选辅助文本。 一个文本中可以有至多2个通配符。 在TouchGFX 设计器中&#xff0c;只需单击“”按钮为所选文…

Leetcode1071. 字符串的最大公因子(三种方法,带详细解析)

Leetcode1071. 字符串的最大公因子 对于字符串 s 和 t&#xff0c;只有在 s t … t&#xff08;t 自身连接 1 次或多次&#xff09;时&#xff0c;我们才认定 “t 能除尽 s”。 给定两个字符串 str1 和 str2 。返回 最长字符串 x&#xff0c;要求满足 x 能除尽 str1 且 x 能…

g(x)=abx形式的函数最小二乘法计算方法

设函数&#xff0c;利用最小二乘法求解系数a和b: 设&#xff0c;&#xff0c;有 用最小二乘法求解和后&#xff0c;可得和&#xff1a; &#xff0c;

[Spring] Spring5——AOP 简介

目录 一、AOP 简介 1、什么是 AOP 二、AOP 底层原理 1、动态代理原理 2、基于接口的 JDK 动态代理 3、基于继承的 CGLib 动态代理 三、底层原理实现—— JDK 动态代理 1、使用 Proxy 类的方法创建代理对象 2、JDK 动态代理示例 四、AOP 操作术语 1、连接点 2、切入…

【算法学习】-【双指针】-【快乐数】

LeetCode原题链接&#xff1a;202. 快乐数 下面是题目描述&#xff1a; 「快乐数」 定义为&#xff1a; 对于一个正整数&#xff0c;每一次将该数替换为它每个位置上的数字的平方和。 然后重复这个过程直到这个数变为 1&#xff0c;也可能是 无限循环 但始终变不到 1。 如果…

408计网应用层总结

网络应用模型 ■客户/服务器模型&#xff08;C/S&#xff09;&#xff1a;客户是服务请求方&#xff0c;服务器是服务提供方 ■P2P模型&#xff1a;各主机都是客户&#xff0c;也都是服务器&#xff08;任意一对计算机成称为对等方&#xff09; 注&#xff1a; 1.客户…

linux入门---信号的保存和捕捉

目录标题 信号的一些概念信号的保存pending表block表handler表 信号的捕捉内核态和用户态信号的捕捉 信号的一些概念 1.进程会收到各种各样的信号&#xff0c;那么程序对该信号进行实际处理的动作叫做信号的递达。 2.我们之前说过当进程收到信号的时候可能并不会立即处理这个信…

DevEco Studio设置Nodejs提示路径只能包含英文、数字、下划线等

安装DevEco Studio 3.1.1 Release 设置Nodejs路径使用nodejs默认安装路径 &#xff08;C:\Program Files\nodejs&#xff09; 提示只能包含英文、数字、下划线等 , 不想在安装nodejs请往下看 nodejs默认路径报错 修改配置文件 1、退出DevEco Studio 2、打开配置文件 cmd控制台…

Linux高性能服务器编程 学习笔记 第十章 信号

信号是由用户、系统、进程发送给目标进程的信息&#xff0c;以通知目标进程某个状态的改变或系统异常。Linux信号可由以下条件产生&#xff1a; 1.对于前台进程&#xff0c;用户可通过输入特殊终端字符来给它发送信号&#xff0c;如输入CtrlC通常会给进程发送一个中断信号。 2…

最短路径专题5 最短路径

题目&#xff1a; 样例&#xff1a; 输入 4 5 0 2 0 1 2 0 2 5 0 3 1 1 2 2 3 2 2 输出 3 0->3->2 思路&#xff1a; 根据题目意思&#xff0c;求最短路&#xff0c;这个根据平时的Dijkstra&#xff08;堆优化&#xff09;即可&#xff0c;关键在于求路径的方法&#x…

阿里云新账户什么意思?老用户、产品首购详细说明

阿里云新账户、老账号、产品首购和同人账号什么意思&#xff1f;阿里云账号分为云新账户、老账户、产品首购、同人账号和同一用户&#xff0c;阿里云官方推出的活动很多是限制账号类型的&#xff0c;常见的如阿里云新用户&#xff0c;什么是阿里云新用户&#xff1f;是指从未在…

mysql面试题11:讲一讲MySQL主从复制模式

该文章专注于面试,面试只要回答关键点即可,不需要对框架有非常深入的回答,如果你想应付面试,是足够了,抓住关键点 面试官:讲一讲MySQL主从复制模式? MySQL主从复制的配置步骤如下: 在主服务器上配置: 打开主服务器的配置文件my.cnf,启用二进制日志(binary log)功…

【Linux】[gdb]Linux环境下如何调试代码

一、code.c文件 我们首先创建一个code.c文件&#xff0c;写一段简单代码&#xff0c;用于测试。 二、makefile文件 然后&#xff0c;我们可以编写makefile文件&#xff0c;使得code.c文件能够进行编译。&#xff08;当然也可以不写makefile文件&#xff0c;直接对code.c进行编…

mysql面试题14:讲一讲MySQL中什么是全同步复制?底层实现?

该文章专注于面试,面试只要回答关键点即可,不需要对框架有非常深入的回答,如果你想应付面试,是足够了,抓住关键点 面试官:讲一讲mysql中什么是全同步复制?底层实现? MySQL中的全同步复制(Synchronous Replication)是一种复制模式,主服务器在写操作完成后,必须等待…

PG 多表连接查询

写法&#xff1a; 使用 select 表名.键名 from 表1 join表2 on 相同的主键 构造出来一张新表 多表要用表名.键名 才能知道是哪一张表 传统写法也行 类型&#xff1a; 内 而外的要这样写

[BJDCTF2020]Mark loves cat

先用dirsearch扫一下&#xff0c;访问一下没有什么 需要设置线程 dirsearch -u http://8996e81f-a75c-4180-b0ad-226d97ba61b2.node4.buuoj.cn:81/ --timeout2 -t 1 -x 400,403,404,500,503,429使用githack python2 GitHack.py http://8996e81f-a75c-4180-b0ad-226d97ba61b2.…

虚拟机VMware的使用流程以及出现的问题附解决方法

虚拟机VMware的使用流程以及出现的问题附解决方法 下载安装 略。。。 创建虚拟机 虚拟机的设置如下&#xff1a;注意网络适配器为NAT 如果出现ip addr 命令&#xff1a;不显示IP地址的话&#xff1a; 解决方式如下&#xff1a; 首先设置网卡&#xff1a;先查看一下onboot是…

python二次开发CATIA:测量点的坐标

首先新建一个Part文件&#xff0c;插入一个几何图形集&#xff0c;在该几何图形集中插入一个点&#xff0c;坐标为&#xff08;100&#xff0c;0&#xff0c;0&#xff09;​&#xff0c;如下图所示&#xff1a; 下面通过python来测量该点的坐标​&#xff1a; import win32co…