SpringCloud 2.x学习笔记：14、Spring Cloud Gateway路由断言工厂（Greenwich版本）

最新推荐文章于 2025-06-12 12:21:09 发布
原创 最新推荐文章于 2025-06-12 12:21:09 发布 · 2k 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#断言

本文介绍了多种路由断言，如After、Between、Header等。不同断言有不同匹配规则，如After需请求时间在指定时间之后，Header要匹配头名称和正则表达式等。还提及了各断言所需参数及匹配成功或失败的情况，最后提到了组合使用和完整的pom.xml。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

1、Predicate断言

gateway-predicate模块的pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.cntaiping.tpa</groupId>
    <artifactId>gateway-predicate</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>gateway-predicate</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>com.cntaiping.tpa</groupId>
        <artifactId>gateway</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
    </dependencies>

</project>

2、 After路由断言

After Route Predicate Factory，可配置一个UTC时间格式的时间参数，当请求进来的当前时间在路由断言工厂之后会成功匹配，才交给 router去处理。否则则报错，不通过路由。

server:
  port: 7012
spring:
  profiles:
    active: query_route

---
spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: http://httpbin.org:80/get
        predicates:
        - After=2017-01-20T17:42:47.789-07:00[America/Denver]
#        - After=2018-04-1T17:42:47.789-07:00[Asia/Shanghai]
  profiles: after_route


package com.cntaiping.tpa.gatewaypredicate;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class GatewayPredicateApplication {

    public static void main(String[] args) {
        SpringApplication.run(GatewayPredicateApplication.class, args);
    }

}

配置spring.profiles.active:after_route指定了程序的spring的启动文件为after_route文件。
在这里插入图片描述

http://localhost:7012/
在这里插入图片描述

- After=2020-01-20T17:42:47.789-07:00[America/Denver]

在这里插入图片描述

3、 Between路由断言

Between路由断言工厂接受两个参数，datetime1和datetime2。该谓词匹配发生在datetime1与datetime2之间请求。

---
spring:
  cloud:
    gateway:
      routes:
      - id: between_route
        uri: http://httpbin.org/get
        predicates:
        - Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2019-01-21T17:42:47.789-07:00[America/Denver]
  profiles: between_route

在这里插入图片描述

- Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2019-01-21T17:42:47.789-07:00[America/Denver]

- Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2020-01-21T17:42:47.789-07:00[America/Denver]

4、 Header路由断言

Header由断言工厂接受两个参数，头名称和正则表达式。这个谓词与给定名称的头匹配，该值与正则表达式匹配。
Header Route Predicate Factory需要2个参数，一个是header名，另外一个header值，该值可以是一个正则表达式。当此断言匹配了请求的header名和值时，断言通过，进入到router的规则中去。

---
spring:
  cloud:
    gateway:
      routes:
      - id: header_route
        uri: http://httpbin.org/get
        predicates:
        - Header=X-Request-Id, \d+
  profiles: header_route

当请求的Header中有X-Request-Id的header名，且header值为数字时，请求会被路由到配置的 uri.
在这里插入图片描述

curl -H 'X-Request-Id:1' localhost:7012

在这里插入图片描述

如果在请求中没有带上X-Request-Id的header名，并且值不为数字时，请求就会报404，路由没有被正确转发。
在这里插入图片描述

5、 Cookie路由断言

Cookie路由断言工厂接受两个参数：一个时cookie名字，另一个时值，可以为正则表达式。它用于匹配请求中，带有该名称的cookie和cookie匹配正则表达式的请求。

---
spring:
  cloud:
    gateway:
      routes:
      - id: cookie_route
        uri: http://httpbin.org:80/get
        predicates:
        - Cookie=flag, ch.p
  profiles: cookie_route

在这里插入图片描述

curl -H Cookie:flag=chip localhost:7012

在这里插入图片描述

6、 Host 路由断言

Host路由断言工厂接受一个参数：需要一个参数即hostname。它可以使用. * 等去匹配host。这个参数会匹配请求头中的host的值，一致，则请求正确转发。

---
spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: http://httpbin.org:80/get
        predicates:
        - Host=**.hadron.cn
  profiles: host_route

请求头中含有Host为hadron.cn的请求将会被路由转发转发到配置的uri。
在这里插入图片描述

curl -H Host:www.hadron.cn localhost:7012

在这里插入图片描述

7、 Method 路由断言

Method路由断言工厂接受一个参数：HTTP方法来匹配。

---
spring:
  cloud:
    gateway:
      routes:
      - id: method_route
        uri: http://httpbin.org:80/post
        predicates:
        - Method=POST
  profiles: method_route

在这里插入图片描述

curl -XPOST localhost:7012
curl localhost:7012

在这里插入图片描述
在这里插入图片描述

8、 Path 路由断言

Path路由断言工厂接受一个参数：采用Spring PathMatcher 模式。

---
spring:
  cloud:
    gateway:
      routes:
      - id: path_route
        uri: http://httpbin.org
        predicates:
        - Path=/foo/{segment}
  profiles: path_route

请求路径满足/foo/{segment}的请求将会匹配并被路由，比如/foo/1 、/foo/bar的请求，将会命中匹配，并成功转发。
在这里插入图片描述
请注意，curl http://localhost:7012/foo/1已经请求成功(结果含有HTML标签)，返回结果是服务器没有这个值。而curl http://localhost:7012/fee/1请求拒绝。

在这里插入图片描述

9、 Query路由断言

Query路由断言工厂接受两个参数：一个必需的参数(param)和一个可选的表达式(regexp)。

---
spring:
  cloud:
    gateway:
      routes:
      - id: query_route
        uri: http://httpbin.org:80/get
        predicates:
        - Query=flag
  profiles: query_route

这个路由将匹配如果请求包含一个flag查询参数。

在这里插入图片描述
在这里插入图片描述

10、RemoteAddr路由断言

RemoteAddr路由断言工厂支持通过设置某个 ip 区间号段的请求才会路由，接受 cidr 符号(IPv4 或 IPv6 )字符串的列表(最小大小 1)

---
spring:
  cloud:
    gateway:
      routes:
      - id: remoteaddr_route
        uri: http://httpbin.org:80/get
        predicates:
        - RemoteAddr=10.17.36.1/24
  profiles: remoteaddr_route

这个路由将匹配请求的远程地址为10.17.36网段，例如，我的本地机地址是10.17.36.27。
在这里插入图片描述

在这里插入图片描述

11、组合使用

---
spring:
  cloud:
    gateway:
      routes:
      - id: group_route
        uri: http://httpbin.org
        predicates:
        - Host=**.httpbin.com
        - Header=X-Request-Id, \d+
        - Cookie=name, chengyuqiang
        - After=2019-06-20T00:00:00+08:00[Asia/Shanghai]
  profiles: group_route

在这里插入图片描述

curl localhost:7012 -H "X-Request-Id:520" -H "Host:www.httpbin.com" --cookie "name=chengyuqiang"

在这里插入图片描述

12、完整的pom.xml

server:
  port: 7012

---
spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: http://httpbin.org/get
        predicates:
        - After=2020-01-20T17:42:47.789-07:00[America/Denver]
        #- After=2018-04-1T17:42:47.789-07:00[Asia/Shanghai]
  profiles: after_route
---
spring:
  cloud:
    gateway:
      routes:
      - id: between_route
        uri: http://httpbin.org/get
        predicates:
        - Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2020-01-21T17:42:47.789-07:00[America/Denver]
  profiles: between_route
---
spring:
  cloud:
    gateway:
      routes:
      - id: header_route
        uri: http://httpbin.org/get
        predicates:
        - Header=X-Request-Id, \d+
  profiles: header_route
---
spring:
  cloud:
    gateway:
      routes:
      - id: cookie_route
        uri: http://httpbin.org:80/get
        predicates:
        - Cookie=flag, ch.p
  profiles: cookie_route

---
spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: http://httpbin.org:80/get
        predicates:
        - Host=**.hadron.cn
  profiles: host_route

---
spring:
  cloud:
    gateway:
      routes:
      - id: method_route
        uri: http://httpbin.org:80/get
        predicates:
        - Method=get
  profiles: method_route

---
spring:
  cloud:
    gateway:
      routes:
      - id: path_route
        uri: http://httpbin.org
        predicates:
        - Path=/foo/{segment}
  profiles: path_route

---
spring:
  cloud:
    gateway:
      routes:
      - id: query_route
        uri: http://httpbin.org:80/get
        predicates:
        - Query=flag
  profiles: query_route

---
spring:
  cloud:
    gateway:
      routes:
      - id: remoteaddr_route
        uri: http://httpbin.org:80/get
        predicates:
        - RemoteAddr=10.17.36.1/24
  profiles: remoteaddr_route

---
spring:
  cloud:
    gateway:
      routes:
      - id: group_route
        uri: http://httpbin.org
        predicates:
        - Host=**.httpbin.com
        - Header=X-Request-Id, \d+
        - Cookie=name, chengyuqiang
        - After=2019-06-20T00:00:00+08:00[Asia/Shanghai]
  profiles: group_route
spring cloud Greenwich 学习笔记（七）spring cloud gateway 教程入门
刘本龙的专栏
02-15 7968
文章目录概述helloworld使用Hystrix 概述 Spring Cloud Gateway是Spring Cloud官方推出的第二代网关框架，取代Zuul网关。网关在微服务系统中有着非常作用，网关常见的功能有路由转发、权限校验、限流控制等作用。 spring cloud 早期版本中使用的是zuul 1.X 。后来zuul 1.X 升级到 zuul 2.x 的进度过于缓慢，springclo...
SpringCloud（Hoxton SR6）微服务工具集学习笔记
weixin_43711204的博客
11-14 2339
版本: Hoxton SR6
Spring Cloud Gateway路由断言实战——Host路由断言工厂
实践求真知
11-30 1404
一源码位置 https://github.com/cakin24/spring-cloud-code/tree/master/ch17-2/ch17-2-6-gateway 二关键代码 package cn.springcloud.book.gateway; import org.springframework.boot.SpringApplication; import org.s...
Spring Cloud Gateway2之断言Predicate详解
日拱一卒无有尽，功不唐捐终入海
10-08 867
随着微服务架构的普及，API网关已经成为了微服务系统中不可或缺的一部分。Spring Cloud Gateway作为Spring Cloud官方推出的二代网关框架，其路由配置简单，支持热部署，支持断路器，限流等功能，因此受到了广大开发者的热烈欢迎。Spring Cloud Gateway是Spring Cloud官方推出的第二代微服务网关框架，它旨在提供一种简单有效的方式来对API进行路由，或者在边缘服务应用中添加防护措施。
Spring Cloud Gateway 的断言(Predicates)有哪些？
最新发布
csdn_tom_168的博客
06-12 380
摘要：Spring Cloud Gateway的断言（Predicates）是定义路由匹配规则的核心机制，分为七类主要功能：时间相关（After/Before/Between）、请求特征（Path/Method/Host/Query）、客户端特征（RemoteAddr/Cookie/Header）、权重分发（Weight）、高级断言（XForwardedRemoteAddr/ReadBody）以及组合逻辑。配置方式包括YAML静态配置和编程式动态配置，生产实践中建议结合性能、灰度发布和安全需求合理组合断言类
SpringCloudGateway--谓词（断言）
有问题请发邮箱dengyifanlittle@163.com进行讨论
11-26 1999
SpringCloudGateway中三个重要词汇：路由（Route）：配置网关中的一个完整路由，包括命名，地址，谓词集合（规则），过滤器集合。谓词、断言（Predicate）：这是一个 Java 8 函数谓词。输入类型是一个 Spring 框架的 ServerWebExchange。这允许开发人员匹配来自 HTTP 请求的任何内容，例如头部或参数。简单说就是看发送的请求url中是否符合谓词中的规则，符合就通过，不符合就进行拦截。
Spring Cloud Gateway自定义路由断言工厂
马明的博客
07-14 3139
SpringCloud视频教程： https://ke.qq.com/course/2805647?tuin=a3e3fb1&from_uin=171851697&from=1000201007 个人博客纯净版 http://www.51ufo.cn/%E5%BE%AE%E6%9C%8D%E5%8A%A1/%E5%88%86%E5%B8%83%E5%BC%8F/2020/07/11/SpringCloud%E5%85%A5%E9%97%A818-Spring-Cloud-Gateway
SpringCloud Gateway自定义断言工厂
weixin_42270645的博客
03-22 912
当官方提供的所有断言工厂无法满足业务需求时，还可以自定义断言工厂。 添加自定义断言工厂类 自定断言工厂主要注意一下几点： 需要声明是Springboot的Bean，添加注解@Component，名称必须以RoutePredicateFactory结尾，这个是命名约束。 如果不按照命名约束来命名，那么就会找不到该断言工厂。前缀就是配置中配置的断言。 可以直接复制Gateway中已经实现的断言工厂，修改对应的内容，避免踩坑。 继承父类AbstractRoutePredicateFactory，并重写方法。 需
尚硅谷2025最新SpringCloud学习笔记
Davina_yu的博客
01-16 2564
单体架构集群分布式架构。
尚硅谷 SpringCloud 第二季学习笔记【已完结】
m0_54850467的博客
06-22 2046
https://spring.io/projects/spring-cloud#overview更详细的版本对应查看方法：https://start.spring.io/actuator/info题外话：boot版已经到2.2.4为最新，为什么选2.2.2？ SpringCloud和SpringBoot版本对应关系以前：现在（2020年）：约定 > 配置 > 编码 如果有依赖下载不下来就先把 pom 文件中的 注释掉，等下载完成后在取消注释即可Maven中的DependencyManagement和De
springcloud 学习项目
qq_44041944的博客
09-26 941
springcloud学习笔记概述1.springcloud是什么，为什么要学springcloud，不学springcloud又怎样呢。一、创建一个简单的springcloud项目1_1、创建数据库和一个maven项目1_1_1 创建数据库1_1_2 创建maven项目并删掉src文件夹，然后添加依赖1_2、创建springcloud-api模块1_2_1.导入依赖1_2_2创建实体类pojo1_3创建springcloud-provider-dept-8001模块:服务提供者1_3_1导入依赖1_3_2
spring-cloud（十一）GateWay强大的路由谓词（断言）功能
胖虎儿的博客
10-15 8491
GateWay强大的路由谓词（断言）功能
SpringCloud使用Gateway常用的断言（predicates）种类以及规则
热门推荐
易柏州的博客
07-04 1万+
SpringCloud使用Gateway的断言种类以及规则     基础提要：SpringCloud中的Gateway网关. 这里是我们9527网关服务的yml配置文件，可以看到是动态路由，根据断言（predicates）匹配到/testGateWay01路径的请求后，再通过服务名SPRINGCLOUD-PROVIDER-DEPT去服务注册中心负载均衡地获取到服务并访问！ spring: application: name: cloud-gateway cloud: gateway:
spring cloud gateway核心概念之断言和过滤器
龚厂长的博客
09-14 2971
- 路由（Route）：**路由是网关的基本构件**。它由ID、目标URI、一组断言和一组过滤器组成。如果断言为真，则匹配该路由。gateway使用类RouteDefinition表示路由定义。 - 断言（Predicate）：**参照Java8的新特性Predicate**。Predicate接受一个输入参数，返回一个布尔值结果，输入参数可以是HTTP请求的任何部分，比如报文头、参数、报文体，而且还可以将多个断言组合在一起。 - 过滤器（Filter）：可以在发送到目标URI之前或之后修改请求和响应
Spring Cloud Gateway高级特性之断言(Hoxton版本)
Trazen的专栏
07-04 1361
1.高级特性—断言(Predicate) Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。 Spring Cloud Gateway包括许多内置的Route Predicate工厂。 所有这些Predicate都与HTTP请求的不同属性匹配。 多个Route Predicate工厂可以进行组合。   Spring Cloud Gateway内置了许多Predict,这些Predict的源码在org.springframewor
【深入解析spring cloud gateway】02 网关路由断言
程序员笔记
08-30 1208
网关路由断言讲解
Springcloud gateway 之 路由断言
沉在水底的鱼的博客
08-01 3935
路由断言的含义指:通过路由断言判断路由是否可用,匹配成功进行下一步处理，否则则失败如下图: 断言的类型分为9种: 1.After 在时间之后 才能路由 2.Before 在时间之前 才能路由 3.Between 在时间区间内才能路由 4.Cookie 路由断言工厂会取两个参数 - cookie 名称对应的的key 和value，当cookie 和 Cookied ...
spring cloud gateway
gggfJJ的博客
02-05 1070
创建一个“时间范围”断言工厂，控制请求只能在指定时间范围内访问（1）创建自定义 Predicate 工厂类在 Spring Cloud Gateway 中，自定义断言工厂必须继承，并且类名必须以结尾。@Component@Override// 获取当前时间// 检查当前时间是否在配置的时间范围内// 这个方法用于绑定 yml 配置中的参数@Override// 配置类📌解释继承这里的Config是一个内部类，用于接收YAML 配置中的参数。
Spring Cloud Gateway详解
玄武后端技术栈
05-11 1017
Spring Cloud Gatewya 详解，路由，断言，过滤器
Spring Cloud Greenwich.SR5：构建分布式系统工具
"Spring Cloud英文版，官方文档，版本 Version: Greenwich.SR5" Spring Cloud是基于Spring Boot构建的微服务框架，旨在简化分布式系统开发中的常见模式，如配置管理、服务发现、熔断器、智能路由、微代理、控制总线...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值