网关Gateway 应用实践

最新推荐文章于 2024-07-25 23:18:13 发布

码上往来

最新推荐文章于 2024-07-25 23:18:13 发布

阅读量1.2k

点赞数

文章标签： gateway java 开发语言

原文链接：https://blog.csdn.net/maitian_2008/category_11190676.html

版权

网关Gateway 应用实践

文章目录

网关Gateway 应用实践

一. 网关简介

1.1 背景分析

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

1.2 网关概述

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

1.2.1 Spring Cloud Gateway优缺点分析：

优点：

性能强劲：是第一代网关Zuul的1.6倍。
功能强大：内置了很多实用的功能，例如转发、监控、限流等
设计优雅，容易扩展。

缺点：

依赖Netty与WebFlux(Spring5.0)，不是传统的Servlet编程模型(Spring MVC就是基于此模型实现)，学习成本高。
需要Spring Boot 2.0及以上的版本，才支持

二. 快速入门

2.1 业务描述

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

2.2 入门业务实现

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

        <!--添加API 网关依赖,添加此依赖后不要在添加spring-boot-starter-web依赖,会又冲突-->
        <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: #路由配置(routes下可以有多个路由,用id做唯一标识)
        - id: route01 #路由id,自己指定一个唯一值即可
          uri: http://localhost:8081/  #请求转发路径
          predicates: #谓词判断逻辑(定义请求转发的条件,谓词所有条件都满足才会执行请求转发),也可称呼为断言
            - Path=/nacos/provider/echo/** #一个*号是一级目录,两个*号是多级目录 #请求路径定义,此路径对应uri中的资源
          filters:  #局部过滤器  针对与当前路由进行设计,当谓词逻辑满足时,则执行这里的流程
            - StripPrefix=1 #去除前缀过滤器  这里的1表示去除Path中的第一层目录

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

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

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

package com.jt;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
//从启动类所在的包或者子包中查找有特定注解的类,将扫描到的类代为管理
public class GatewayApplication {
    public static void main(String[] args) {
        SpringApplication.run(GatewayApplication.class, args);
    }
}

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

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

2.3 小节面试分析

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

三. 负载均衡设计

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
  cloud:
    gateway: #网关配置
      routes: #路由配置(routes下可以有多个路由,用id做唯一标识)
        - id: route01 #路由id,自己指定一个唯一值即可

          #uri: http://localhost:8081/  #请求转发路径
          uri: lb://sca-provider #lb为loadbalancer负载均衡  sca-provider为服务注册中心的一个服务名,要想使用负载均衡,需将geteway也注册到nacos中

          predicates: #谓词判断逻辑(定义请求转发的条件,谓词所有条件都满足才会执行请求转发),也可称呼为断言
            - Path=/nacos/provider/echo/** #一个*号是一级目录,两个*号是多级目录   #请求路径定义,此路径对应uri中的资源
          filters:  #局部过滤器  针对与当前路由进行设计,当谓词逻辑满足时,则执行这里的流程
            - StripPrefix=1 #去除前缀过滤器  这里的1表示去除Path中的第一层目录
    nacos:
      discovery:
        server-addr: localhost:8848

其中，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可以在发送代理请求之前和之后运行逻辑。处理的逻辑是在处理请求时排在前面的过滤器先执行，而处理返回相应的时候，排在后面的过滤器先执行。

3.4 小节面试分析

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

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

4.1 Predicate 简介

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

4.2 Predicate 内置工厂

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

4.2.1 基于Datetime类型的断言工厂

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

AfterRoutePredicateFactory：判断请求日期是否晚于指定日期
BeforeRoutePredicateFactory：判断请求日期是否早于指定日期
BetweenRoutePredicateFactory：判断请求日期是否在指定时间段内

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

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

4.2.2 基于header的断言工厂HeaderRoutePredicateFactory

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

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

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:
    gateway: #网关配置
      routes: #路由配置(routes下可以有多个路由,用id做唯一标识)
        - id: route01 #路由id,自己指定一个唯一值即可

          #uri: http://localhost:8081/  #请求转发路径
          uri: lb://sca-provider #lb为loadbalancer负载均衡  sca-provider为服务注册中心的一个服务名

          predicates: #谓词判断逻辑(定义请求转发的条件,谓词所有条件都满足才会执行请求转发),也可称呼为断言
            - Path=/nacos/provider/echo/** #一个*号是一级目录,两个*号是多级目录#请求路径定义,此路径对应uri中的资源
            - After=2020-12-31T23:59:59.789+08:00[Asia/Shanghai]
            - Between=2020-12-31T23:59:59.789+08:00[Asia/Shanghai],2022-12-31T23:59:59.789+08:00[Asia/Shanghai]
            - Header=X-Request-Id, \d+
            - Method=Get
          filters:  #局部过滤器  针对与当前路由进行设计,当谓词逻辑满足时,则执行这里的流程
            - StripPrefix=1 #去除前缀过滤器  这里的1表示去除Path中的第一层目录
    nacos:
      discovery:
        server-addr: localhost:8848
#流程分析： RoutePredicateHandlerMapping-->PathRoutePredicateFactory-->Xxx WebHandler-->Filters()

4.4 小节面试分析

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

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

5.1 概述

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

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

5.2 局部过滤器设计及实现

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

5.2.1 基于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

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

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

spring:
  cloud:
    gateway:
      routes:
        - id: add_request_parameter_route
          uri: https://example.org
          filters:
            - AddRequestParameter=foo, bar

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

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

spring:
  cloud:
    gateway:
      routes:
        - id: prefixpath_route
          uri: https://example.org
          filters:
            - PrefixPath=/mypath

5.2.4 基于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.jt.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//将过滤器交给spring管理
public class AuthGlobalFilter implements GlobalFilter, Ordered {
    /*
    * 请求过滤方法
    * exchange 基于此对象获取请求和响应对象
    * chain 过滤链
    * 这里的返回值代表一个Publisher对象(消息的发布者)
    * 可以由此对象帮你进行请求传递
    **/
    @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”这个参数，可能会出现异常.

5.4 小节面试分析

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

六. 限流设计及实现

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及路由规则(假如已有则无需设置)

server:
  port: 9000
spring:
  application:
    name: sca-gateway
  cloud:
    gateway: #网关配置
      routes: #路由配置(routes下可以有多个路由,用id做唯一标识)
        - id: route01 #路由id,自己指定一个唯一值即可

          #uri: http://localhost:8081/  #请求转发路径
          uri: lb://sca-provider #lb为loadbalancer负载均衡  sca-provider为服务注册中心的一个服务名

          predicates: #谓词判断逻辑(定义请求转发的条件,谓词所有条件都满足才会执行请求转发),也可称呼为断言
            - Path=/nacos/provider/echo/** #一个*号是一级目录,两个*号是多级目录   #请求路径定义,此路径对应uri中的资源
#            - After=2020-12-31T23:59:59.789+08:00[Asia/Shanghai]
#            - Between=2020-12-31T23:59:59.789+08:00[Asia/Shanghai],2022-12-31T23:59:59.789+08:00[Asia/Shanghai]
#            - Header=X-Request-Id, \d+
#            - Method=Get
          filters:  #局部过滤器  针对与当前路由进行设计,当谓词逻辑满足时,则执行这里的流程
            - StripPrefix=1 #去除前缀过滤器  这里的1表示去除Path中的第一层目录
    nacos:
      discovery:
        server-addr: localhost:8848
    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的基于属性的限流策略如图所示：

通过postman进行测试分析

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

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

第一步：新建API分组，如图所示：

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

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

6.5 定制流控网关返回值

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

package com.jt;

import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.BlockRequestHandler;
import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.GatewayCallbackManager;
import com.alibaba.fastjson.JSON;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.reactive.function.server.ServerResponse;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.util.HashMap;
import java.util.Map;

@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("status", 49);
                map.put("msg", "blocked by sentinel......");
                String jsonStr = JSON.toJSONString(map);
                return ServerResponse.ok().body(Mono.just(jsonStr), String.class);
            }
        });
    }
}

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

6.6 小节面试分析

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

七. 拓展练习

7.1 将路由配置写到配置中心进行实践

第一步：在sca-gateway项目中添加配置依赖

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

第二步：修改application.yml配置文件名称为bootstrap.yml，并添加配置中心配置。

spring:
  cloud:
    nacos:
      config:
        server-addr: localhost:8848
        file-extension: yml

第三步：在nacos的public命名空间中创建sca-gateway.yml配置，内容如下

说明，此配置添加后，可以将bootstrap.yml中网关部分的配置注释掉。

第四步：启动nacos,sentinel,provider,gateway服务，然后进行访问测试。

7.2 微服务架构下ajax请求响应处理实践。

第一步：业务描述（通过sca-ui工程向网关工程发送ajax请求，并进行响应处理）

第二步：创建sca-ui工程，例如：

第二步：在sca-ui工程中添加spring-boot-starter-web依赖。

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

第三步：在sca-ui工程中启动类，例如：

package com.jt;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

第四步：在sca-ui工程创建static目录，在此目录下添加js文件，html文件，例如：

其中，index.html内容如下:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h2>The Index Page</h2>
     <!--
  <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
  -->
<script src="/js/axios.min.js"></script>
<button onclick="doBuy()">购买</button>
<span id="result"></span>
<script>
    function doBuy() {
        //1.定义请求的url(是网关的地址)
        let url ="http://localhost:9000/nacos/provider/echo/1";
        let span=document.getElementById("result");
        //基于axios框架,发送ajax异步请求
        axios.get(url).then(function (promise) {
            console.log(promise);
            if(!promise.data.status){
                /*正常结果走这里*/
                span.innerHTML=promise.data;
            }else {
                /*当服务端处理异常时,走这里*/
                span.innerHTML=promise.data.msg;
            }
        })
            /*假如服务端未处理限流异常,直接抛错给前端,前端需要捕获处理*/
        .catch(function (error) {
            if(error.response==429){
                span.innerHTML=error.response.statusText;
            }
        });
    }
</script>
</body>
</html>

第五步：在sca-gateway的配置文件或配置中心中添加跨域配置，例如：

spring:
  cloud:
    gateway: 
      globalcors: #跨域配置
        cors-configurations:
          '[/**]':
            allowedOrigins: "*"
            allowedMethods: "*"