1.Gateway网关简介及使用

喜欢ヅ旅行 2022-10-05 14:57 240阅读 0赞

原文地址（强烈建议看原文）：https://blog.csdn.net/rain_web/article/details/102469745

目录：

  1. 什么是 API 网关（API Gateway）
  2. Gateway是什么
  3. 为什么用Gateway

  4. Gateway怎么用

    1. 通过时间匹配
    2. 通过 Cookie 匹配
    3. 通过 Host 匹配
    4. 通过请求方式匹配
    5. 通过请求路径匹配
    6. 通过请求参数匹配
    7. 通过请求 ip 地址进行匹配
    8. 组合使用

  5. 注意

    1. GateWay 中StripPrefix的作用

#

一. 什么是 API 网关（API Gateway）

官网地址：Spring Cloud Gateway

可参考：https://www.freesion.com/article/44731415762/#2GateWay_117

可参考：https://www.haoyizebo.com/archives/page/2/#board

可参考：http://www.ityouknow.com/springcloud/2019/01/26/spring-cloud-gateway-limit.html

一个关于网关的项目的设计 gitee：https://gitee.com/mirren/VX-API-Gateway#4%E6%9D%83%E9%99%90%E8%AE%A4%E8%AF%81

分布式服务架构、微服务架构与 API 网关

在微服务架构里，服务的粒度被进一步细分，各个业务服务可以被独立的设计、开发、测试、部署和管理。这时，各个独立部署单元可以用不同的开发测试团队维护，可以使用不同的编程语言和技术平台进行设计，这就要求必须使用一种语言和平 台无关的服务协议作为各个单元间的通讯方式。

format_png

API 网关的定义

网关的角色是作为一个 API 架构，用来保护、增强和控制对于 API 服务的访问。

API 网关是一个处于应用程序或服务（提供 REST API 接口服务）之前的系统，用来管理授权、访问控制和流量限制等，这样 REST API 接口服务就被 API 网关保护起来，对所有的调用者透明。因此，隐藏在 API 网关后面的业务系统就可以专注于创建和管理服务，而不用去处理这些策略性的基础设施。

API 网关的职能

format_png 1

API 网关的分类与功能

format_png 2

以下都要实践：

  1. 路由
  2. 服务级别流控
  3. 服务降级与熔断（双十一，部分功能无法使用，给商品详情、下单让步）、重试

二. Gateway是什么

Spring Cloud Gateway是Spring官方基于Spring 5.0，Spring Boot 2.0和Project Reactor等技术开发的网关，Spring Cloud Gateway旨在为微服务架构提供一种简单而有效的统一的API路由管理方式。Spring Cloud Gateway作为Spring Cloud生态系中的网关，目标是替代ZUUL，其不仅提供统一的路由方式，并且基于Filter链的方式提供了网关基本的功能，例如：安全，监控/埋点，和限流等。

三. 为什么用Gateway

Spring Cloud Gateway 可以看做是一个 Zuul 1.x 的升级版和代替品，比 Zuul 2 更早的使用 Netty 实现异步 IO，从而实现了一个简单、比 Zuul 1.x 更高效的、与 Spring Cloud 紧密配合的 API 网关。
Spring Cloud Gateway 里明确的区分了 Router 和 Filter，并且一个很大的特点是内置了非常多的开箱即用功能，并且都可以通过 SpringBoot 配置或者手工编码链式调用来使用。
比如内置了 10 种 Router，使得我们可以直接配置一下就可以随心所欲的根据 Header、或者 Path、或者 Host、或者 Query 来做路由。
比如区分了一般的 Filter 和全局 Filter，内置了 20 种 Filter 和 9 种全局 Filter，也都可以直接用。当然自定义 Filter 也非常方便。

最重要的几个概念

format_png 3

说明：

Predicate & Spring Cloud Gateway 路由匹配规则

Predicate 来源于 Java 8，是 Java 8 中引入的一个函数，Predicate 接受一个输入参数，返回一个布尔值结果。该接口包含多种默认方法来将 Predicate 组合成其他复杂的逻辑（比如：与，或，非）。可以用于接口请求参数校验、判断新老数据是否有变化需要进行更新操作。

在 Spring Cloud Gateway 中 Spring 利用 Predicate 的特性实现了各种路由匹配规则，有通过 Header、请求参数等不同的条件来进行作为条件匹配到对应的路由。

format_png 4

format_png 5

四. Gateway怎么用

说白了 Predicate 就是为了实现一组匹配规则，方便让请求过来找到对应的 Route 进行处理，接下来我们接下 Spring Cloud GateWay 内置几种 Predicate 的使用。

1. 通过时间匹配

Predicate 支持设置一个时间，在请求进行转发的时候，可以通过判断在这个时间之前或者之后进行转发。比如我们现在设置只有在 2019 年 1 月 1 日才会转发到我的网站，在这之前不进行转发，我就可以这样配置：

  1. spring:
  2.   cloud:
  3.     gateway:
  4.       routes:
  5.        - id: time_route
  6.         uri: http://ityouknow.com
  7.         predicates:
  8.          - After=2018-01-20T06:06:06+08:00[Asia/Shanghai]

Spring 是通过 ZonedDateTime 来对时间进行的对比，ZonedDateTime 是 Java 8 中日期时间功能里，用于表示带时区的日期与时间信息的类，ZonedDateTime 支持通过时区来设置时间，中国的时区是：Asia/Shanghai。

After Route Predicate 是指在这个时间之后的请求都转发到目标地址。上面的示例是指，请求时间在 2018 年 1 月 20 日 6 点 6 分 6 秒之后的所有请求都转发到地址http://ityouknow.com。+08:00是指时间和 UTC 时间相差八个小时，时间地区为Asia/Shanghai。

添加完路由规则之后，访问地址http://localhost:8080会自动转发到http://ityouknow.com。

Before Route Predicate 刚好相反，在某个时间之前的请求的请求都进行转发。我们把上面路由规则中的 After 改为 Before，如下：

  1. spring:
  2.   cloud:
  3.     gateway:
  4.       routes:
  5.        - id: after_route
  6.         uri: http://ityouknow.com
  7.         predicates:
  8.          - Before=2018-01-20T06:06:06+08:00[Asia/Shanghai]

就表示在这个时间之前可以进行路由，在这时间之后停止路由，修改完之后重启项目再次访问地址http://localhost:8080，页面会报 404 没有找到地址。

除过在时间之前或者之后外，Gateway 还支持限制路由请求在某一个时间段范围内，可以使用 Between Route Predicate 来实现。

  1. spring:
  2.   cloud:
  3.     gateway:
  4.       routes:
  5.        - id: after_route
  6.         uri: http://ityouknow.com
  7.         predicates:
  8.          - Between=2018-01-20T06:06:06+08:00[Asia/Shanghai], 2019-01-20T06:06:06+08:00[Asia/Shanghai]

这样设置就意味着在这个时间段内可以匹配到此路由，超过这个时间段范围则不会进行匹配。通过时间匹配路由的功能很酷，可以用在限时抢购的一些场景中。

2. 通过 Cookie 匹配

Cookie Route Predicate 可以接收两个参数，一个是 Cookie name , 一个是正则表达式，路由规则会通过获取对应的 Cookie name 值和正则表达式去匹配，如果匹配上就会执行路由，如果没有匹配上则不执行。

  1. spring:
  2.   cloud:
  3.     gateway:
  4.       routes:
  5.        - id: cookie_route
  6.          uri: http://ityouknow.com
  7.          predicates:
  8.          - Cookie=ityouknow, kee.e

使用 curl 测试，命令行输入:

curl http://localhost:8080 —cookie “ityouknow=kee.e”

则会返回页面代码，如果去掉--cookie “ityouknow=kee.e”，后台汇报 404 错误。

Header Route Predicate 和 Cookie Route Predicate 一样，也是接收 2 个参数，一个 header 中属性名称和一个正则表达式，这个属性值和正则表达式匹配则执行。

  1. spring:
  2.   cloud:
  3.     gateway:
  4.       routes:
  5.       - id: header_route
  6.         uri: http://ityouknow.com
  7.         predicates:
  8.         - Header=X-Request-Id, \d+

使用 curl 测试，命令行输入:

curl http://localhost:8080 -H “X-Request-Id:666666”

则返回页面代码证明匹配成功。将参数-H “X-Request-Id:666666”改为-H “X-Request-Id:neo”再次执行时返回 404 证明没有匹配。

3. 通过 Host 匹配

Host Route Predicate 接收一组参数，一组匹配的域名列表，这个模板是一个 ant 分隔的模板，用.号作为分隔符。它通过参数中的主机地址作为匹配规则。

  1. spring:
  2.   cloud:
  3.     gateway:
  4.       routes:
  5.       - id: host_route
  6.         uri: http://ityouknow.com
  7.         predicates:
  8.         - Host=**.ityouknow.com

使用 curl 测试，命令行输入:

curl http://localhost:8080 -H “Host: www.ityouknow.com”
curl http://localhost:8080 -H “Host: md.ityouknow.com”

经测试以上两种 host 均可匹配到 host_route 路由，去掉 host 参数则会报 404 错误。

4. 通过请求方式匹配

可以通过是 POST、GET、PUT、DELETE 等不同的请求方式来进行路由。

  1. spring:
  2.   cloud:
  3.     gateway:
  4.       routes:
  5.       - id: method_route
  6.         uri: http://ityouknow.com
  7.         predicates:
  8.         - Method=GET

使用 curl 测试，命令行输入:

# curl 默认是以 GET 的方式去请求
curl http://localhost:8080

测试返回页面代码，证明匹配到路由，我们再以 POST 的方式请求测试。

# curl 默认是以 GET 的方式去请求
curl -X POST http://localhost:8080

返回 404 没有找到，证明没有匹配上路由

5. 通过请求路径匹配

Path Route Predicate 接收一个匹配路径的参数来判断是否走路由。

  1. spring:
  2.   cloud:
  3.     gateway:
  4.       routes:
  5.       - id: host_route
  6.         uri: http://ityouknow.com
  7.         predicates:
  8.         - Path=/foo/{segment}

如果请求路径符合要求，则此路由将匹配，例如：/foo/1 或者 /foo/bar。

使用 curl 测试，命令行输入:

curl http://localhost:8080/foo/1
curl http://localhost:8080/foo/xx
curl http://localhost:8080/boo/xx

经过测试第一和第二条命令可以正常获取到页面返回值，最后一个命令报 404，证明路由是通过指定路由来匹配。

6. 通过请求参数匹配

Query Route Predicate 支持传入两个参数，一个是属性名一个为属性值，属性值可以是正则表达式。

  1. spring:
  2.   cloud:
  3.     gateway:
  4.       routes:
  5.       - id: query_route
  6.         uri: http://ityouknow.com
  7.         predicates:
  8.         - Query=smile

这样配置，只要请求中包含 smile 属性的参数即可匹配路由。

使用 curl 测试，命令行输入:

curl localhost:8080?smile=x&id=2

经过测试发现只要请求汇总带有 smile 参数即会匹配路由，不带 smile 参数则不会匹配。

还可以将 Query 的值以键值对的方式进行配置，这样在请求过来时会对属性值和正则进行匹配，匹配上才会走路由。

  1. spring:
  2.   cloud:
  3.     gateway:
  4.       routes:
  5.       - id: query_route
  6.         uri: http://ityouknow.com
  7.         predicates:
  8.         - Query=keep, pu.

这样只要当请求中包含 keep 属性并且参数值是以 pu 开头的长度为三位的字符串才会进行匹配和路由。

使用 curl 测试，命令行输入:

curl localhost:8080?keep=pub

测试可以返回页面代码，将 keep 的属性值改为 pubx 再次访问就会报 404, 证明路由需要匹配正则表达式才会进行路由。

7. 通过请求 ip 地址进行匹配

Predicate 也支持通过设置某个 ip 区间号段的请求才会路由，RemoteAddr Route Predicate 接受 cidr 符号 (IPv4 或 IPv6) 字符串的列表(最小大小为 1)，例如 192.168.0.1/16 (其中 192.168.0.1 是 IP 地址，16 是子网掩码)。

  1. spring:
  2.   cloud:
  3.     gateway:
  4.       routes:
  5.       - id: remoteaddr_route
  6.         uri: http://ityouknow.com
  7.         predicates:
  8.         - RemoteAddr=192.168.1.1/24

可以将此地址设置为本机的 ip 地址进行测试。

果请求的远程地址是 192.168.1.10，则此路由将匹配。

8.组合使用

上面为了演示各个 Predicate 的使用，我们是单个单个进行配置测试，其实可以将各种 Predicate 组合起来一起使用。

例如：

  1. spring:
  2.   cloud:
  3.     gateway:
  4.       routes:
  5.        - id: host_foo_path_headers_to_httpbin
  6.         uri: http://ityouknow.com
  7.         predicates:
  8.         - Host=**.foo.org
  9.         - Path=/headers
  10.         - Method=GET
  11.         - Header=X-Request-Id, \d+
  12.         - Query=foo, ba.
  13.         - Query=baz
  14.         - Cookie=chocolate, ch.p
  15.         - After=2018-01-20T06:06:06+08:00[Asia/Shanghai]

各种 Predicates 同时存在于同一个路由时，请求必须同时满足所有的条件才被这个路由匹配。

一个请求满足多个路由的谓词条件时，请求只会被首个成功匹配的路由转发

五. 注意

1. GateWay 中StripPrefix的作用

很多时候也会有这么一种请求，用户请求路径是/api/brand,而真实路径是/brand，这时候我们需要去掉/api才是真实路径，此时可以使用SttripPrefix功能来实现路径的过滤操作，如下配置：

StripPrefix网关过滤器工厂采用一个参数StripPrefix。 StripPrefix参数表示在将请求发送到下游之前从请求中剥离的路径个数。

  1. spring:
  2.   cloud:
  3.     gateway:
  4.       routes:
  5.       - id: api
  6.         uri: http://localhost:18081
  7.         predicates:
  8.         - Path=/api/brand
  9.         filters:
  10.         - StripPrefix=1

当通过网关向/api/brand发出请求时，对nameservice的请求将类似于http://localhost:18081/brand/

————————————————
版权声明：本文为CSDN博主「AlgoRain」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/rain\_web/article/details/102469745

发表评论

表情：
评论列表 （有 0 条评论，240人围观）

还没有评论，来说两句吧...

相关阅读

    相关 Gateway网关

    一、为什么需要网关（理论） 1.1、gateway和zuul技术的区别 二、搭建网关服务 分析这个localhost：10010/user/1 路径： 三、路由断言工厂

    蔚落蔚落/ 0 赞/ 215 阅读

    相关 GateWay 网关服务

    GateWay简介 ⽹关（翻译过来就叫做GateWay）：微服务架构中的重要组成部分。局域⽹中就有⽹关这个概念，局域⽹接收或者发送数据出去通过这个⽹关，⽐如⽤ Vmwar

    我不是女神ヾ我不是女神ヾ/ 0 赞/ 328 阅读

    相关 Gateway网关认证

    SpringCloud-Gateway网关组件 网关通常是在项目中为了简化前端调用逻辑，同时也简化内部服务之间调用的复杂度；具体作用就是转发服务，转发并接收所有内外部的客户

    谁践踏了优雅谁践踏了优雅/ 0 赞/ 345 阅读