网关简介
背景分析
我们知道,一个大型系统在设计时,经常会被拆分为很多个微服务。那么作为客户端要如何去调用这么多的微服务呢?客户端可以直接向微服务发送请求,每个微服务都有一个公开的URL,该URL可以直接映射到具体的微服务,如果没有网关的存在,我们只能在客户端记录每个微服务的地址,然后分别去调用。这样的架构,会存在着诸多的问题,例如,客户端请求不同的微服务可能会增加客户端代码或配置的复杂性。还有就是每个服务,在调用时都需要独立认证。并且存在跨域请求,也在一定程度上提高了代码的复杂度。基于微服务架构中的设计及实现上的问题,为了在项目中简化前端的调用逻辑,同时也简化内部服务之间互相调用的复杂度,更好保护内部服务,提出了网关的概念。
网关概述
网关本质上要提供一个各种服务访问的入口,并提供服务接收并转发所有内外部的客户端调用,还有就是权限认证,限流控制等等。SpringCloudGateway是Spring公司基于Spring5.0,SpringBoot2.0和等技术开发的一个网关组件,它旨在为微服务架构提供一种简单有效的统一的API入口,负责服务请求路由、组合及协议转换,并且基于Filter链的方式提供了权限认证,监控、限流等功能。
SpringCloudGateway优缺点分析:
优点:
性能强劲:是第一代网关Zuul的1.6倍。
功能强大:内置了很多实用的功能,例如转发、监控、限流等
设计优雅,容易扩展。
缺点:
依赖Netty与WebFlux(Spring5.0),不是传统的Servlet编程模型(SpringMVC就是基于此模型实现),学习成本高。
需要SpringBoot2.0及以上的版本,才支持
快速入门
业务描述
通过网关作为服务访问入口,对系统中的服务进行访问,例如通过网关服务去访问sca-provider服务.
入门业务实现
第一步:创建sca-gateway模块(假如已有则无须创建),其pom.xml文件如下:
第二步:创建application.yml(假如已有则无须创建),添加相关配置,代码如下:
其中:路由(Route)是gateway中最基本的组件之一,表示一个具体的路由信息载体。主要定义了下面的几个信息:
1.id,路由标识符,区别于其他Route。
2.uri,路由指向的目的地uri,即客户端请求最终被转发到的微服务。
3.predicate,断言(谓词)的作用是进行条件判断,只有断言都返回真,才会执行路由。
4.filter,过滤器用于修改请求和响应信息。
第三步:创建项目启动类,例如:
第四步:启动项目进行访问测试,
依次启动sca-provider,sca-gateway服务,然后打开浏览器,进行访问测试,例如:
小节面试分析?
- 什么是网关?服务访问(流量)的一个入口,类似生活中的“海关“
- 为什么使用网关?(服务安全,统一服务入口管理,负载均衡,限流,鉴权)
- SpringCloudGateway应用的初始构建过程(添加依赖,配置)
- Gateway服务的启动底层是通过谁去实现的?(Netty网络编程框架-ServerSocket)
- Gateway服务做请求转发时一定要在注册中心进行注册吗?(不一定,可以直接通过远端url进行服务访问)
负载均衡设计
为什么负载均衡?
网关才是服务访问的入口,所有服务都会在网关层面进行底层映射,所以在访问服务时,要基于服务serivceid(服务名)去查找对应的服务,让请求从网关层进行均衡转发,以平衡服务实例的处理能力。
Gateway中负载均衡实现?
第一步:项目中添加服务发现依赖,代码如下:
第二步:修改其配置文件,代码如下
其中,lb指的是从nacos中按照名称获取微服务,并遵循负载均衡策略。同时建议开发阶段打开gateway日志,代码如下:
第三步:启动服务,进行访问测试,并反复刷新分析,如图所示:
执行流程分析(重要)
根据官方的说明,其Gateway具体工作流程,如图所示:
客户端向SpringCloudGateway发出请求。如果GatewayHandlerMapping通过谓词predicates(predicates)的集合确定请求与路由(Routers)匹配,则将其发送到GatewayWebHandler。GatewayWebHandler基于路由配置调用过滤链中的过滤器(也就是所谓的责任链模式)进一步的处理请求。Filter由虚线分隔的原因是,Filter可以在发送请求之前和之后执行拓展逻辑。基于官方的处理流程,进行源码分析如下:
小节面试分析?
- 网关层面是如何实现负载均衡的?(通过服务名去查找具体的服务实例)
- 网关层面是如何通过服务名查找服务实例的?(Ribbon)
- 你了解Ribbon中的哪些负载均衡算法?(轮询,权重,hash,……可通过IRule接口进行查看分析)
- 网关进行请求转发的流程是怎样,有哪些关键对象?(XxxHandlerMapping,Handler,。。。)
- 网关层面服务的映射方式怎样的?(谓词-path,…,服务名/服务实例)
- 网关层如何记录服务的映射?(通过map,并要考虑读写锁的应用)
断言(Predicate)增强分析(了解)
Predicate简介
Predicate(断言)又称谓词,用于条件判断,只有断言结果都为真,才会真正的执行路由。断言其本质就是定义路由转发的条件。
Predicate内置工厂
SpringCloudGateway包括一些内置的谓词工厂(所有工厂都直接或间接的实现了RoutePredicateFactory接口),这些断言或谓词工程负责创建谓词对象,并通过这些谓词对象判断http请求的合法性。常见谓词工厂如下:
基于Datetime类型的断言工厂:
此类型的断言根据时间做判断,主要有三个:
1)AfterRoutePredicateFactory:判断请求日期是否晚于指定日期
2)BeforeRoutePredicateFactory:判断请求日期是否早于指定日期
3)BetweenRoutePredicateFactory:判断请求日期是否在指定时间段内
-After=2020-12-31T23:59:59.78908:00[Asia/Shanghai]
当且仅当请求时的时间After配置的时间时,才转发该请求,若请求时的时间不是After配置的时间时,则会返回404notfound。时间值可通过ZonedDateTime.now()获取。
基于header的断言工厂HeaderRoutePredicateFactory:
判断请求Header是否具有给定名称且值与正则表达式匹配。例如:
-Header=X-Request-Id,\d
基于Method请求方法的断言工厂:
MethodRoutePredicateFactory接收一个参数,判断请求类型是否跟指定的类型匹配。例如:
-Method=GET
基于Query请求参数的断言工厂,QueryRoutePredicateFactory:
接收两个参数,请求param和正则表达式,判断请求参数是否具有给定名称且值与正则表达式匹配。例如:
-Query=pageSize,\V
Predicate应用案例实践
内置的路由断言工厂应用案例,例如:
说明:当条件不满足时,则无法进行路由转发,会出现404异常。
小节面试分析
- 何为谓词?(网关中封装了判断逻辑的一个对象)
- 谓词逻辑的设计是怎样的?(谓词判断逻辑返回值为true则进行请求转发)
- 你了解哪些谓词逻辑?(path,请求参数,请求方式,请求头,….)
- 我们可以自己定义谓词工厂对象吗?(可以的)
过滤器(Filter)增强分析(了解)
概述
过滤器(Filter)就是在请求传递过程中,对请求和响应做一个处理。Gateway的Filter从作用范围可分为两种:GatewayFilter与GlobalFilter。其中:
GatewayFilter:应用到单个路由或者一个分组的路由上。
GlobalFilter:应用到所有的路由上(例如负载均衡过滤器,请求转发过滤器等)。
局部过滤器设计及实现
在SpringCloudGateway中内置了很多不同类型的网关路由过滤器。具体如下:
案例分析:
基于AddRequestHeaderGatewayFilterFactory,为原始请求添加Header。
例如,为原始请求添加名为X-Request-Foo,值为Bar的请求头:
基于AddRequestParameterGatewayFilterFactory,为原始请求添加请求参数及值,
例如,为原始请求添加名为foo,值为bar的参数,即:foo=bar。
基于PrefixPathGatewayFilterFactory,为原始的请求路径添加一个前缀路径
例如,该配置使访问${GATEWAY_URL}/hello会转发到uri/mypath/hello。
基于RequestSizeGatewayFilterFactory,设置允许接收最大请求包的大小
,配置示例:
如果请求包大小超过设置的值,则会返回413PayloadTooLarge以及一个errorMessage
全局过滤器设计及实现
全局过滤器(GlobalFilter)作用于所有路由,无需配置。在系统初始化时加载,并作用在每个路由上。通过全局过滤器可以实现对权限的统一校验,安全性验证等功能。一般内置的全局过滤器已经可以完成大部分的功能,但是对于企业开发的一些业务功能处理,还是需要我们自己编写过滤器来实现的,那么我们一起通过代码的形式自定义一个过滤器,去完成统一的权限校验。例如,当客户端第一次请求服务时,服务端对用户进行信息认证(登录),认证通过,将用户信息进行加密形成token,返回给客户端,作为登录凭证以后每次请求,客户端都携带认证的token服务端对token进行解密,判断是否有效。学过spring中的webflux技术的同学可以对如下代码进行尝试实现(没学过的可以忽略).
启动Gateway服务,假如在访问的url中不带“user=admin”这个参数,可能会出现异常.
小节面试分析
- 网关过滤器的作用是什么?(对请求和响应数据做一个预处理)
- 网关过滤器的类型有哪些?(局部过滤器,全局过滤器)
- 如何理解局部过滤器?(针对具体链路的应用的过滤器,需要进行配置)
- 你了解哪些局部过滤器?
- 如何理解全局过滤器?(作用于所有请求链路)
- 如何自己定义全局过滤器?(直接或间接实现GlobalFilter接口)
- 假如现在让你进行平台的网关自研设计,你可以吗?(可以)
限流设计及实现
限流简述
网关是所有外部请求的公共入口,所以可以在网关进行限流,而且限流的方式也很多,我们采用Sentinel组件来实现网关的限流。Sentinel支持对SpringCloudGateway、Zuul等主流网关进行限流。参考网址如下:
https://github.com/alibaba/spring-cloud-alibaba/wiki/Sentinel
限流快速入门
第一步:添加依赖
在原有spring-cloud-starter-gateway依赖的基础上再添加如下两个依赖,例如:
第二步:添加sentinel及路由规则(假如已有则无需设置)
第三步:启动网关项目,检测sentinel控制台的网关菜单。
启动时,添加sentinel的jvm参数,通过此菜单可以让网关服务在sentinel控制台显示不一样的菜单,代码如下。
-Dcsp.sentinel.app.type=1
假如是在idea中,可以参考下面的图进行配置
Sentinel控制台启动以后,界面如图所示:
说明,假如没有发现请求链路,API管理,关闭网关项目,关闭sentinel,然后重启sentinel,重启网关项目.
第四步:在sentinel面板中设置限流策略,如图所示:
第五步:通过url进行访问检测是否实现了限流操作
基于请求属性限流
定义指定routeId的基于属性的限流策略如图所示:
通过postman进行测试分析
自定义API维度限流(重点)
自定义API分组,是一种更细粒度的限流规则定义,它允许我们利用sentinel提供的API,将请求路径进行分组,然后在组上设置限流规则即可。
第一步:新建API分组,如图所示:
第二步:新建分组流控规则,如图所示:
第三步:进行访问测试,如图所示
定制流控网关返回值
定义配置类,设计流控返回值,代码如下:
其中,Mono是一个发出(emit)0-1个元素的Publisher对象。
小节面试分析?
- 网关层面结合sentinel实现限流,其限流的类型有几种?(两种-routeid,api)
- 网关层面可以自定义限流后的异常处理结果吗?(可以)
- 你知道Sentinel底层限流的算法有哪些?(滑动窗口,令牌桶,漏斗,。。。)
总结(Summay)
重难点分析
1.网关(Gateway)诞生的背景?(第一:统一微服务访问的入口,第二:对系统服务进行保护,第三进行统一的认证,授权,限流)
2.网关的选型?(NetifixZuul,SpringCloudGateway,…)
3.SpringCloudGateway的入门实现(添加依赖,路由配置,启动类)
4.SpringCloudGateway中的负载均衡?(网关服务注册,服务的发现,基于uri:lb://服务id方式访问具体服务实例)
5.SpringCloudGateway中的断言配置?(掌握常用几个就可,用时可以通过搜索引擎去查)
6.SpringCloudGateway中的过滤器配置?(掌握过滤器中的两大类型-局部和全局)
7.SpringCloudGateway中的限流设计?(Sentinel)
FAQ分析
Gateway在互联网架构中的位置?(nginx->gateway–>微服务–>微服务)
Gateway底层负载均衡的实现?(Ribbon)
Gateway应用过程中设计的主要概念?(路由id,路由uri,断言,过滤器)
Gateway中你做过哪些断言配置?(after,header,path,cookie,…)
Gateway中你用的过滤器有哪些?(添加前缀,去掉前缀,添加请求头,…,负载均衡,…)
BUG分析
- 503异常?(服务不可用,检查你调用的服务是否启动ok,路由uri写的是否正确)
- 启动时解析.yml配置文件异常(格式没有对齐,单词写错)
核心知识点
API网关(Gateway)诞生背景
市场主流微服务网关(SpringCloudGateway,zuul,…)
APIGateway实现服务的保护和转发(重点)
APIGateway层面的负载均衡实现(重点,lb://sca-provider)
APIGateway请求处理原理分析(重点:官方图,了解关键代码,执行过程)
APIGateway中常用谓词(predicate)对象及实践。
APIGateway中过滤器(Filter)的类型及实践。
APIGateway中基于sentinel实现服务限流(API,路由id)。
APIGateway中基于自定义限流结果的处理(GatewayCallbackManager)。
常见问题分析
1.为什么要使用api网关?(服务保护,统一url访问,统一身份认证,统一跨域设计,。。。)
网关入门实践的步骤?(依赖,配置,启动,服务访问)
2.网关项目中的负载均衡是如何实现?(底层基于Ribbon实现,可以在RibbonLoadBalancerClient中加断点分析)
3.说说SpringCloudgateway处理请求的基本流程?(官方,断点)
4.网关中的谓词对象类型?(GatewayPredicate)
5.网关中的谓词对象是如何创建的?(谓词工厂)
6.你在网关中配置过哪些常用谓词?(Path,Method,Before,Query,Header,…)
7.网关中的过滤器是如何分类的?(GlobalFilter,GatewayFilter:需要手动配置)
8.我们是否可以自定义谓词,过滤器对象?(可以,参考官方默认的定义)
9.网关层面如何基于sentinel实现限流?(有关sentinel的两个依赖,配置,JVM参数)
10.网关层面的限流类型有哪些?(路由id,API分组)
11.我们是否可以对限流结果进行自定义处理?(可以,了解)
常见BUG分析
- 配置文件格式不正确,例如
- 服务访问被拒绝,例如
- 服务注册失败(nacos没启动),例如:
- 503异常(找不到可用的服务)
作业
- 练习基于Gateway实现负载均衡方式的配置。
- 练习常用谓词,过滤器以及sentinel限流设计。
- 将路由配置写到配置中心进行实践?(自己动手丰衣足食)
第一步:在sca-gateway项目中添加配置依赖,例如:
第二步:修改application.yml配置文件名称为bootstrap.yml,并添加配置中心配置。
第三步:在nacos的public命名空间中创建sca-gateway.yml配置,内容如下:
说明,此配置添加后,可以将bootstrap.yml中网关部分的配置注释掉。
第四步:启动nacos,sentinel,provider,gateway服务,然后进行访问测试。
拓展练习
- 微服务架构下ajax请求响应处理实践。
第一步:业务描述(通过sca-ui工程向网关工程发送ajax请求,并进行响应处理)
第二步:创建sca-ui工程,例如:
第二步:在sca-ui工程中添加spring-boot-starter-web依赖。
第三步:在sca-ui工程中启动类,例如:
第四步:在sca-ui工程创建static目录,在此目录下添加js文件,html文件,例如:
其中,index.html内容如下:
第四步:在sca-gateway的配置文件或配置中心中添加跨域配置,例如:
第五步:按项目架构设计启动服务,进行测试。
http://localhost:8080/index.html