Spring Cloud Gateway2之断言Predicate详解

news2024/11/24 14:10:09

文章目录

  • 1. 前言
  • 2. Spring Cloud Gateway断言的种类及各自功能
    • 2.1. Path断言 PathRoutePredicateFactory
    • 2.2.Method断言 MethodRoutePredicateFactory
    • 2.3.Header断言 HeaderRoutePredicateFactory
    • 2.4.Host断言 HostRoutePredicateFactory
    • 2.5.Query断言 QueryRoutePredicateFactory
    • 2.6.Cookie断言 CookieRoutePredicateFactory
    • 2.7.After/Between/Before断言
    • 2.8.RemoteAddr断言 RemoteAddrRoutePredicateFactory
    • 2.9.Weight断言 WeightRoutePredicateFactory
  • 3. 断言的组合使用
  • 4. 自定义断言
  • 5. 断言的核心类详解
    • GatewayAutoConfiguration
    • RoutePredicateFactory
  • 6.参考文档

1. 前言

在这里插入图片描述

随着微服务架构的普及，API网关已经成为了微服务系统中不可或缺的一部分。Spring Cloud Gateway作为Spring Cloud官方推出的二代网关框架，其路由配置简单，支持热部署，支持断路器，限流等功能，因此受到了广大开发者的热烈欢迎。

Spring Cloud Gateway是Spring Cloud官方推出的第二代微服务网关框架，它旨在提供一种简单有效的方式来对API进行路由，或者在边缘服务应用中添加防护措施。它内置了与Spring集成的高级功能，例如：服务发现集成、负载均衡、断路器集成、HttpClient、WebSockets、重试、限流等等。

断言在Spring Cloud Gateway中扮演着重要角色。断言是Gateway在进行路由时，根据具体的请求信息如请求路径、请求方法、请求参数等进行匹配的规则。当一个请求的信息符合断言设置的条件时，Gateway就会将该请求路由到对应的服务上。

例如，我们可能想要将所有GET方法的请求路由到一个服务，将所有POST方法的请求路由到另一个服务。对于这种场景，我们就可以使用Method断言。再如，我们想要将所有路径为"/api/user"的请求路由到用户服务，那么我们就可以使用Path断言Predicate。

2. Spring Cloud Gateway断言的种类及各自功能

根据源码我们可以看到Spring cloud gateway 的内置断言，我们可以看到核心10个内置Predicate
在这里插入图片描述

2.1. Path断言 PathRoutePredicateFactory

Path断言用于根据请求的路径进行匹配。设定该断言的时候，可以为路径设置一个或多个模式。例如，我们可以配置将所有路径为"/api/user"的请求路由到用户服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Path=/api/user

2.2.Method断言 MethodRoutePredicateFactory

Method断言用于根据HTTP请求方法进行匹配。例如，我们可以配置将所有POST方法的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Method=POST

2.3.Header断言 HeaderRoutePredicateFactory

Header断言用于根据HTTP请求头中的信息进行匹配。例如，我们可以配置将所有请求头中含有某个特定字段（比如X-Request-Id）的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Header=X-Request-Id, \d+

2.4.Host断言 HostRoutePredicateFactory

Host断言用于根据请求的主机名进行匹配。例如，我们可以配置将所有来自某个特定主机（比如myhost.com）的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Host=myhost.com

2.5.Query断言 QueryRoutePredicateFactory

Query断言用于根据请求的查询参数进行匹配。例如，我们可以配置将所有请求中包含某个特定查询参数（比如param）的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Query=param

2.6.Cookie断言 CookieRoutePredicateFactory

Cookie断言用于根据请求中的Cookie信息进行匹配。例如，我们可以配置将所有请求中含有某个特定Cookie的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Cookie=cookie

2.7.After/Between/Before断言

After/Between/Before断言主要用于根据请求的时间进行匹配。例如，我们可以配置在某个时间段内的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Between=2019-07-14T20:00:00.000+02:00, 2019-07-15T20:00:00.000+02:00

2.8.RemoteAddr断言 RemoteAddrRoutePredicateFactory

RemoteAddr断言主要用于根据请求的源IP地址进行匹配。例如，我们可以配置将所有来自某个特定IP地址（比如192.168.1.1/24）的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - RemoteAddr=192.168.1.1/24

2.9.Weight断言 WeightRoutePredicateFactory

Weight断言主要用于根据权重进行匹配，常用于灰度发布或者流量控制。例如，我们可以配置将80%的请求路由到新版本的服务，20%的请求路由到旧版本的服务。

routes:
- id: user_service_v1
  uri: http://localhost:8081
  predicates:
  - Weight=group1, 8
- id: user_service_v2
  uri: http://localhost:8082
  predicates:
  - Weight=group1, 2

通过源码可以看到WeightRoutePredicateFactory 和其他断言不一样的是，实现了ApplicationEventPublisherAware接口。beforeApply方法在应用断言之前发布一个WeightDefinedEvent事件，以通知其他组件有关权重信息。事件发布者通过ApplicationEventPublisherAware接口获得ApplicationEventPublisher对象的引用。

在这里插入图片描述

3. 断言的组合使用

在Spring Cloud Gateway中，可以通过在同一个路由定义中添加多个断言来组合使用多个断言。这样做将创建一个逻辑AND条件，也就是说，只有当所有断言都匹配时，请求才会被路由到对应的服务。

举个栗子，假设想要将所有POST请求，并且路径为"/api/user"的请求路由到用户服务。可以这样配置：
只有当请求是POST方法，并且请求的路径为"/api/user"时，请求才会被路由到用户服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Path=/api/user
  - Method=POST

还可以在断言中使用"AND"和"OR"这样的关键字来创建更复杂的匹配条件。
例如，可以配置将所有POST或者PUT方法，并且路径为"/api/user"的请求路由到用户服务
只有当请求是POST或者PUT方法，并且请求的路径为"/api/user"时，请求才会被路由到用户服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Path=/api/user
  - Method=POST,PUT

4. 自定义断言

假设我们要根据请求头中的用户代理（User-Agent）限制对我们服务的访问，因为我们项目在开发过程中只支持谷歌浏览器和火狐浏览器，所以我们也可以使用自定义断言实现。只允许使用特定浏览器谷歌浏览器和火狐浏览器用户访问。我们可以创建一个自定义的断言工厂来实现这个功能。

断言工厂中，我们接受一个配置参数，该参数是一组允许的用户代理（User-Agent）字符串。断言将检查发出请求的客户端的用户代理字符串是否包含在这个列表中的任何一个。

import org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;

import java.util.Collections;
import java.util.List;
import java.util.function.Predicate;

@Component
public class UserAgentRoutePredicateFactory extends AbstractRoutePredicateFactory<UserAgentRoutePredicateFactory.Config> {

    public UserAgentRoutePredicateFactory() {
        super(Config.class);
    }

    @Override
    public List<String> shortcutFieldOrder() {
        return Collections.singletonList("allowedUserAgents");
    }

    @Override
    public Predicate<ServerWebExchange> apply(Config config) {
        return exchange -> {
            String userAgent = exchange.getRequest().getHeaders().getFirst("User-Agent");
            return config.getAllowedUserAgents().stream().anyMatch(userAgent::contains);
        };
    }

    public static class Config {
        private List<String> allowedUserAgents;

        public List<String> getAllowedUserAgents() {
            return allowedUserAgents;
        }

        public void setAllowedUserAgents(List<String> allowedUserAgents) {
            this.allowedUserAgents = allowedUserAgents;
        }
    }
}

可以在路由定义中使用这个自定义的断言

routes:
- id: my_route
  uri: http://localhost:8080
  predicates:
  - UserAgentRoutePredicateFactory=Chrome,Firefox

5. 断言的核心类详解

GatewayAutoConfiguration

断言工厂的初始化主要在GatewayAutoConfiguration中
在这里插入图片描述
以构造方法的形式注入到 RouteLocator在这里插入图片描述

RoutePredicateFactory

RoutePredicateFactory 是 Spring Cloud Gateway 中用于处理路由预言（路由选择条件）的关键接口。

它是一个工厂接口，用于创建 Predicate 对象，这些对象用于评估给定的 HTTP 请求是否应该被路由到特定的路由。每个 RoutePredicateFactory 实现都定义了一种特定类型的路由选择条件，例如，基于请求头的路由选择，基于请求参数的路由选择，等等。

RoutePredicateFactory的主要方法如下：

  1. ShortcutType shortcutType()：返回此工厂支持的快捷方式类型。快捷方式类型定义了如何从配置中解析断言定义。

  2. Predicate<ServerWebExchange> apply(T config)：根据给定的配置创建一个 Predicate 实例。这个 Predicate 可以用于评估一个给定的 ServerWebExchange（代表一个 HTTP 请求）是否匹配此预言。

每个具体的 RoutePredicateFactory 实现类通常会有一个对应的配置类，用于存储此预言所需的配置信息。例如 HostRoutePredicateFactory 对应的配置类是 HostRoutePredicateFactory.Config，这个类有一个 hosts 属性用于存储要匹配的主机名列表。

在 Spring Cloud Gateway 的配置中，可以使用一个 YAML 或者 properties 配置文件来定义路由规则。在这个配置文件中，每个路由都可以有一个或者多个断言，每个断言都对应一个 RoutePredicateFactory。Spring Cloud Gateway 在启动时会解析这个配置文件，为每个断言创建一个对应的 RoutePredicateFactory 实例，然后使用它来创建 Predicate 实例。这些 Predicate 实例用于在运行时评估是否应该将一个请求路由到对应的路由。
在这里插入图片描述

6.参考文档

https://cloud.spring.io/spring-cloud-gateway/2.0.x/single/spring-cloud-gateway.html

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1071427.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

【C++】unordered_set和unordered_map介绍及使用【附OJ题】

【C++】unordered_set和unordered_map介绍及使用【附OJ题】

目录 一、unordered_set和unordered_map的介绍和使用 1、介绍 2、使用及与set和map的区别 3、O&#xff08;logN&#xff09;和 O&#xff08;1&#xff09;的效率对比 二、力扣OJ题 1、重复N次的元素 2、两个数组的交集 一、unordered_set和unordered_map的介绍和使用…
阅读更多...
AI+Social Power，开创营销新纪元 | 2023数说故事年度社媒营销盛会，10月13日邀您共同见证

AI+Social Power，开创营销新纪元 | 2023数说故事年度社媒营销盛会，10月13日邀您共同见证

尊敬的嘉宾&#xff1a; AIGC成为2023年最热门的关键词之一&#xff0c;且以惊人的速度赢得了“圈层共识”&#xff0c;各行业都在探索如何利用AI技术创造更多可能性。尤其在社媒营销领域&#xff0c;AIGC的应用已成为势不可挡的趋势&#xff1a;品牌们用AI造新品&#xff0c;…
阅读更多...
OpenHarmony嵌套类对象属性变化：@Observed装饰器和@ObjectLink装饰器

OpenHarmony嵌套类对象属性变化：@Observed装饰器和@ObjectLink装饰器

上文所述的装饰器仅能观察到第一层的变化&#xff0c;但是在实际应用开发中&#xff0c;应用会根据开发需要&#xff0c;封装自己的数据模型。对于多层嵌套的情况&#xff0c;比如二维数组&#xff0c;或者数组项class&#xff0c;或者class的属性是class&#xff0c;他们的第二…
阅读更多...
子组件跳转父组件

子组件跳转父组件

描述&#xff1a;父组件Form.vue 点击关联&#xff0c;弹出子组件importForm.vue 选中一条数据之后&#xff0c;点击确定按钮&#xff0c;关闭子组件importForm.vue&#xff0c;将子组件的内容显示在父组件Form.vue中 选中第一条数据&#xff0c;点击确定 父组件对应的工作内容…
阅读更多...
Java源码分析（三）ArrayList

Java源码分析（三）ArrayList

ArrayList是我们经常用到的一个集合类&#xff0c;那么本篇我们一起学习下ArrayList的源码。 一、创建ArrayList 首先&#xff0c;我们从创建ArrayList开始。如下代码&#xff0c;创建一个空的ArrayList&#xff1a; List<String> list new ArrayList<>(); 看下…
阅读更多...
Java中的锁与锁优化技术

Java中的锁与锁优化技术

文章目录 自旋锁与自适应自旋锁消除锁粗化轻量级锁偏向锁重量级锁 自旋锁与自适应自旋 自旋锁是一种锁的实现机制&#xff0c;其核心思想是当一个线程尝试获取锁时&#xff0c;如果锁已经被其他线程持有&#xff0c;那么这个线程会在一个循环中不断地检查锁是否被释放&#xf…
阅读更多...
长效和短效HTTP：哪个适合爬虫的代理类型？

长效和短效HTTP：哪个适合爬虫的代理类型？

在进行网络爬虫任务时&#xff0c;选择适合的代理类型对爬虫的效率和稳定性至关重要。长效和短效HTTP代理是两种常见的代理类型&#xff0c;它们各具特点和适用场景。本文将为您分享长效和短效HTTP代理的区别以及选择适合爬虫的代理类型的实用技巧&#xff0c;帮助您提升爬虫效…
阅读更多...
Linux Ftrace介绍

Linux Ftrace介绍

文章目录 一、简介二、内核函数调用跟踪参考链接&#xff1a; 一、简介 Ftrace 是 Linux 官方提供的跟踪工具&#xff0c;在 Linux 2.6.27 版本中引入。Ftrace 可在不引入任何前端工具的情况下使用&#xff0c;让其可以适合在任何系统环境中使用。 Ftrace 可用来快速排查以下相…
阅读更多...
一个tomcat下如何部署多个项目？

一个tomcat下如何部署多个项目？

1、不修改端口&#xff0c;部署多个项目 清楚tomcat目录结构的应该都知道&#xff0c;项目包是放在webapps目录下的&#xff0c;那能否在同一个tomcat的webapps目录下运行多个不同项目呢&#xff1f; 答案是可以的。 1、将多个项目包放入webapps文件夹下 2、修改conf下的serv…
阅读更多...
10.8作业

10.8作业

自己封装一个矩形类(Rect)&#xff0c;拥有私有属性:宽度(width)、高度(height)&#xff0c; 定义公有成员函数: 初始化函数:void init(int w, int h) 更改宽度的函数:set_w(int w) 更改高度的函数:set_h(int h) 输出该矩形的周长和面积函数:void show() #include <io…
阅读更多...
策略模式优雅实践

策略模式优雅实践

1 什么是策略模式 策略模式&#xff08;Strategy Pattern&#xff09;是一种常用的面向对象设计模式&#xff0c;它定义了一系列可互相替换的算法或策略&#xff0c;并将每个算法封装成独立的对象&#xff0c;使得它们可以在运行时动态地替换。具体来说&#xff0c;策略模式定义…
阅读更多...
【uniapp】小程序开发6：自定义状态栏

【uniapp】小程序开发6：自定义状态栏

一、自定义状态栏 可以设置某个页面的状态栏自定义或者全局状态栏自定义。 这里以首页状态栏为例。 1&#xff09;pages.json 中配置"navigationStyle": "custom"&#xff0c;代码如下&#xff1a; {"pages": [ {"path": "pa…
阅读更多...
记录在搭建Jenkins时,所遇到的坑,以及解决方案

记录在搭建Jenkins时,所遇到的坑,以及解决方案

项目场景&#xff1a; 记录在搭建Jenkins时,所遇到的坑,以及解决方案.问题描述1 在使用Jenkins构建时,报错如下&#xff1a; cp: cannot stat /project/xx/xxxx/dist/: No such file or directory Build step Execute shell marked build as failure Finished: FAILURE解决方…
阅读更多...
CRMEB开发小程序无法访问 突然提示系统错误 pc端进入也是空白 无提示， 还有权限问题

CRMEB开发小程序无法访问 突然提示系统错误 pc端进入也是空白 无提示， 还有权限问题

删除一下runtime/cache文件夹&#xff0c;然后重新给站点权限。 然后检查一下ssl证书 参考&#xff1a;https://www.crmeb.com/ask/thread/35073 我实际操作删除的是runtime/temp下的文件&#xff0c;就好了。 还有权限问题&#xff0c;> 直接在 文件夹哪里给777权限就可以了…
阅读更多...
【408常用数据结构】Continually Updating

【408常用数据结构】Continually Updating

文章目录 前言数组链表单向链表双向链表双向链表 树二叉搜索树红黑树B树B树 堆优先队列排序算法&#xff08;重点&#xff09; 栈栈实现单调栈算法&#xff08;可不学&#xff09; 图 前言 这一篇文章是因为有几个玩的比较好的朋友觉得我DS学的还行&#xff0c;然后他们也要准…
阅读更多...
解决Error in rawToChar(block[seq_len(ns)]) :

解决Error in rawToChar(block[seq_len(ns)]) :

今天运行harmony的tutorial时&#xff0c;发现有一个错误&#xff0c;就是 singlecellmethods包需要安装&#xff0c;该包的网址在于 https://github.com/immunogenomics/singlecellmethods 但是我使用 install.packages("/Volumes/Elements SE/单细胞数据集/harmony201…
阅读更多...
go语言中结构体tag使用

go语言中结构体tag使用

go中的tag在结构体中使用的。有两个作用&#xff1a; &#xff08;1&#xff09;给结构体属性起别名&#xff0c;字段映射。对于不同类型的类型对应不同的值&#xff0c;比如xml&#xff0c;yaml&#xff0c;json等分别对应着不同的区域&#xff0c;当然标签也不同。比如json&…
阅读更多...
运行在移动设备上的ML机器学习任务——基于MediaPipe的手势识别

运行在移动设备上的ML机器学习任务——基于MediaPipe的手势识别

前期的文章我们介绍了MediaPipe的人手关键点检测。其检测的21个点的坐标位置如下： 当检测到其关键点后，我们就可以利用此关键点来进行人手手势识别。MediaPipe 手势识别器任务可实时识别手势，并提供识别的手势结果。我们可以使用此任务来识别用户的特定手势，并调用与这些手…
阅读更多...
用python写代码：pip list，列出：pip install 库1 库2库3...，方便一次性安装错误

用python写代码：pip list，列出：pip install 库1 库2库3...，方便一次性安装错误

彻底解决pip安装库问题 用python写代码&#xff1a;pip list 列出&#xff1a;pip install 库1 库2 库3 这种输出以下是使用Python编写代码来实现类似pip list和pip install package1 package2 package3输出的示例&#xff1a; import pkg_resources# 列出已安装的包和版本 i…
阅读更多...
LLMs 库尔贝克-莱布勒散度 KL Kullback-Leibler Divergence

LLMs 库尔贝克-莱布勒散度 KL Kullback-Leibler Divergence

KL-散度&#xff0c;或称为库尔巴克-莱布勒散度&#xff0c;是在强化学习领域经常遇到的概念&#xff0c;特别是在使用Proximal Policy Optimization&#xff08;PPO&#xff09;算法时。它是两个概率分布之间差异的数学度量&#xff0c;帮助我们了解一个分布与另一个分布的差异…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023