07-网关Gateway 应用实践

背景分析

---

我们知道，一个大型系统在设计时，经常会被拆分为很多个微服务。那么作为客户端要如何去调用 这么多的微服务呢？客户端可以直接向微服务发送请求，每个微服务都有一个公开的URL，该URL可以直接映射到具体的微服务，如果没有网关的存在，我们只能在客户端记录每个微服务的地址，然后分别去调用。这样的架构，会存在着诸多的问题，例如，客户端请求不同的微服务可能会增加客户端代码或配置的复杂性。还有就是每个服务，在调用时都需要独立认证。并且存在跨域请求，也在一定程度上提高了代码的复杂度。基于微服务架构中的设计及实现上的问题，为了在项目中简化前端的调用逻辑，同时也简化内部服务之间互相调用的复杂度，更好保护内部服务,提出了网关的概念。

网关概述

---

网关本质上要提供一个各种服务访问的入口，并提供服务接收并转发所有内外部的客户端调用，还有就是权限认证，限流控制等等。Spring Cloud Gateway是Spring公司基于Spring 5.0，Spring Boot 2.0 和 等技术开发的一个网关组件，它旨在为微服务架构提供一种简单有效的统一的 API入口，负责服务请求路由、组合及协议转换，并且基于 Filter 链的方式提供了权限认证，监控、限流等功能。

Spring Cloud Gateway优缺点分析：

• 优点：

1. 性能强劲：是第一代网关Zuul的1.6倍。

2. 功能强大：内置了很多实用的功能，例如转发、监控、限流等

3. 设计优雅，容易扩展。

• 缺点：

1. 依赖Netty与WebFlux(Spring5.0)，不是传统的Servlet编程模型(Spring MVC就是基于此模型实现)，学习成本高。

2. 需要Spring Boot 2.0及以上的版本，才支持

快速入门

==============================================================

业务描述

---

通过网关作为服务访问入口，对系统中的服务进行访问,例如通过网关服务去访问sca-provider服务.

入门业务实现

---

第一步：创建sca-gateway模块（假如已有则无须创建），其pom.xml文件如下：

org.springframework.cloud

spring-cloud-starter-gateway

第二步：创建application.yml(假如已有则无须创建),添加相关配置，代码如下：

server:

port: 9000

spring:

application:

name: sca-gateway

cloud:

gateway:

routes: #配置网关路由规则

• id: route01 #路由id,自己指定一个唯一值即可

uri: http://localhost:8081/ #网关帮我们转发的url

predicates: ###断言(谓词):匹配请求规则

• Path=/nacos/provider/echo/** #请求路径定义,此路径对应uri中的资源

filters: ##网关过滤器,用于对谓词中的内容进行判断分析以及处理

• StripPrefix=1 #转发之前去掉path中第一层路径，例如nacos

其中：路由(Route) 是 gateway 中最基本的组件之一，表示一个具体的路由信息载体。主要定义了下面的几个信息:

1. id，路由标识符，区别于其他 Route。

2. uri，路由指向的目的地 uri，即客户端请求最终被转发到的微服务。

3. predicate，断言(谓词)的作用是进行条件判断，只有断言都返回真，才会执行路由。

4. filter，过滤器用于修改请求和响应信息。

第三步：创建项目启动类,例如:

package com.cy;

@SpringBootApplication

public class GatewayApplication {

public static void main(String[] args) {

SpringApplication.run(GatewayApplication.class,args);

}

}

第四步:启动项目进行访问测试，

依次启动sca-provider,sca-gateway服务,然后打开浏览器,进行访问测试,例如:

小节面试分析？

---

• 什么是网关？服务访问(流量)的一个入口，类似生活中的“海关“

• 为什么使用网关？(服务安全，统一服务入口管理，负载均衡，限流，鉴权)

• Spring Cloud Gateway 应用的初始构建过程(添加依赖，配置)

• Gateway 服务的启动底层是通过谁去实现的？(Netty网络编程框架-ServerSocket)

• Gateway 服务做请求转发时一定要在注册中心进行注册吗？（不一定，可以直接通过远端url进行服务访问）

负载均衡设计

================================================================

为什么负载均衡？

---

网关才是服务访问的入口，所有服务都会在网关层面进行底层映射，所以在访问服务时，要基于服务serivce id（服务名）去查找对应的服务，让请求从网关层进行均衡转发，以平衡服务实例的处理能力。

Gateway中负载均衡实现？

---

第一步：项目中添加服务发现依赖，代码如下：

com.alibaba.cloud

spring-cloud-starter-alibaba-nacos-discovery

第二步：修改其配置文件，代码如下

server:

port: 9000

spring:

application:

name: sca-gateway

cloud:

nacos:

discovery:

server-addr: localhost:8848

gateway:

discovery:

locator:

enabled: true #开启通过服务注册中心的serviceId创建路由

routes:

• id: route01

##uri: http://localhost:8081/

uri: lb://sca-provider # lb为服务前缀（负载均衡单词的缩写），不能随意写

predicates: ###匹配规则

• Path=/nacos/provider/echo/**

filters:

• StripPrefix=1 #转发之前去掉path中第一层路径，例如nacos

其中，lb指的是从nacos中按照名称获取微服务,并遵循负载均衡策略。同时建议开发阶段打开gateway日志，代码如下：

logging:

level:

org.springframework.cloud.gateway: debug

第三步：启动服务，进行访问测试，并反复刷新分析，如图所示：

执行流程分析（重要）

---

根据官方的说明，其Gateway具体工作流程，如图所示：

客户端向Spring Cloud Gateway发出请求。 如果Gateway Handler Mapping 通过谓词predicates(predicates)的集合确定请求与路由(Routers)匹配，则将其发送到Gateway Web Handler。 Gateway Web Handler 基于路由配置调用过滤链中的过滤器（也就是所谓的责任链模式）进一步的处理请求。 Filter由虚线分隔的原因是， Filter可以在发送请求之前和之后执行拓展逻辑。基于官方的处理流程，进行源码分析如下：

小节面试分析？

---

• 网关层面是如何实现负载均衡的？(通过服务名去查找具体的服务实例)

• 网关层面是如何通过服务名查找服务实例的？(Ribbon)

• 你了解Ribbon中的哪些负载均衡算法?(轮询，权重，hash,……可通过IRule接口进行查看分析)

• 网关进行请求转发的流程是怎样，有哪些关键对象？（XxxHandlerMapping，Handler，。。。）

• 网关层面服务的映射方式怎样的？(谓词-path，…,服务名/服务实例)

• 网关层如何记录服务的映射？(通过map，并要考虑读写锁的应用)

断言(Predicate)增强分析(了解)

===============================================================================

Predicate 简介

---

Predicate(断言)又称谓词，用于条件判断，只有断言结果都为真，才会真正的执行路由。断言其本质就是定义路由转发的条件。

Predicate 内置工厂

---

SpringCloud Gateway包括一些内置的谓词工厂(所有工厂都直接或间接的实现了RoutePredicateFactory接口)，这些断言或谓词工程负责创建谓词对象,并通过这些谓词对象判断http请求的合法性。常见谓词工厂如下：

基于Datetime类型的断言工厂

此类型的断言根据时间做判断，主要有三个：

1） AfterRoutePredicateFactory：判断请求日期是否晚于指定日期

2） BeforeRoutePredicateFactory：判断请求日期是否早于指定日期

3） BetweenRoutePredicateFactory：判断请求日期是否在指定时间段内

-After=2020-12-31T23:59:59.789+08:00[Asia/Shanghai]

当且仅当请求时的时间After配置的时间时，才转发该请求，若请求时的时间不是After配置的时间时，则会返回404 not found。时间值可通过ZonedDateTime.now()获取。

基于header的断言工厂HeaderRoutePredicateFactory

判断请求Header是否具有给定名称且值与正则表达式匹配。例如：

-Header=X-Request-Id, \d+

基于Method请求方法的断言工厂，

MethodRoutePredicateFactory接收一个参数，判断请求类型是否跟指定的类型匹配。例如：

-Method=GET

基于Query请求参数的断言工厂，QueryRoutePredicateFactory ：

接收两个参数，请求param和正则表达式， 判断请求参数是否具 有给定名称且值与正则表达式匹配。例如：

-Query=pageSize,\d+

Predicate 应用案例实践

---

内置的路由断言工厂应用案例，例如：

server:

port: 9000

spring:

application:

name: sca-gateway

cloud:

nacos:

server-addr: localhost:8848

gateway:

discovery:

locator:

enabled: true #开启通过服务中心的serviceId 创建路由的功能

routes:

• id: bd-id

##uri: http://localhost:8081/

uri: lb://sca-provider

predicates: ###匹配规则

• Path=/nacos/provider/echo/**

• Before=2021-01-30T00:00:00.000+08:00

• Method=GET

filters:

• StripPrefix=1 # 转发之前去掉1层路径

说明：当条件不满足时，则无法进行路由转发，会出现404异常。

小节面试分析

---

• 何为谓词?(网关中封装了判断逻辑的一个对象)

• 谓词逻辑的设计是怎样的？(谓词判断逻辑返回值为true则进行请求转发)

• 你了解哪些谓词逻辑？(path,请求参数，请求方式，请求头,….)

• 我们可以自己定义谓词工厂对象吗？(可以的)

过滤器(Filter)增强分析(了解)

=============================================================================

概述

---

过滤器(Filter)就是在请求传递过程中，对请求和响应做一个处理。Gateway 的Filter从作用范围可分为两种：GatewayFilter与GlobalFilter。其中：

1. GatewayFilter：应用到单个路由或者一个分组的路由上。

2. GlobalFilter：应用到所有的路由上(例如负载均衡过滤器，请求转发过滤器等)。

局部过滤器设计及实现

---

在SpringCloud Gateway中内置了很多不同类型的网关路由过滤器。具体如下：

案例分析：

基于AddRequestHeaderGatewayFilterFactory，为原始请求添加Header。

例如，为原始请求添加名为 X-Request-Foo ，值为 Bar 的请求头：

spring:

cloud:

gateway:

routes:

• id: add_request_header_route

uri: https://example.org

filters:

• AddRequestHeader=X-Request-Foo, Bar

基于AddRequestParameterGatewayFilterFactory，为原始请求添加请求参数及值，

例如，为原始请求添加名为foo，值为bar的参数，即：foo=bar。

spring:

cloud:

gateway:

routes:

• id: add_request_parameter_route

uri: https://example.org

filters:

• AddRequestParameter=foo, bar

基于PrefixPathGatewayFilterFactory，为原始的请求路径添加一个前缀路径

例如，该配置使访问${GATEWAY_URL}/hello 会转发到uri/mypath/hello。

spring:

cloud:

gateway:

routes:

• id: prefixpath_route

uri: https://example.org

filters:

• PrefixPath=/mypath

基于RequestSizeGatewayFilterFactory，设置允许接收最大请求包的大小

，配置示例：

spring:

cloud:

gateway:

routes:

• id: request_size_route

uri: http://localhost:8080/upload

predicates:

• Path=/upload

filters:

• name: RequestSize

args:

单位为字节

maxSize: 5000000

如果请求包大小超过设置的值，则会返回 413 Payload Too Large以及一个errorMessage

全局过滤器设计及实现

---

全局过滤器(GlobalFilter)作用于所有路由, 无需配置。在系统初始化时加载，并作用在每个路由上。通过全局过滤器可以实现对权限的统一校验，安全性验证等功能。一般内置的全局过滤器已经可以完成大部分的功能，但是对于企业开发的一些业务功能处理，还是需要我们 自己编写过滤器来实现的，那么我们一起通过代码的形式自定义一个过滤器，去完成统一的权限校验。 例如，当客户端第一次请求服务时，服务端对用户进行信息认证（登录), 认证通过，将用户信息进行加密形成token，返回给客户端，作为登录凭证 以后每次请求，客户端都携带认证的token 服务端对token进行解密，判断是否有效。学过spring中的webflux技术的同学可以对如下代码进行尝试实现(没学过的可以忽略).

package com.cy.filters;