1.8 网关Gateway 应用实践

蟑螂恶霸不是恶霸

2024-04-26 帮助1人

1.网关简介

1.1 背景分析

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

1.2 网关概述

网关本质上要提供一个各种服务访问的入口，并提供服务接收并转发所有内外部的客户端调用，还有就是权限认证，限流控制等等。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及以上的版本，才支持

2.快速入门

2.1 业务描述

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

2.2 入门业务实现

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

<!--添加网关的依赖-->
<dependency>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

第二步：创建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 中最基本的组件之一，表示一个具体的路由信息载体。主要定义了下面的几个信息:

id：路由标识符，区别于其他 Route。
url：路由指向的目的地 uri，即客户端请求最终被转发到的微服务。
predicate：断言(谓词)的作用是进行条件判断，只有断言都返回真，才会执行路由。
filter：过滤器用于修改请求和响应信息。

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

package com.cy;

@SpringBootApplication
public class GatewayApplication {
    public static void main(String[] args) {
        SpringApplication.run(GatewayApplication.class,args);
    }
}

第四步:启动项目进行访问测试，
依次启动sca-provider,sca-gateway服务,然后打开浏览器,进行访问测试,例如:
学新通

这里实际获取到的信息是http://localhost:8081/provider/echo/666的地址信息，网关将其进行了转发；

2.3 小节面试分析？

什么是网关？
- 服务访问(流量)的一个入口，类似生活中的“海关“
为什么使用网关？
- 服务安全，统一服务入口管理，负载均衡，限流，鉴权
Spring Cloud Gateway 应用的初始构建过程
- 添加依赖，配置
Gateway 服务的启动底层是通过谁去实现的？
- Netty网络编程框架-ServerSocket
Gateway 服务做请求转发时一定要在注册中心进行注册吗？
- 不一定，可以直接通过远端url进行服务访问

3.负载均衡设计

3.1 为什么负载均衡？

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

3.2 Gateway中负载均衡实现？

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

<dependency>
  <groupId>com.alibaba.cloud</groupId>
  <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

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

server:
  port: 9000
spring:
  application:
    name: sca-gateway
  #下方的routes中需要从nacos中查找调用服务，所以需要配置nacos的地址，当然这里也可以省略不写
  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为服务前缀（负载均衡单词的缩写），不能随意写；其底层启用了全局过滤器，在过滤器内部使用了ribbon实现负载均衡
          predicates: ###匹配规则
              - Path=/nacos/provider/echo/**
          filters:
              - StripPrefix=1 #转发之前去掉path中第一层路径，例如nacos

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

logging:
  level:
    org.springframework.cloud.gateway: debug

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

3.3 执行流程分析（重要）

根据官方的说明，其Gateway具体工作流程，如图所示：
学新通
客户端向Spring Cloud Gateway发出请求。如果Gateway Handler Mapping 通过断言predicates(predicates)的集合确定请求与路由(Routers)匹配，则将其发送到Gateway Web Handler。 Gateway Web Handler 通过确定的路由中所配置的过滤器集合链式调用过滤器（也就是所谓的责任链模式）。 Filter由虚线分隔的原因是， Filter可以在发送代理请求之前和之后运行逻辑。处理的逻辑是在处理请求时排在前面的过滤器先执行，而处理返回相应的时候，排在后面的过滤器先执行。

整个网关的负载均衡是通过下列的这些类来进行实现的，如果我们想追踪整个网关的调用流程，可以在下列的列中添加断点进行debug测试：
学新通

处理映射器：RoutePredicateHandlerMapping
谓词工厂：PathRoutePredicateFactory
网关过滤器：StripPrefixGatewayFilterFactory基于GatewayFilter接口实现
全局过滤器：LoadBalancerClientFilter基于GlobalFilter接口实现，实现负载均衡

例如，我们在RoutePredicateHandlerMapping类中，选中类名后，使用ctrl f12查看类中所有方法，查找我们想要的方法，在合适的方法上添加断点：
学新通

谓词工厂主要是为了创建谓词使用，我们可以在下图中的方法中添加断点：
学新通

在全局过滤器中，还包含一个局部过滤器，我们在此处添加断点：
学新通

3.4 将网关相关内容优化到配置中心中

添加配置中心依赖

        <!--添加配置中心依赖-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>

修改配置文件名
我们需要将配置文件名更改为bootst.yml
将网关的配置中心内容粘贴到nacos中
在nacos中新建配置，将网关的相关配置粘贴到其中：

spring:
  cloud:
    gateway:
      routes:
        - id: route01
          ##uri: http://localhost:8081/
          uri: lb://sca-provider # lb为服务前缀（负载均衡单词的缩写），不能随意写；其底层启用了全局过滤器，在过滤器内部使用了ribbon实现负载均衡
          predicates: ###匹配规则.
            - Path=/nacos/provider/echo/**
          filters:
            - StripPrefix=1 #转发之前去掉path中第一层路径，例如nacos

测试完成后需要将配置文件恢复，删除配置中心内容，否则会影响后续教程中的案例测试；

3.5 小节面试分析？

网关层面是如何实现负载均衡的？
- 通过服务名去查找具体的服务实例
网关层面是如何通过服务名查找服务实例的？
- Ribbon
你了解Ribbon中的哪些负载均衡算法?
- 轮询，权重，hash,……可通过IRule接口进行查看分析
网关进行请求转发的流程是怎样，有哪些关键对象？
- XxxHandlerMapping，Handler，。。。
网关层面服务的映射方式怎样的？
- 谓词-path，…,服务名/服务实例
网关层如何记录服务的映射？
- 通过map，并要考虑读写锁的应用)

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

4.1 Predicate 简介

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

4.2 Predicate 内置工厂

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

4.2.1 时间类型谓词

基于Datetime类型的断言工厂，此类型的断言根据时间做判断，主要有三个：

AfterRoutePredicateFactory：判断请求日期是否晚于指定日期
BeforeRoutePredicateFactory：判断请求日期是否早于指定日期
BetweenRoutePredicateFactory：判断请求日期是否在指定时间段内，俩个日期已逗号分隔

例如，我们可以在配置文件中添加下列的谓词来根据时间控制是否可以访问当前网址：After=2023-06-14T23:59:59.789 08:00[Asia/Shanghai]
学新通

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

4.2.2 名称类型谓词

基于header的断言工厂HeaderRoutePredicateFactory，判断请求头中是否具有给定名称且值与正则表达式匹配。例如：

Header=X-Request-Id, \d

当配置此谓词后，我们访问的请求头中必须包含请求头X-Request-Id且其值为一个整数，此时无法在浏览器中直接测试，需要借助IDEA工具或POSTMAN等工具进行测试：
学新通

学新通

4.2.3 请求类型谓词

基于Method请求方法的断言工厂，MethodRoutePredicateFactory接收一个参数，判断请求类型是否跟指定的类型匹配。例如：

Method=GET

4.2.4 请求参数类型谓词

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

Query=pageSize,\d

当然还有很多其他的谓词，在使用时可以到官网进行查询进行使用；

4.3 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=2023-06-14T00:00:00.000 08:00
              - Method=GET
          filters:
            -  StripPrefix=1 # 转发之前去掉1层路径

我们这里使用谓词进行判断，需要在2023年6月14日之后的GET请求才可以访问我们的链接；当条件不满足时，则无法进行路由转发，会出现404异常。

4.4 小节面试分析

何为谓词?(网关中封装了判断逻辑的一个对象)
谓词逻辑的设计是怎样的？(谓词判断逻辑返回值为true则进行请求转发)
你了解哪些谓词逻辑？(path,请求参数，请求方式，请求头,….)
我们可以自己定义谓词工厂对象吗？(可以的)

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

5.1 概述

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

GatewayFilter：应用到单个路由或者一个分组的路由上。
GlobalFilter：应用到所有的路由上。

5.2 局部过滤器设计及实现

在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

5.3 全局过滤器设计及实现

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

package com.cy.filters;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@Component
public class AuthGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String username=exchange.getRequest()
                .getQueryParams().getFirst("username");
        if (!"admin".equals(username)) {
            System.out.println("认证失败");
            exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
            return exchange.getResponse().setComplete();
        }
        //调用chain.filter继续向下游执行
        return chain.filter(exchange);

    }

    @Override
    public int getOrder() {
        return 0;
    }
}

启动Gateway服务，假如在访问的url中不带“user=admin”这个参数，可能会出现异常;泛型Mono<Void>可以看作是零个或一个执行序列，我们这里采用的是异步执行过程，而且采用了发布订阅模型，这里可以只做了解，自己尝试实现；

5.4 小节面试分析

网关过滤器的作用是什么？(对请求和响应数据做一个预处理)
网关过滤器的类型有哪些？(局部过滤器，全局过滤器)
如何理解局部过滤器？(针对具体链路的应用的过滤器，需要进行配置)
你了解哪些局部过滤器？
如何理解全局过滤器？(作用于所有请求链路)
如何自己定义全局过滤器?(直接或间接实现GlobalFilter接口)
假如现在让你进行平台的网关自研设计，你可以吗？(可以)

6.限流设计及实现

6.1 限流简述

网关是所有外部请求的公共入口，所以可以在网关进行限流，而且限流的方式也很多，我们采用Sentinel组件来实现网关的限流。Sentinel支持对SpringCloud Gateway、Zuul等主流网关进行限流。参考网址为：https://github.com/alibaba/spring-cloud-alibaba/wiki/Sentinel

6.2 限流快速入门

第一步：添加依赖
在原有spring-cloud-starter-gateway依赖的基础上再添加如下两个依赖，例如：

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
</dependency>
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
</dependency>

第二步：添加sentinel及路由规则(假如已有则无需设置)

routes:
  - id: route01
    uri: lb://sca-provider
    predicates: ###匹配规则
      - Path=/nacos/provider/echo/**

sentinel:
  transport:
    dashboard: localhost:8180 #Sentinel 控制台地址
  eager: true  #取消Sentinel控制台懒加载,即项目启动即连接

第三步：启动网关项目，检测sentinel控制台的网关菜单。
启动时，添加sentinel的jvm参数，通过此菜单可以让网关服务在sentinel控制台显示不一样的菜单，代码如下。

-Dcsp.sentinel.app.type=1

假如是在idea中，可以参考下面的图进行配置

学新通

Sentinel 控制台启动以后，界面如图所示:
学新通
说明,假如没有发现请求链路,API管理,关闭网关项目，关闭sentinel，然后重启sentinel,重启网关项目.

第四步：在sentinel面板中设置限流策略，如图所示：

学新通
第五步：通过url进行访问检测是否实现了限流操作

6.3 基于请求属性限流

定义指定routeId的基于属性的限流策略如图所示：

学新通
上述配置表示我们需要在访问时，在请求头中包含tokenId的属性，并且其值为1000；我们可以通过postman进行测试分析：

学新通

6.4 自定义API维度限流（重点）

自定义API分组，是一种更细粒度的限流规则定义，它允许我们利用sentinel提供的API，将请求路径进行分组，然后在组上设置限流规则即可。

第一步：新建API分组，如图所示：
学新通
第二步：新建分组流控规则，如图所示：

第三步：进行访问测试，如图所示

6.5 定制流控网关返回值

定义配置类，设计流控返回值，代码如下：

@Configuration
public class GatewayConfig {
    public GatewayConfig(){
        GatewayCallbackManager.setBlockHandler( new BlockRequestHandler() {
            @Override
            public Mono<ServerResponse> handleRequest(ServerWebExchange serverWebExchange, Throwable throwable) {
                Map<String,Object> map=new HashMap<>();
                map.put("state",429);
                map.put("message","to many request");
                String jsonStr=JSON.toJSONString(map);
                return ServerResponse.ok().body(Mono.just(jsonStr),String.class);
            }
        });
    }
}

其中，Mono 是一个发出(emit)0-1个元素的Publisher对象。

6.6 实践案例

6.6.1 案例实现

现在我们实现一个小的demo练习，我们构建一个新的服务，并且写一个页面，页面中有一个请求按钮，点击按钮后，会向
sca-gateway发送Ajax请求例如: /nacos/provider/echo/1，sca-gateway会对我们的请求进行转发并优化请求地址为: /provider/echo/1访问sca-provider服务，sca-provider服务响应请求结果到sca-gateway服务，sca-gateway服务将响应结果返回到我们请求的服务；

6.6.2 项目构建

创建一个新的maven工程，并添加web依赖；
创建启动类
在resources目录下创建一个static目录，对于springboot应用来说，其静态资源默认是放在resources/static目录下的，我们将在这里创建我们的页面内容
在static目录下新建一个html文件，并完成前端内容（注意后续访问会出现跨域问题，在页面代码中加入<script src="https://unpkg.com/axios/dist/axios.min.js"></script>解决）
设置网关服务解决跨域问题的配置文件：注意其是gateway的下级

此时我们便可以在sentinel中对页面的访问做一些具体的负载均衡实现；

6.7 小节面试分析？

网关层面结合sentinel实现限流，其限流的类型有几种？(两种-route id,api)
网关层面可以自定义限流后的异常处理结果吗？(可以)
你知道Sentinel底层限流的算法有哪些？(滑动窗口，令牌桶，漏斗，。。。)

7.总结（Summay）

7.1 重难点分析

网关(Gateway)诞生的背景?(第一:统一微服务访问的入口,第二:对系统服务进行保护,第三进行统一的认证,授权,限流)
网关的选型?(Netifix Zuul,Spring Cloud Gateway,…)
Spring Cloud Gateway的入门实现(添加依赖,路由配置,启动类)
Spring Cloud Gateway中的负载均衡?(网关服务注册,服务的发现,基于uri:lb://服务id方式访问具体服务实例)
Spring Cloud Gateway中的断言配置?(掌握常用几个就可,用时可以通过搜索引擎去查)
Spring Cloud Gateway中的过滤器配置?(掌握过滤器中的两大类型-局部和全局)
Spring Cloud Gateway中的限流设计?(Sentinel)

7.2 FAQ 分析

Gateway在互联网架构中的位置?(nginx->gateway–>微服务–>微服务)
Gateway底层负载均衡的实现?(Ribbon)
Gateway应用过程中设计的主要概念?(路由id,路由uri,断言,过滤器)
Gateway中你做过哪些断言配置?(after,header,path,cookie,…)
Gateway中你用的过滤器有哪些?(添加前缀,去掉前缀,添加请求头,…,负载均衡,…)

7.3 BUG分析

503 异常?(服务不可用,检查你调用的服务是否启动ok,路由uri写的是否正确)
启动时解析.yml配置文件异常(格式没有对齐,单词写错)

这篇好文章是转载于：学新通技术网