Gateway内置断言(Predicate)类型的 yaml 和 json 数据格式

已于 2023-01-24 10:32:16 修改
阅读量1.7k 收藏 5
点赞数
分类专栏： spring cloud gateway springcloud 文章标签： gateway java spring
于 2023-01-20 16:56:29 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fly_sky23/article/details/128742498
版权

Gateway 内置 Predicate 格式配置

概述

本文针对 Spring Cloud Gateway 框架中断言（Predicate）类型在 Yaml 文件和以 JSON 数据格式中的配置进行整理。其中 JSON 格式数据类型在动态路由时需使用到，如动态读取数据库中保存的 JSON 格式的路由数据。

类型

Path

  • Path表示请求路径正则匹配
  • Yaml配置文件
spring:  
  cloud:  
    gateway:  
      routes:  
      - id: path_route  
        uri: http://127.0.0.1:8080  
        predicates:  
        - Path=/server-a/**,/server-b/**
  • 动态路由的JSON格式
{  
    "id": "path_route",  
    "uri": "http://127.0.0.1:8082",  
    "predicates":[  
        {  
            "name": "Path",  
            "args": {   
                "_genkey_0": "/server-a/**",  
                "_genkey_1": "/server-b/**"  
            }  
        }  
    ]  
}

tips：其中args中值对应的key，即_genkey_0可以任意定义值，查看源码读取该配置可知，源码通过args.values()获取配置的所有值，所以此处key的命名可任意命名。

Method

  • Method表示匹配指定的请求方式
  • Yaml配置文件
spring:  
  cloud:  
    gateway:  
      routes:  
      - id: method_route  
        uri: http://127.0.0.1:8082  
        predicates:  
        - Method=GET,POST
  • 动态路由的JSON格式
{  
    "id": "method_route",  
    "uri": "http://127.0.0.1:8082",  
    "predicates":[  
        {  
            "name": "Method",  
            "args": {   
                "_genkey_0": "GET",  
                "_genkey_1": "POST"
        }  
    ]  
}

tips：此类型args中的key同Path类型一样，可任意命名。

After

  • After表示路由在指定时间之后生效
  • Yaml配置文件
spring:  
  cloud:  
    gateway:  
      routes:  
      - id: after_route  
        uri: http://127.0.0.1:8082  
        predicates:
        - After=2021-08-16T07:36:00.000+08:00[Asia/Shanghai]
  • 动态路由的JSON格式
{  
    "id": "after_route",  
    "uri": "http://127.0.0.1:8082",  
    "predicates":[  
        {  
            "name": "After",  
            "args": {  
                "datetime": "2021-08-16T07:36:00.000+08:00[Asia/Shanghai]"  
            }  
        }  
    ]  
}

tips：After类型中，args对应值的key只能为datetime，此处可在源码AfterRouterPredicateFactory类中找到。

Before

  • Before表示路由在指定时间之前有效
  • Yaml配置文件
spring:  
  cloud:  
    gateway:  
      routes:  
      - id: before_route  
        uri: http://127.0.0.1:8080  
        predicates:  
        - Before=2021-08-16T07:36:00.000+08:00[Asia/Shanghai]
  • 动态路由的JSON格式
{  
    "id": "before_route",  
    "uri": "http://127.0.0.1:8082",  
    "predicates":[  
        {  
            "name": "Before",  
            "args": {  
                "datetime": "2021-08-16T07:36:00.000+08:00[Asia/Shanghai]"  
            }  
        }  
    ]  
}

tips：Before类型中，args对应值的key只能为datetime，此处可在源码BeforeRouterPredicateFactory类中找到。

Between

  • Between表示路由在指定时间之间有效
  • Yaml配置文件
spring:  
  application:  
    name: hello-gateway  
  cloud:  
    gateway:  
      routes:  
        - id: between_route  
          uri: http://127.0.0.1:8082  
          predicates:  
            - Between=2021-08-16T07:36:00.000+08:00[Asia/Shanghai], 2021-08-16T08:15:00.000+08:00[Asia/Shanghai]
  • 动态路由的JSON格式
{  
    "id": "path_route_addr",  
    "uri": "http://127.0.0.1:8082",  
    "predicates":[  
        {  
            "name": "Between",  
            "args": {  
                "datetime1": "2021-08-16T07:36:00.000+08:00[Asia/Shanghai]",  
                "datetime2": "2021-08-16T08:18:00.000+08:00[Asia/Shanghai]"  
            }  
        }  
    ]  
}

tips：Between类型中，args对应值的key只能为datetime1和datetime2，此处可在源码BetweenRouterPredicateFactory类中找到。

Cookie

  • Cookie表示cookie中存在指定名称，并且对应的值符合指定正则表达式，才算匹配成功
  • Yaml配置文件
spring:  
  cloud:  
    gateway:  
      routes:  
      - id: cookie_route  
        uri: https://127.0.0.1:8080
        predicates:  
        - Cookie=session, fly
  • 动态路由的JSON格式
{  
    "id": "cookie_route",  
    "uri": "http://127.0.0.1:8082",  
    "predicates":[  
        {  
            "name": "Cookie",  
            "args": {  
             "name": "session",  
                "regexp": "fly"  
            }  
        }  
    ]  
}

Header

  • Header表示header中存在指定名称，并且对应的值符合指定正则表达式，才算匹配成功
  • Yaml配置文件
spring:  
  cloud:  
    gateway:  
      routes:  
      - id: header_route  
        uri: https://example.org  
        predicates:  
        - Header=X-Request-Id, \d+
  • 动态路由的JSON格式
{  
    "id": "header_route",  
    "uri": "http://127.0.0.1:8082",  
    "predicates":[  
        {  
            "name": "Header",  
            "args": {  
                "header": "X-Request-Id",  
                "regexp": "\\d+"  
            }  
        }  
    ]  
}

Host

  • Host表示请求的host要和指定的字符串匹配，并且对应的值符合指定正则表达式，才算匹配成功，可以同时指定多个host匹配表达式，下面的例子给了两个，其中第一个指定了端口：
  • Yaml配置文件
spring:  
  cloud:  
    gateway:  
      routes:  
      - id: host_route  
        uri: http://127.0.0.1:8082  
        predicates:  
        - Host=localhost:8080,localhost:8081
  • 动态路由的JSON格式
{  
    "id": "header_route",  
    "uri": "http://127.0.0.1:8080",  
    "predicates":[  
        {  
            "name": "Host",  
            "args": {  
                "_genkey_0": "localhost:8080",
                "_genkey_0": "localhost:8081"
            }  
        }  
    ]  
}

Query

  • Query表示在请求中要带有指定的参数，且该参数的值需等于配置的值或匹配正则表达式，才算匹配成功
  • Yaml配置文件
spring:  
  cloud:  
    gateway:  
      routes:
      - id: query_route  
        uri: http://127.0.0.1:8080 
        predicates:  
        - Query=name, fly
  • 动态路由的JSON格式
{  
    "id": "query_route",  
    "uri": "http://127.0.0.1:8082",  
    "predicates":[  
        {  
            "name": "Query",  
            "args": {   
                "param": "name",  
                "regexp": "fly"  
            }  
        }  
    ]  
}

RemoteAddr

  • RemoteAddr表示匹配指定来源的请求
  • Yaml配置文件
spring:  
  cloud:  
    gateway:  
      routes:  
      - id: remoteaddr_route  
        uri: http://127.0.0.1:8080
        predicates:  
        - RemoteAddr=192.168.0.1
```.
- 动态路由的`JSON`格式
```json
{  
    "id": "remoteaddr_route",  
    "uri": "http://127.0.0.1:8080",  
    "predicates":[  
        {  
            "name": "RemoteAddr",  
            "args": {   
                "_genkey_0": "192.168.0.1"  
            }  
        }  
    ]  
}

Weight

  • Weight表示按照权重将请求分发到不同的位置
  • Yaml配置文件
spring:  
  cloud:  
    gateway:  
      routes:  
      - id: weight_high  
        uri: http://127.0.0.1:8080  
        predicates:  
        - Weight=group1, 8
  • 动态路由的JSON格式
{  
    "id": "remoteaddr_route",  
    "uri": "http://127.0.0.1:8080",  
    "predicates":[  
        {  
            "name": "Weight",  
            "args": {   
                "weight.group": "group1",  
                "weight.weight":"8"  
            }
        }  
    ]  
}

总结

综上所述，只有四种类型的args值的key可任意命名，分别为Path、Method、Host、RemoteAddr四种类型，其余类型的key命名固定。

以上即是 gateway 网关断言所有类型的 yaml 和 json 格式数据格式，希望对有需要的小伙伴有所帮助。

爱打斯诺克的码农飞
关注
  • 0
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Spring Cloud Gateway实战之四：内置predicate小结，java进阶教程视频
m0_54865014的博客
12-20 374
spring: cloud: gateway: routes: id: after_route uri: http://127.0.0.1:8082 predicates: After=2021-08-16T07:36:00.000+08:00[Asia/Shanghai] 动态路由的JSON格式，注意args参数要用datetime： [ { “id”: “after_route”, “uri”: “http://127.0.0.1:8082”, “predicates”:[ { “name”
网关（Gateway）- 内置断言工厂
最新发布
问天丶天问
05-30 1132
网关（Gateway）内置断言工厂保姆级说明教程
Gateway动态路由配置——Nacos
lovexinxin_的博客
10-04 5759
Gateway-Nacos动态更新路由配置
springcloudalibaba架构(14):Gateway内置路由断言
不积跬步，无以至千里
08-11 454
Predicate 断言，用于进行条件判断，只有断言都为真，才会真正的执行路由。SpringCloud Gateway包括许多内置的断言工厂，所有这些断言都与HTTTP请求的不同属性匹配。基于Datetime类型的断言工厂此类的断言根据时间来做判断，主要有三个AfterRoutePredicateFactory: 接收一个日期参数，判断请求日期是否晚于指定日期BeforeRoutePredicateFactory: 接收一个日期参数，判断请求日期是否早于指定日期。...
微服务04（网关gateway）
Rabir-YellowDavid的博客
08-27 510
1、gateway简介 Spring Cloud Gateway是Spring公司基于Spring 5.0，Spring Boot 2.0 和 Project Reactor 等术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。它的目标是替代 Netflflix Zuul，其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控和限流。 优点： 性能强劲：是第一代网关Zuul的1.6倍 功能强大：内置了很多实用的功能，例如转发、监控、
微服务学习之网关(Gateway)断言和过滤器
qq_19283249的博客
08-29 1291
在微服务学习之网关(Gateway)的搭建及使用中介绍了Gateway内置的断言处理和过滤器，但是并不能满足我们负责的业务逻辑使用，所以我们需要自定义 Prediate 和 Filter。
Gateway网关动态路由配置（YAML格式 + JSON格式）
qq_45515182的博客
09-23 3383
在我们开发微服务系统时，Gateway是必不可少的一个组件，我们可以通过Gateway来转发用户进行的请求，这样就可以隐藏具体系统的信息。YAMLroutes其中第二种和第三种都可以结合Nacos实现动态路由，主要看开发者怎么选择。第二种就是结合Nacos的配置中心，将routes参数下的数据放入到nacos中，我这里使用第三种进行展示，用JSON的格式配置路由信息。
C#中的委托数据类型简介
09-02
在C#中，委托是一种自定义的数据类型，它定义了一个方法签名，即一组输入参数和一个返回类型。通过定义委托，我们可以创建一个对象，该对象可以存储指向符合该签名的方法的引用。委托是多播的，意味着它可以同时引用...
Java 8 的 Consumer、Supplier、Predicate和Function理解
10-11
其中，四个关键的接口——Consumer、Supplier、Predicate和Function，是Lambda表达式的重要组成部分，帮助开发者处理各种操作，尤其是处理集合数据时。下面将详细讲解这四个接口及其在实际开发中的应用。 1. **...
springcloud gateway
07-24
- **Predicate（断言）**：用于判断请求是否符合路由规则。例如，可以根据请求路径、主机、方法等进行匹配。 - **Filter（过滤器）**：在请求转发前后执行的操作，用于添加额外的头部信息、限流、熔断、认证等。 #...
7.Gateway服务网关
01-01
2. Predicate（断言）：指的是 Java 8 的 Function Predicate，输入类型是 Spring 框架中的 ServerWebExchange 3. Filter（过滤器）：指的是 Spring 框架中 GatewayFilter 的实例，使用过滤器，可以在请求被路由前后...
最新Spring Cloud Gateway 官方参考指南-中文版-3.x
08-16
在配置路由断言工厂（Route Predicate Factories）和网关过滤器工厂（Gateway Filter Factories）时，可以使用简写或完全展开的方式。例如，在`application.yml`中，可以定义路由及其断言和过滤器，以控制请求如何被...
Spring Cloud Gateway内置的断言和过滤器作用
MCN的博客
05-25 961
对应解版本3.1.7对应SpringCloud版本2021.0.7
SpringCloud Gateway架构流程 和 内置的路由断言介绍
小哇
01-28 357
讲解SpringCloud Gateway架构流程 路由：是网关的基本单元，由ID、URI、一组Predicate、一组Filter组成，根据Predicate进行匹配转发 route组成部分 id：路由的ID uri：匹配路由的转发地址 predicates：配置该路由的断言，通过PredicateDefinition类进行接收配置。 order：路由的优先级，数字越小，优先级越高。 交互流程 客户端向Spring Cloud Gateway发出请求 如果网关处理程序映射
[spring cloud gateway]yml中predicate 和filter的两种配置方式
无bug无江湖
07-09 482
yml中predicate 和filter的两种配置方式
Gateway断言功能详解
Jerry的博客
12-31 5895
1. Predicate机制 Predicate是Java8中引入的一个新功能，和我们平时写单元测试的时候Assertion差不多，Predicate是接收一个判断条件，返回一个ture或false的布尔值结果，告知调用发判断结果。也可以通过and、or和negative(非)三个操作符多个Predicate串联在一块共同判断 Predicate其实就是我们和Gateway对接的数据暗号，比如要求你的Request中必须带有某个指定的参数叫name，对应的值必须是一个指定的人名（Gavin），如果Reque
Gateway网关过滤器GlobalFilter返回前端JSON数据
qq_43294932的博客
05-05 3296
废话不多说,直接上干货 文章主旨： 将GlobalFilter拦截下来的请求,进行校验,并封装错误信息然后返回前端JSON 正文 先看该篇文章的示例接口: package cn.itcast.gateway; import com.alibaba.fastjson.JSON; import org.springframework.cloud.gateway.filter.GatewayFilterChain; import org.springframework.cloud...
Spring Cloud GateWay 之 Predicate与Filter
m0_67394360的博客
08-30 508
项目现状，一共三个微服务，注册中心（registry），服务提供者（provider），网关（gateway）。provider提供两个接口/hi，/hello。GitHub地址全局过滤器，实现接口GlobalFilter, Ordered ，并重写Mono()，getOrder()方法，注入IOC容器@Component@Slf4j@Overridelog.info(“这里是全局过滤器”);}}...
SpringCloud Gateway读取Request Body
古甲哈醒的专栏
06-09 3363
我们使用SpringCloud Gateway做微服务网关的时候，经常需要在过滤器Filter中读取到Post请求中的Body内容进行日志记录、签名验证、权限验证等操作。我们知道，Request的Body是只能读取一次的，如果直接通过在Filter中读取，而不封装回去回导致后面的服务无法读取数据。 SpringCloud Gateway 内部提供了一个断言工厂类ReadBodyPredicateFactory，这个类实现了读取Request的Body内容并放入缓存，我们可以通过从缓存中获取body内容来实现
gateway中 predicate和uri什么关系
05-25
在Spring Cloud Gateway中，路由的定义是通过一组谓词（Predicate）和一组过滤器（Filter）来完成的。Predicate用于匹配请求的URI、路径、查询参数等信息，如果请求匹配了URI，就会将请求路由到相应的URI上。而URI（Uniform Resource Identifier）是统一资源标识符，它是用来标识某一互联网资源名称的字符串。 因此，Predicate和URI之间的关系是，Predicate通过匹配请求的URI来确定是否需要将请求路由到相应的URI上。通常情况下，Predicate会根据请求的URI、路径、查询参数等信息进行匹配，如果匹配成功，则会将请求路由到相应的URI上。在Spring Cloud Gateway中，Predicate和URI是紧密相关的概念，它们共同构成了一个完整的路由规则。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

爱打斯诺克的码农飞

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值