devbox
秋刀鱼在做梦
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Spring cloud Gateway 详解及相关配置_配置gateway

作者：秋刀鱼在做梦 | 2024-07-15 20:47:24

赞

踩

配置gateway

发福利了，具体请前往官网说明！！！

官网：spring cloud gateway网关 (spring.io)

Spring Cloud Gateway 的核心功能：

断言（Predicate）：参照 Java8 的新特性Predicate，允许开发人员匹配 HTTP 请求中的任何内容，比如请求头或请求参数，最后根据匹配结果返回一个布尔值。
路由（route）：由ID、目标URI、断言集合和过滤器集合组成。如果聚合断言结果为真，则转发到该路由。
过滤器（filter）：可以在返回请求之前或之后修改请求和响应的内容。

1、路由 Route：

        Route 主要由 路由id、目标uri、断言集合和过滤器集合组成，那我们简单看看这些属性到底有什么作用。
（1）id：路由标识，要求唯一，名称任意（默认值 uuid，一般不用，需要自定义）
（2）uri：请求最终被转发到的目标地址
（3）order： 路由优先级，数字越小，优先级越高
（4）predicates：断言数组，即判断条件，如果返回值是boolean，则转发请求到 uri 属性指定的服务中
（5）filters：过滤器数组，在请求传递过程中，对请求做一些修改

2、断言 Predicate：

        Predicate 来自于 Java8 的接口。Predicate 接受一个输入参数，返回一个布尔值结果。该接口包含多种默认方法来将 Predicate 组合成其他复杂的逻辑（比如：与，或，非）。
        Predicate 可以用于接口请求参数校验、判断新老数据是否有变化需要进行更新操作。Spring Cloud Gateway 内置了许多 Predict，这些 Predict 的源码在 org.springframework.cloud.gateway.handler.predicate 包中，有兴趣可以阅读一下

3、过滤器 filter：

Gateway 过滤器的生命周期：
PRE：这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
POST：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的 HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。
Gateway 过滤器从作用范围可分为两种:
GatewayFilter：应用到单个路由或者一个分组的路由上（需要在配置文件中配置）
GlobalFilter：应用到所有的路由上（无需配置，全局生效）
（1）局部过滤器 GatewayFilter：
        Spring Cloud Gateway 中内置了许多的局部过滤器；局部过滤器需要在指定路由配置才能生效，默认是不生效的

（2）自定义局部过滤器：
        虽说内置的过滤器能够解决很多场景，但是难免还是有些特殊需求需要定制一个过滤器，下面就来介绍一下如何自定义局部过滤器。 

  (3) GlobalFilter 全局过滤器：
        全局过滤器应用全部路由上，无需开发者配置，Spring Cloud Gateway 也内置了一些全局过滤器。GlobalFilter 的功能其实和 GatewayFilter 是相同的，只是 GlobalFilter 的作用域是所有的路由配置，而不是绑定在指定的路由配置上。多个 GlobalFilter 可以通过 @Order 或者 getOrder() 方法指定执行顺序，order值越小，执行的优先级越高。
 注意，由于过滤器有 pre 和 post 两种类型，pre 类型过滤器如果 order 值越小，那么它就应该在pre过滤器链的顶层，post 类型过滤器如果 order 值越小，那么它就应该在 post 过滤器链的底层

   (4) 过滤器规则（Filter）

过滤规则实例说明
PrefixPath- PrefixPath=/app在请求路径前加上app
RewritePath- RewritePath=/test, /app/test访问localhost:9022/test,请求会转发到localhost:8001/app/test
SetPathSetPath=/app/{path}通过模板设置路径，转发的规则时会在路径前增加app，{path}表示原请求路径
RedirectTo重定向
RemoveRequestHeader去掉某个请求头信息

注：当配置多个filter时，优先定义的会被调用，剩余的filter将不会生效

4、Predicate 断言条件(转发规则)介绍

每一个Predicate的使用，你可以理解为：当满足这种条件后才会被转发，如果是多个，那就是都满足的情况下被转发。

Path 方式匹配转发

通过Path转发示例，我们讲解下上面的两种配置，分别是application.yml以及RouteLocator。

配置文件匹配地址转发

我们在application.yml配置文件内添加对应的路由配置，如下所示：

  1. spring:
  2.  
  3.   application:
  4.  
  5.     name: spring-cloud-gateway-sample
  7.   cloud:
  8.  
  9.     gateway:
  11.       routes:
  13.         - id: blog
  14.  
  15.           uri: http://blog.xx.com
  17.           predicates:
  19.             # 匹配路径转发
  21.             - Path=/api-boot-datasource-switch.html
  22.  
  23. # 端口号
  24.  
  25. server:
  26.  
  27.   port: 9090

**先来解释下route的组成部分：**

  • id：路由的ID
  • uri：匹配路由的转发地址
  • predicates：配置该路由的断言，通过PredicateDefinition类进行接收配置。

在上面的配置中，当访问http://localhost:9090/api-boot-datasource-switch.html时就会被自动转发到http://blog.xx.com/api-boot-datasource-switch.html，这里要注意完全匹配Path的值时才会进行路由转发。

访问效果如下所示：

spring-cloud-gateway-path-predicate.png

RouteLocator 匹配路径转发

在上面的配置中，如果使用RouteLocator方式该怎么进行配置呢？

如下所示：

  1. @Bean
  2.  
  3. public RouteLocator routeLocator(RouteLocatorBuilder builder) {
  4.  
  5.   return builder.routes()
  6.  
  7.     .route("blog", r -> 
  8.  
  9.            r.path("/api-boot-datasource-switch.html").uri("http://blog.xx.com"))
  10.  
  11.     .build();
  12.  
  13. }

Before 方式匹配转发

当部署有访问时间限制的接口时，我们可以通过Before Predicate来完成某一个时间点之前允许访问，过时后则不允许转发请求到具体的服务，配置如下所示：

  1. spring:
  2.  
  3.   cloud:
  4.  
  5.     gateway:
  6.  
  7.       routes:
  8.  
  9.         - id: blog
  10.  
  11.           uri: http://blog.xx.com
  12.  
  13.           predicates:
  14.  
  15.             - Before=2019-05-01T00:00:00+08:00[Asia/Shanghai]

在上面配置中，我们允许2019-05-01日凌晨之前通过路由转发到http://blog.xx.com，通过查看org.springframework.cloud.gateway.handler.predicate.BeforeRoutePredicateFactory源码我们发现，Spring Cloud Gateway的Before断言采用的ZonedDateTime进行匹配时间，这里要注意存在时区的问题，需要配置[Asia/Shanghai]作为中国时区。

After 方式匹配转发

After Predicate与Before配置使用一致，匹配某一个时间点之后允许路由转发，如下所示配置：

  1. spring:
  2.  
  3.   cloud:
  4.  
  5.     gateway:
  6.  
  7.       routes:
  8.  
  9.         - id: blog
  10.  
  11.           uri: http://blog.xx.com
  12.  
  13.           predicates:
  14.  
  15.             - After=2019-04-29T00:00:00+08:00[Asia/Shanghai]

在上面配置中允许2019-04-29凌晨之后进行转发到http://blog.xx.com。

Between 方式匹配转发

那如果是一个时间段内允许请求转发，通过Before、After组合配置也可以完成，不过Spring Cloud Gateway还是提供了Between方式，如下所示：

  1. spring:
  2.  
  3.   cloud:
  4.  
  5.     gateway:
  6.  
  7.       routes:
  8.  
  9.         - id: blog
  10.  
  11.           uri: http://blog.xx.com
  12.  
  13.           predicates:
  14.  
  15.             - Between=2019-04-29T00:00:00+08:00[Asia/Shanghai], 2019-05-01T00:00:00+08:00[Asia/Shanghai]

在上面配置中，允许在2019-04-29日凌晨后 & 2019-05-01凌晨之前请求转发到http://blog.xx.com。

Spring Cloud Gateway 还提供了根据Cookie值的方式匹配转发请求，如果请求中所携带的Cookie值与配置的Predicate匹配，那么就可以被允许转发到指定地址，如下所示：

  1. spring:
  2.  
  3.   cloud:
  4.  
  5.     gateway:
  7.       routes:
  9.         - id: blog
  10.  
  11.           uri: http://blog.xx.com
  13.           predicates:
  15.             - Cookie=hengboy, leo

在上面配置中，如果客户端发送请求时携带了"hengboy=leo"的Cookie信息，则允许请求转发。

**测试Cookie方式转发：**

curl http://localhost:9090 --cookie "hengboy=leo"

通过上面方式我们是可以成功转发请求的，如果我们修改Cookie的值，就会导致无法转发，出现404。

Header 方式匹配转发

Spring Cloud Gateway可以根据发送请求的Header信息进行匹配转发，加入我们可以根据X-Request-Id的值进行匹配，如下所示：

  1. spring:
  2.  
  3.   cloud:
  4.  
  5.     gateway:
  7.       routes:
  9.         - id: blog
  10.  
  11.           uri: http://blog.xx.com
  13.           predicates:
  15.             - Header=X-Request-Id, \d+

在上面配置中，如果X-Request-Id的值为数字，那么就可以转发到http://blog.xx.com，我们通过如下方式进行测试：

curl http://localhost:9090 -H "X-Request-Id:123456"

如果头信息为X-Request-Id:abc时，就会转发失败，出现404。

Host 方式匹配转发

Spring Cloud Gateway可以根据Host主机名进行匹配转发，如果我们的接口只允许\*\*.xx.com域名进行访问，那么配置如下所示：

  1. spring:
  2.  
  3.   cloud:
  4.  
  5.     gateway:
  7.       routes:
  9.         - id: blog
  10.  
  11.           uri: http://blog.xx.com
  13.           predicates:
  15.             - Host=\*\*.xx.com

测试如下所示：

  1.  1. curl http://localhost:9090 -H "Host: xx.com"          // 匹配
  2.  
  3.  2. curl http://localhost:9090 -H "Host: api.xx.com"        // 匹配
  4.  
  5.  3. curl http://localhost:9090 -H "Host: admin.xx.com"  // 匹配
  6.  
  7.  3. curl http://localhost:9090 -H "Host: hengboy.com"          // 不匹配

请求方式 方式匹配转发

Rest请求风格的接口内往往会存在多种请求方式的接口，如果我们的接口只允许POST请求访问，那么配置如下所示：

  1. spring:
  2.  
  3.   cloud:
  4.  
  5.     gateway:
  7.       routes:
  9.         - id: blog
  10.  
  11.           uri: http://blog.xx.com
  13.           predicates:
  15.             - Method=POST

发送GET请求测试：

  1. ~ curl http://localhost:9090
  2.  
  3. {"timestamp":"2019-04-29T06:27:41.121+0000","path":"/","status":404,"error":"Not Found","message":null}

我们的请求并未被Spring Cloud Gateway进行转发，那么我们再来通过POST请求进行测试：

curl -X POST http://localhost:9090

是可以被转发到目标地址uri的，不过我的这个博客是OSS部署的，阿里云限制了POST访问，尽管如此我们也证明了可以转发。

请求参数 方式匹配转发

Spring Cloud GateWay还支持根据指定的参数进行匹配，Query方式的Predicate也有两种方式匹配情况，如下所示：

  • 请求中存在xxx参数
  1.    cloud:
  2.     gateway:
  3.       routes:
  4.         - id: blog
  5.           uri: http://blog.xx.com
  6.           predicates:
  7.            - Query=xxx

我们通过curl http://localhost:9090\?xxx\=123是可以被成功转发的，只要参数存在xxx就会被成功转发，否则出现404转发失败。

  • 请求中存在xxx参数且值为zzz
  1.     cloud:
  2.        gateway:
  3.           routes:
  4.             - id: blog
  5.              uri: http://blog.xx.com
  6.              predicates:
  7.                 - Query=xxx, zzz

根据上面配置，我们限定了参数xxx必须为zzz时才会被成功转发，否则同样会出现404抓发失败。

请求路径 方式匹配转发

Spring Cloud Gateway提供了请求路径变量方式匹配转发，如下所示：

  1. spring:
  2.  
  3.   cloud:
  4.  
  5.     gateway:
  6.  
  7.       routes:
  8.  
  9.         - id: blog
  10.  
  11.           uri: http://blog.xx.com
  12.  
  13.           predicates:
  14.  
  15.             - Path=/article/{articleId}

在上面配置中{articleId}是一个路径变量，可以是任意值，匹配/article/1、/article/abc等，测试如下所示：

  1. ~ curl http://localhost:9090/article/1            // 匹配
  2.  
  3. ~ curl http://localhost:9090/article/abc        // 匹配
  4.  
  5. ~ curl http://localhost:9090/article/1/1        // 不匹配

请求IP 方式匹配转发

Spring Cloud Gateway可以限制允许访问接口的客户端IP地址，配置后只对指定IP地址的客户端进行请求转发，配置如下所示：

  1. spring:
  2.  
  3.   cloud:
  4.  
  5.     gateway:
  6.  
  7.       routes:
  8.  
  9.         - id: blog
  10.  
  11.           uri: http://blog.xx.com
  12.  
  13.           predicates:
  14.  
  15.             - RemoteAddr=192.168.1.56/24

在上面我们配置了192.168.1.56/24，其中192.168.1.56是客户端的IP地址，而24则是子网掩码。

组合示例

相同的Predicate也可以配置多个，请求的转发是必须满足所有的Predicate后才可以进行路由转发，组合使用示例如下所示：

  1. spring:
  2.  
  3.   cloud:
  4.  
  5.     gateway:
  6.  
  7.       routes:
  8.  
  9.         - id: blog
  10.  
  11.           uri: http://blog.xx.com
  12.  
  13.           predicates:
  14.  
  15.             - Query=author, hengboy
  16.  
  17.             - Query=leo
  18.  
  19.             - Method=GET
  20.  
  21.             - Cookie=hengboy, leo
  22.  
  23.             - Header=X-Request-Id, \d+
  24.  
  25.             - RemoteAddr=192.168.1.56/24

总结

本章节讲解了Spring Cloud Gateway的相关谓词、断言基本使用方式，GateWay内部提供了很多种灵活的路由转发规则，在同一个路由内存在多个Predicate时，同时满足规则后请求才会被路由转发。

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/秋刀鱼在做梦/article/detail/830920
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号