Spring Cloud Zuul 基本原理

这篇具有很好参考价值的文章主要介绍了Spring Cloud Zuul 基本原理。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

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

1、核心组件注册

1.1. EnableZuulProxy注解

启用Zuul作为微服务网关,需要在Application应用类加上@EnableZuulProxy注解,而该注解核心是利用@Import注解往Spring容器导入了ZuulProxyConfiguration配置类
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

1.2. ZuulProxyConfiguration

ZuulProxyConfiguration继承了ZuulConfiguration。

1.2.1. ZuulConfiguration:

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

1.2.2. ZuulProxyConfiguration

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

2、路由配置注册

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

2.1. ZuulHandlerMapping

DispatcherServlet#initHandlerMappings
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

2.2. ZuulHandlerMapping#lookupHandler

在DispatcherServlet在首次请求分发时,就会遍历所有HandlerMapping,然后根据请求去获取对应的Handler(HandlerExecutionChain,包含Handler和拦截器),当遍历到ZuulHandlerMapping时,会调用lookupHandler方法,如果是首次调用,会触发上面的registerHandlers方法,进行路由配置注册。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

2.3. ZuulHandlerMapping#registerHandlers

ZuulHandlerMapping首次根据url查找Handler时,会先找到所有的路由配置,然后遍历注册Handler(ZuulController);这里查找所有路由配置就是上面提到的DiscoveryClientRouteLocator。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

3、请求处理

DispatcherServlet分发请求的流程:

图片拿自网络

Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

3.1. ZuulController

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

3.2. SimpleControllerHandlerAdapter

根据上面流程图,找到HandlerMapping后,会继续找到能执行对应Handler的HandlerAdapter;而上面也提到,ZuulController是实现于Controller接口,所以最后定位到的是SimpleControllerHandlerAdapter。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud
SimpleControllerAdapter执行请求逻辑非常简单,就是执行Handler的handleRequest方法,即执行ZuulController的handleRequest方法。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

3.3. ZuulController#handleRequest

ZuulController的handleRequest很简单,调用的是父类的handleRequestInternal方法。
但是我们需要注意ZuulController的构造函数,里面给servletClass、servletName和supportedMethods赋值了,其中servletClass尤为关键,因为后续处理就是调用此类实例的方法。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

3.4. ServletWrappingController

ServletWrappingController重写了InitializingBean#afterPropertiesSet方法,在设置实例属性后,根据servletClass实例化了servletInstance对象,这里就是ZuulServlet的实例。
ServletWrappingController的handleRequestInternal方法也很简单,就是调用servletInstance的service方法,这里就是ZuulServlet#service方法。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

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)

Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

3.6. ZuulRunner

ZuulRunner实现也是非常简单,底层是利用FilterProcessor来实现的。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

3.7. FilterProcessor

FilterProcessor执行过滤器的逻辑也非常简单,就是根据过滤器类型找到所有的过滤器,然后遍历调用processZuulFilter方法执行,里面只要是执行ZuulFilter的runFilter方法,并且对错误信息和成功信息做统计。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

3.8. FilterLoader和FilterRegistry

FilterProcessor中是利用FilterLoader来完成过滤器的加载的,而FilterLoader最终是利用FilterRegistry来完成过滤器的加载。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloudSpring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud
FilterLoader和FilterRegistry都是单例,在ZuulFilterConfiguration中创建,并注入到ZuulFilterInitializer中,最后并将ZuulFilterInitializer注入到Spring容器中。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud
ZuulFilterInitializer实现了ServletContextListener接口,在Spring容器完成初始化时,会将ZuulFilter集合注入到FilterRregistry中。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

4. 核心过滤器

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

4.1. 前置过滤器

4.1.1. ServletDetectionFilter

执行顺序为-3,主要是区分请求是通过Spring的DispatcherServlet处理运行的还是ZuulServlet来处理运行的。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

4.1.2. Servlet30WrapperFilter

执行顺序为-2,主要是将HttpServletRequest包装成Servlet30RequestWrapper。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

4.1.3. FormBodyWrapperFilter

执行顺序为-1,条件要么是Context-Type为application/x-www-form-urlencoded的请求,要么是Context-Type为multipart/form-data,且是由String的DispatcherServlet处理的请求,主要是将HttpServletRequest包装成FormBodyRequestWrapper。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

4.1.4. DebugFilter

执行顺序为1,条件要么配置里指定zuul.debug.request为true,要么请求参数debug为true。主要用来将当前请求上下文中的debugRouting和debugRequest参数设置为true;主要是做到灵活开关debug模式,开启debug模式时,会打印一些日志方便分析问题。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

4.1.5. PreDecorationFilter

执行顺序为5,条件要求请求上下文中不存在forward.do和serviceId参数,主要是做一个预处理,将相关信息存到上下文中,包含路由、后置、错误过滤器的过滤条件判断信息。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

4.2. 路由过滤器

4.2.1. RibbonRoutingFilter

执行顺序为10,条件是请求上下文中routeHost为null并且serviceId不为null,主要是构建Ribbon命令上下文,并且发起请求转发。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud
在发起请求转发的时候,需要构建HTTP客户端,这里会根据配置和依赖来选用指定的HTTP客户端。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

4.2.2. SimpleHostRoutingFilter

执行顺序为100,条件是请求上下文中routeHost不为null,主要是直接根据物理地址发送请求,这里是直接调用原生的HttpClient包的客户端。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

4.2.3. SendForwardFilter

执行顺序为500,条件是请求上下文中forward.do不为null并且sendForwardFilter.ran为false,主要是做本地转发。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

4.3. 后置过滤器

4.3.1. SendResponseFilter

执行顺序为1000,条件是请求上下文中异常为null,并且响应头或响应体不为null,主要是将响应写回给客户端。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud

4.4. 错误过滤器

4.4.1 SendErrorFilter

执行顺序为0,条件是请求上下文中异常不为null,并且sendErrorFilter.ran为false,主要是将异常写回给客户端。
Spring Cloud Zuul 基本原理,微服务架构,Zuul 网关,spring cloud文章来源地址https://www.toymoban.com/news/detail-728959.html

到了这里,关于Spring Cloud Zuul 基本原理的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 微服务·架构组件之网关- Spring Cloud Gateway

    微服务架构已成为构建现代化应用程序的关键范式之一,它将应用程序拆分成多个小型、可独立部署的服务。Spring Cloud Gateway是Spring Cloud生态系统中的一个关键组件,用于构建和管理微服务架构中的网关。本报告旨在调查和介绍Spring Cloud Gateway的核心概念、架构、功能以及其在

    2024年02月09日
    浏览(54)
  • spring cloud搭建(zuul)

    天行健,君子以自强不息;地势坤,君子以厚德载物。 每个人都有惰性,但不断学习是好好生活的根本,共勉! 文章均为学习整理笔记,分享记录为主,如有错误请指正,共同学习进步。 spring cloud 相关组件搭建(建议顺序): eureka(注册中心服务)spring cloud搭建(eureka)

    2024年02月08日
    浏览(38)
  • spring cloud zuul实践

    一、 描述 Spring Cloud Zuul是基于Netflix开源的Zuul项目构建而成,它作为微服务架构中的网关服务,主要用于实现动态路由、负载均衡和请求过滤等功能。 动态路由:Zuul根据预设的路由规则将进来的请求路由到相应的服务实例上。路由规则可以通过配置文件或代码进行定义,接

    2024年02月15日
    浏览(34)
  • Spring cloud教程Gateway服务网关

    写在前面的话: 本笔记在参考网上视频以及博客的基础上,只做个人学习笔记,如有侵权,请联系删除,谢谢! Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,它旨在为微服务架构提

    2024年02月08日
    浏览(42)
  • Spring Cloud第二季--服务网关Gateway

    Spring Cloud Gateway是在Spring生态系统之上构建的API网关服务,基于Spring 5,Spring Boot 2和 Project Reactor等技术。 Gateway 使用的Webflux中的reactor-netty响应式编程组件,底层使用了 Netty 通讯框架。Spring Cloud Gateway能干嘛呢? Gateway是原zuul1.x版的替代。 Spring Cloud Gateway 与 Zuul的区别: Zuu

    2024年02月03日
    浏览(48)
  • springboot整合spring cloud gateway搭建网关服务

    spring cloud netflix zuul、spring cloud gateway是最常见的微服务网关,通过网关,我们可以在请求到达后端指定服务之前/后端服务处理完业务响应数据之后对响应进行对请求/响应进行处理。 比如常见的参数校验、接口鉴权等等,在后端服务的拦截器和过滤器能做的事在网关都可以做

    2024年02月07日
    浏览(50)
  • Spring Cloud实战案例 │ Apollo和Zuul的整合开发

    Apollo是携程研发的开源配置管理中心,能够集中管理应用于不同环境、不同集群的配置,配置修改后能够实时推送到应用端,并且具备规范的权限、流程治理等特性。 本案例结合一个案例介绍Apollo和Zuul的整合开发。整个应用分为4个微服务项目,分别是Eureka服务器项目mweath

    2024年02月14日
    浏览(32)
  • 【springcloud 微服务】Spring Cloud 微服务网关Gateway使用详解

    目录 一、微服务网关简介 1.1 网关的作用 1.2 常用网关 1.2.1 传统网关 1.2.2 云原生网关

    2023年04月16日
    浏览(50)
  • Eureka上集成Spring Cloud 微服务网关 gateway

    第一章 Java线程池技术应用 第二章 CountDownLatch和Semaphone的应用 第三章 Spring Cloud 简介 第四章 Spring Cloud Netflix 之 Eureka 第五章 Spring Cloud Netflix 之 Ribbon 第六章 Spring Cloud 之 OpenFeign 第七章 Spring Cloud 之 GateWay API 网关是一个搭建在客户端和微服务之间的服务,我们可以在 API 网关中

    2024年02月08日
    浏览(45)
  • Spring Cloud Gateway - 新一代微服务API网关

    如果没有网关,难道不行吗?功能上是可以的,我们直接调用提供的接口就可以了。那为什么还需要网关? 因为网关的作用不仅仅是转发请求而已。我们可以试想一下,如果需要做一个请求认证功能,我们可以接入到 API 服务中。但是倘若后续又有服务需要接入,我们又需要

    2024年02月16日
    浏览(45)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包