Spring Cloud Gateway高级特性之断言(Hoxton版本)

最新推荐文章于 2024-06-07 11:18:21 发布
最新推荐文章于 2024-06-07 11:18:21 发布
阅读量1.2k 收藏
点赞数
分类专栏： Spring Cloud 文章标签： gateway spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/tuyong1972873004/article/details/107123238
版权

1.高级特性—断言(Predicate)

Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。 Spring Cloud Gateway包括许多内置的Route Predicate工厂。 所有这些Predicate都与HTTP请求的不同属性匹配。 多个Route Predicate工厂可以进行组合。
  Spring Cloud Gateway内置了许多Predict,这些Predict的源码在org.springframework.cloud.gateway.handler.predicate包中，如果读者有兴趣可以阅读一下。现在列举各种Predicate如下图：

具体UML类图如下图:

下面我们来介绍下一些常用的Route Predicate。

注意：Predicate中提到的配置都在application-predicate.yml文件中进行修改，并用该配置启动Spring Cloud Gateway服务。

1.1 After Route Predicate

在指定时间之后的请求会匹配该路由。

spring:
  cloud:
    gateway:
      routes:
        - id: eureka-client-provider #路由的ID
          uri: lb://eureka-client-provider
          predicates:
            - Path=/provider/** # 路由规则
            # 当且仅当请求时的时间After配置的时间时，才会转发到用户微服务
            # 目前配置不会进该路由配置，所以返回404
            # 将时间改成 < now的时间，则访问http://localhost:9100/** -> eureka-client-provider/**
            # eg. 访问http://localhost:9100/provider/demo/hello-> eureka-client-provider/demo/hello
            - After=2020-07-01T23:33:00.000+08:00[Asia/Shanghai]
          filters:
            - StripPrefix=1

1.2 Before Route Predicate

在指定时间之前的请求会匹配该路由。

spring:
  cloud:
    gateway:
      routes:
        - id: eureka-client-provider #路由的ID
          uri: lb://eureka-client-provider
          predicates:
            - Path=/provider/** # 路由规则
            # 当且仅当请求时的时间Before配置的时间时，才会转发到用户微服务
            # 目前配置不会进该路由配置，所以返回404
            # 将时间改成 > now的时间，则访问http://localhost:9100/** -> eureka-client-provider/**
            # 访问http://localhost:9100/provider/demo/hello -> eureka-client-provider/demo/hello
            - Before=2021-07-01T23:33:00.000+08:00[Asia/Shanghai]
          filters:
            - StripPrefix=1

1.3 Between Route Predicate

在指定时间区间内的请求会匹配该路由。

spring:
  cloud:
    gateway:
      routes:
        - id: eureka-client-provider #路由的ID
          uri: lb://eureka-client-provider
          predicates:
            - Path=/provider/** # 路由规则
            # 当且仅当请求时的时间Between配置的时间时，才会转发到用户微服务
            # 因此，访问http://localhost:9100/** -> eureka-client-provider/**
            # 访问http://localhost:9100/provider/demo/hello -> eureka-client-provider/demo/hello
            - Between=2020-07-01T13:30:00+08:00[Asia/Shanghai], 2020-07-02T18:30:00+08:00[Asia/Shanghai]
          filters:
            - StripPrefix=1

1.4 Cookie Route Predicate

带有指定Cookie的请求会匹配该路由。

spring:
  cloud:
    gateway:
      routes:
        - id: eureka-client-provider #路由的ID
          uri: lb://eureka-client-provider
          predicates:
            - Path=/provider/** # 路由规则
            # 当且仅当带有名为somecookie，并且值符合正则ch.p的Cookie时，才会转发到用户微服务
            # 如Cookie满足条件，则访问http://localhost:9100/** -> eureka-client-provider/**
            # 访问http://localhost:9100/provider/demo/hello -> eureka-client-provider/demo/hello
            - Cookie=username,tom
          filters:
            - StripPrefix=1

使用curl工具测试如下，只有cookie为 username=tom 的请求可以匹配该路由。

1.5 Header Route Predicate

带有指定请求头的请求会匹配该路由。

spring:
  cloud:
    gateway:
      routes:
        - id: eureka-client-provider #路由的ID
          uri: lb://eureka-client-provider
          predicates:
            - Path=/provider/** # 路由规则
            # 当且仅当带有名为X-Request-Id，并且值符合正则\d+的Header时，才会转发到用户微服务
            # 如Header满足条件，则访问http://localhost:9100/** -> eureka-client-provider/**
            # 访问http://localhost:9100/provider/demo/hello -> eureka-client-provider/demo/hello
            - Header=X-Request-Id, \d+
          filters:
            - StripPrefix=1

使用curl工具测试如下，只有名为X-Request-Id，并且值符合正则\d+的Header时可以匹配该路由。

1.6 Host Route Predicate

带有指定Host的请求会匹配该路由

spring:
  cloud:
    gateway:
      routes:
        - id: eureka-client-provider #路由的ID
          uri: lb://eureka-client-provider
          predicates:
            - Path=/provider/** # 路由规则
            # 当且仅当名为Host的Header符合**.hxmec.com或者**.heisea.cn时，才会转发用户微服务
            # 如Host满足条件，则访问http://localhost:9100/** -> eureka-client-provider/**
            # http://localhost:9100/provider/demo/hello -> eureka-client-provider/demo/hello
            - Host=**.hxmec.com,**.heisea.cn
          filters:
            - StripPrefix=1

使用curl工具测试如下，只有带有请求头名为Host的Header符合**.hxmec.com或者**.heisea.cn时请求可以匹配该路由。

1.7 Method Route Predicate

发送指定方法的请求会匹配该路由。

spring:
  cloud:
    gateway:
      routes:
        - id: eureka-client-provider #路由的ID
          uri: lb://eureka-client-provider
          predicates:
            - Path=/provider/** # 路由规则
            # 当且仅当HTTP请求方法是GET时，才会转发用户微服务
            # 如请求方法满足条件，则访问http://localhost:9100/** -> eureka-client-provider/**
            # 访问http://localhost:9100/provider/demo/hello -> eureka-client-provider/demo/hello
            - Method=GET
          filters:
            - StripPrefix=1

使用curl测试如下，只有HTTP请求方法是GET时请求可以匹配该路由。

1.8 Path Route Predicate

发送指定路径的请求会匹配该路由。

spring:
  cloud:
    gateway:
      routes:
        - id: eureka-client-provider #路由的ID
          uri: lb://eureka-client-provider
          predicates:
            - Path=/provider/** # 路由规则

使用curl测试如下，只有访问路径为/provider/xxx 时请求可以匹配该路由。

1.9 Query Route Predicate

带指定查询参数的请求可以匹配该路由

spring:
  cloud:
    gateway:
      routes:
        - id: eureka-client-provider #路由的ID
          uri: lb://eureka-client-provider
          predicates:
            - Path=/provider/** # 路由规则
            # 当且仅当请求带有name的参数，才会转发到用户微服务
            # 访问http://localhost:9100/provider/demo/feign?name=xx -> eureka-client-provider的/demo/feign
            - Query=name
          filters:
            - StripPrefix=1

使用curl测试,只有带 name=xxx 查询参数的请求可以匹配该路由。

1.10 RemoteAddr Route Predicate

从指定远程地址发起的请求可以匹配该路由。

spring:
  cloud:
    gateway:
      routes:
        - id: eureka-client-provider #路由的ID
          uri: lb://eureka-client-provider
          predicates:
            - Path=/provider/** # 路由规则
            # 当且仅当请求IP是192.168.29.1/24网段，例如192.168.29.188，才会转发到用户微服务
            # 问http://localhost:9100/provider/demo/hello -> eureka-client-provider/demo/hello
            - RemoteAddr=192.168.29.1/24
          filters:
            - StripPrefix=1

使用curl测试,只有请求IP在192.168.29.1/24网段会转发到用户微服务

1.11 Weight Route Predicate

使用权重来路由相应请求

spring:
  cloud:
    gateway:
      routes:
      - id: weight_high
        uri: https://weighthigh.org
        predicates:
        - Weight=group1, 8
      - id: weight_low
        uri: https://weightlow.org
        predicates:
        - Weight=group1, 2

这个路由规则表示有80%的请求会被路由到weighthigh.org，20%会被路由到weighlow.org。

1.12 ReadBody Route Predicate

基于请求体内容的断言工厂
将body中的内容读取到exchange对象中，使用exchange.getAttribute(“cachedRequestBodyObject”)获取

spring:
  cloud:
    gateway:
      routes:
        - id: eureka-client-provider #路由的ID
          uri: lb://eureka-client-provider
          predicates:
            - Path=/provider/** # 路由规则
            - name: ReadBodyPredicateFactory #读取body断言
              args:
                inClass: "#{T(String)}" #body数据类型
                predicate: "#{@testRequestBody}" #自定义断言处理器
          filters:
            - StripPrefix=1

@Component
public class TestRequestBody implements Predicate {
 
    /**
     * 根据内容判断是否匹配该路由
     * @param o body的内容
     * @return ture-匹配成功，false-匹配失败
     */
    @Override
    public boolean test(Object o) {
        //可以对body内容进行判断处理
        //这里不做处理直接返回成功
        return true;
    }
}

2.参考文档

  • 【官方文档】https://cloud.spring.io/spring-cloud-gateway/2.2.x/reference/html/#the-weight-route-predicate-factory
Trazen
关注
专栏目录
19、Gateway 路由断言
weixin_40968009的博客
10-27 874
Gateway 路由断言有11种方式。
SpringCloud组件之网关Spring Cloud Gateway(Hoxton版本)
Trazen的专栏
07-04 6466
1.Spring Cloud Gateway简介 Spring Cloud Gateway 为 SpringBoot 应用提供了API网关支持，具有强大的智能路由与过滤器功能，本文将对其用法进行详细介绍。   Spring Cloud Gateway是SpringCloud新推出的网关框架，比较于上一代Zuul，功能和性能有很大的提升。Zuul1.x采用的是阻塞多线程方式，也就是一个线程处理一个连接请求，高并发情况下性能较差，即使是Zuul2.x虽然做到了非阻塞，但是面对连续跳票，看起来Zuul要被抛弃了
spring-cloud（十一）GateWay强大的路由谓词（断言）功能
胖虎儿的博客
10-15 8067
GateWay强大的路由谓词（断言）功能
SpringCloud Gateway Predicate断言
lishuzhen5678的博客
12-26 577
Predicate（断言；谓词）用于进行条件判断，是由断言返回都返回TRUE，才会真正执行路由 SpringCloudGateway 包括许多内置的断言工厂，所有这些断言都与HTTP请求的不同属性匹配。 ...
gateway的断言
qq_63431773的博客
04-07 568
在计算机网络中，网关（Gateway）通常指的是一个网络节点，它充当了连接不同网络的中间节点，负责将数据从一个网络传输到另一个网络。在软件开发中，特别是在微服务架构中，网关（Gateway）通常指的是API网关（API Gateway），它是系统的入口点，负责接收客户端请求并将请求转发到适当的服务。API网关通常具有各种功能，其中包括断言（Assertion），断言是用于检查请求的条件，以确定是否应该执行特定操作的机制。在API网关中，断言通常用于路由请求、执行安全检查、校验请求头或参数等。
Spring Cloud Gateway断言及过滤器使用
weixin_49561506的博客
01-31 1312
Spring Cloud Gateway断言及过滤器使用
Spring Cloud入门-Gateway服务网关(Hoxton版本)
2401_84003941的博客
04-18 1961
在这个部分总结了2019年到目前为止Java常见面试问题，取其面试核心编写成这份文档笔记，从中分析面试官的心理，摸清面试官的“套路”，可以说搞定90%以上的Java中高级面试没一点难度。本节总结的内容涵盖了：消息队列、Redis缓存、分库分表、读写分离、设计高并发系统、分布式系统、高可用系统、SpringCloud微服务架构等一系列互联网主流高级技术的知识点。（上述只是一个整体目录大纲，每个点里面都有如下所示的详细内容，从面试问题——分析面试官心理——剖析面试题——完美解答的一个过程）
Spring Cloud | Nacos + Spring Cloud Gateway整合示例
Q54665642ljf的博客
07-31 462
本篇文章使用一个简单的示例来演示SpringCloudGateway的使用方法。
Spring Cloud入门-Gateway服务网关(Hoxton版本)，linux教程入门教程PDF
m0_64867220的博客
12-14 800
这里我们创建一个api-gateway模块来演示Gateway的常用功能。 在pom.xml中添加相关依赖 org.springframework.cloud spring-cloud-starter-gateway 两种不同的配置路由方式 Gateway 提供了两种不同的方式用于配置路由，一种是通过yml文件来配置，另一种是通过Java Bean来配置，下面我们分别介绍下。 使用yml配置 在application.yml中进行配置： server: port: 9201 service-ur.
Nacos集成spring cloud gateway
wuniangzhanyan的博客
01-27 874
今天使用Nacos集成spring cloud gateway，记录一下 最开始我创建了一个module ：cloud-gateway，并且在pom文件里配置这样（部分代码截取）： <parent> <groupId>com.example</groupId> <artifactId>demo</artifactId> <version>1.0.0</version>
Spring Cloud 学习笔记七：搭建微服务工程之Gateway 的常用路由断言工厂
Stary 的 IT 之旅
03-08 343
目录 Gateway 的常用路由断言工厂 Path 路由断言工厂 Query 路由断言工厂 Method 路由断言工厂 Header 路由断言工厂 自定义路由断言工厂 Gateway 的常用路由断言工厂 Spring Cloud Gateway 内置了许多路由断言工厂，可以通过配置的方式直接使用，也可以组合使用多个路由断言工厂。接下来为大家介绍几个常用的路由断言工厂类。 Path 路由断言工厂 Path 路由断言工厂接收一个参数，根据 Path 定义好的规则来判断访问的 URI 是.
微服务学习之网关(Gateway)断言和过滤器
qq_19283249的博客
08-29 1351
在微服务学习之网关(Gateway)的搭建及使用中介绍了Gateway内置的断言处理和过滤器，但是并不能满足我们负责的业务逻辑使用，所以我们需要自定义 Prediate 和 Filter。
gateway 断言配置
呆萌很的博客
10-18 1034
gateway 断言配置
Gateway路由谓词（断言）功能
qq1668042080的博客
03-18 1922
Route Predicate Factories（路由断言工厂）是Spring Cloud Gateway中的一种机制，用于定义路由规则中的断言条件。在Spring Cloud Gateway中，路由断言工厂允许基于HTTP请求的各种属性（例如路径、主机、请求方法、请求头等）来匹配和过滤路由。这些断言条件决定了请求是否会被路由到特定的目标服务。简而言之，请求匹配到某条路由规则，则使用该路由。截至2024年3月18日，spring官网共给出了11种不同类型的路由谓词工厂，接下来我们逐一介绍。
gateway之断言的使用详解
Java领域
09-21 1109
所谓的API网关，就是指系统的统一入口，它封装了应用程序的内部结构，为客户端提供统一服务，一些与业务本身功能无关的公共逻辑可以在这甲实现，诸如认证、鉴权、监控、路由转发等等Spring Cloud Gateway（简称Gateway）支持断言Predicate功能，该断言功能是基于Spring WebFlux的HandlerMapping实现的。
Gateway路由谓词工厂(断言)详解
wh柒八九的博客
05-06 1349
本文来详细说下Gateway路由谓词工厂 文章目录常用术语 常用术语 常用术语说明 路由：网关的基本模块，它由ID、目标URI、谓词集合和过滤器集合定义。如果聚合谓词为true，则匹配路由。 谓词： 匹配Http请求参数的规则 过滤器：对下游的服务器之前和之后实现处理，使用责任链模式。 ...
Gateway断言功能详解
Jerry的博客
12-31 6492
1. Predicate机制 Predicate是Java8中引入的一个新功能，和我们平时写单元测试的时候Assertion差不多，Predicate是接收一个判断条件，返回一个ture或false的布尔值结果，告知调用发判断结果。也可以通过and、or和negative(非)三个操作符多个Predicate串联在一块共同判断 Predicate其实就是我们和Gateway对接的数据暗号，比如要求你的Request中必须带有某个指定的参数叫name，对应的值必须是一个指定的人名（Gavin），如果Reque
献给Gateway小白的一篇好文：断言Predicate
云水之路的专栏
08-28 4446
Spring Cloud Gateway（简称Gateway）支持断言Predicate功能，该断言功能是基于Spring WebFlux的HandlerMapping实现的。Gateway包含了很多路由断言工厂，并且这些工厂对应着HTTP请求的很多属性进行了处理，当客户端HTTP请求时，HandlerMapping会获取请求参数，并与Gateway中配置的Predicates进行比对，若满足规则就按规则约定进行路由放行，否则拒绝访问或报404错误。............
【Spring Cloud】Gateway 服务网关核心架构的执行流程和断言
最新发布
阿Q的小窝
06-07 7186
路由(Route)是gateway中最基本的组件之一，表示一个具体的路由信息载体。Predicate(断言，谓词)用于进行条件判断，只有断言都返回真，才会真正的执行路由。断言就是说: 在什么条件下才能进行路由转发。
Spring Cloud Gateway深度解析：Hoxton版核心特性与实战
文档特别强调了Spring Cloud Gateway作为Spring Cloud的新项目，其目标是为微服务架构提供API路由管理，并且对比了它与Zuul的区别，指出Spring Cloud Gateway基于WebFlux和Netty的高性能特性。" 在Spring Cloud生态...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值