SpringCloud - Gateway 网关

news2025/2/12 15:53:41

前言

该博客为Sentinel学习笔记，主要目的是为了帮助后期快速复习使用
学习视频：7小快速通关SpringCloud
辅助文档：SpringCloud快速通关
源码地址：cloud-demo

一、简介

官网：https://spring.io/projects/spring-cloud-gateway

Spring Cloud Gateway 是基于 Spring 生态系统（包括 Spring 6、Spring Boot 3 和 Project Reactor）构建的 API 网关。它旨在为 API 提供简单而有效的路由，并处理诸如安全性、监控/指标和弹性等跨领域关注点。
在这里插入图片描述

1.1 主要特性

  • 构建于 Spring Framework 和 Spring Boot 之上： 利用 Spring 强大的生态系统，确保与其他 Spring 项目的无缝集成。
  • 灵活的路由匹配： 能够基于任何请求属性（如路径、主机、方法等）定义路由规则。
  • 丰富的谓词和过滤器： 为每个路由提供特定的谓词和过滤器，方便实现复杂的路由逻辑和请求/响应的修改。
  • 断路器集成： 与 Hystrix 等断路器库集成，增强系统的弹性和容错能力。
  • 服务发现集成： 与 Spring Cloud DiscoveryClient 集成，实现动态路由和负载均衡。
  • 请求速率限制： 提供请求速率限制功能，保护后端服务免受流量突增的影响。
  • 路径重写： 支持对请求路径进行重写，满足不同的路由需求。

1.2 主要功能

在这里插入图片描述

1.3 版本选择

Spring Cloud Gateway 的两个版本主要区别在于它们的编程模型和适用场景：

  • Reactive Server（响应式版本）：
    • 基于 WebFlux 框架，使用响应式编程模型。
    • 支持完全非阻塞的 I/O 操作，可以提高吞吐量和降低延迟。
    • 适用于构建高性能、高并发的微服务架构。
    • 与现代的响应式编程库（如 Reactor）兼容。
  • Server MVC（传统阻塞式版本）：
    • 基于 Spring MVC 框架，使用传统的同步阻塞 I/O 模型。
    • 更适合与现有的 Spring MVC 应用程序集成。
    • 可能在高并发场景下的性能不如响应式版本。

推荐使用响应式的Gateway
在这里插入图片描述

二、快速入门

2.1 需求

  1. 客户端发送 /api/order/** 转到 service-order
  2. 客户端发送 /api/product/** 转到 service-product
  3. 以上转发有负载均衡效果
    在这里插入图片描述

2.2 创建模块

创建gateway模块，引入 spring-cloud-starter-gateway、spring-cloud-starter-alibaba-nacos-discovery、spring-cloud-starter-loadbalancer

 <!-- gateway网关 -->
 <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-gateway</artifactId>
 </dependency>

 <!-- 服务发现 -->
 <dependency>
     <groupId>com.alibaba.cloud</groupId>
     <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
 </dependency>

 <!--loadbalancer负载均衡-->
 <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-loadbalancer</artifactId>
 </dependency>

添加主程序GatewayMainApplication

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

添加配置文件application.yml

# 服务端口
server:
  port: 80

spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: 127.0.0.1:8848 # nacos地址（默认）

这里可以启动微服务gateway、service-order、service-product，确保在Nacos控制台可以看到
在这里插入图片描述

2.3 改造微服务

创建 application-route.yml，为 service-order、service-prduct 添加 /api基础路径

spring:
  cloud:
    gateway:
      routes:
        - id: order-route
          uri: lb://service-order  # lb（LoadBalance）代表负载均衡
          predicates: # 路径断言规则
            - Path=/api/order/** # 路径匹配
        - id: product-route
          uri: lb://service-product
          predicates:
            - Path=/api/product/**

并且需要在application.yml中启用 application-route.yml才能生效

spring:
  profiles:
    include: route # 启用route

2.4 测试

在浏览器中输入http://localhost/api/order/readDb，通过网关访问 service-order微服务的接口
在这里插入图片描述

2.5 基础原理

  1. 请求处理：
    • 用户请求首先到达 Gateway 。
  2. 路由规则（Route）：
    • 网关根据预定义的路由规则（Route）来决定请求的转发路径。
    • 每个路由规则包含三个主要部分：
      • Predicate 断言：用于匹配请求的条件，如路径、头信息、查询参数等。
      • URI 目的地：匹配请求后，请求将被转发到的目标地址。
      • Filter 过滤器：在请求转发前后执行的一系列过滤器链，用于修改请求/响应、进行认证等。
  3. 过滤器链（Filter Chain）：
    • 请求在转发到目的地之前，会先经过一系列过滤器（Filter）的处理。
    • 过滤器可以执行各种任务，如日志记录、请求修改、认证授权等。
    • 过滤器按照定义的顺序执行，形成一个过滤器链。
  4. 转发请求：
    • 经过过滤器链处理后，请求被转发到最终的目的地（服务提供者）。
  5. 响应处理：
    • 目的地处理完请求后，将响应返回给网关。
    • 响应同样会经过过滤器链的处理，然后返回给用户。

在这里插入图片描述

三、Predicate - 断言

3.1 断言写法

3.1.1 短写法

快捷方式配置由过滤器名称识别，后跟等号 （=），后跟用逗号 （，） 分隔的参数值。

# 断言短写法
spring:
  cloud:
    gateway:
      routes:
        - id: order-route
          uri: lb://service-order  # lb（LoadBalance）代表负载均衡
          predicates: # 路径断言规则
            - Path=/api/order/** # 路径匹配

3.1.2 全写法

完全展开的参数看起来更像是带有名称/值对的标准 yaml 配置。通常，将有一个 name 键和一个 args 键。args 键是用于配置谓词或筛选条件的键值对的映射。

# 断言全写法
spring:
  cloud:
    gateway:
      routes:
        - id: order-route
          uri: lb://service-order  # lb（LoadBalance）代表负载均衡
          predicates:
            - name: Path # 路径断言
              args: # 参数
                pattern: /api/order/**  # 匹配路径
                matchTrailingSlash: true # 匹配尾部斜杠

3.2 断言工厂

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

3.3 自定义断言工厂

创建XxxRoutePredicateFactory继承AbstractRoutePredicateFactory类

/**
 * Vip断言工厂
 */
@Component
public class VipRoutePredicateFactory extends AbstractRoutePredicateFactory<VipRoutePredicateFactory.Config> {


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

    // 配置参数的顺序，为短写法准备
    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList("param", "value");
    }

    // 断言逻辑
    @Override
    public Predicate<ServerWebExchange> apply(Config config) {
        return new GatewayPredicate() {
            @Override
            public boolean test(ServerWebExchange serverWebExchange) {
                // localhost/search?q=haha&user=jyh
                String first = serverWebExchange.getRequest().getQueryParams().getFirst(config.param);
                return StringUtils.hasText(first) && first.equals(config.value);
            }
        };
    }

    /**
     * 可以配置的参数
     */
    @Validated
    public static class Config {

        @NotEmpty
        private String param;

        @NotEmpty
        private String value;

        public @NotEmpty String getParam() {
            return param;
        }

        public void setParam(@NotEmpty String param) {
            this.param = param;
        }

        public @NotEmpty String getValue() {
            return value;
        }

        public void setValue(@NotEmpty String value) {
            this.value = value;
        }
    }
}

编写配置文件

spring:
  cloud:
    gateway:
      routes:
        - id: bing-route
          uri: https://cn.bing.com/ # 跳转地址
          predicates:
            - name: Path # 路径断言
              args:
                patterns: /search
            - name: Query # 查询参数断言
              args:
                param: q #  参数名
                regexp: haha  # 正则表达式
#            - Vip=user,jyh
            - name: Vip # 自定义Vip断言
              args:
                param: user
                value: jyh

四、Filter - 过滤器

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

4.1 路由重写 - RewritePath

在这里插入图片描述

spring:
  cloud:
    gateway:
      routes:
        - id: order-route
          uri: lb://service-order  # lb（LoadBalance）代表负载均衡
          predicates:
            - name: Path # 路径断言
              args: # 参数
                pattern: /api/order/**  # 匹配路径
                matchTrailingSlash: true # 匹配尾部斜杠
          filters:
            - RewritePath=/api/order/?(?<segment>.*), /$\{segment} # 重写路径

RewritePath=/api/order/?(?<segment>.*), /$\{segment}这个规则的意思是：
如果请求路径以 /api/order/ 开头，且后面有任意内容（如 /api/order/123），则会将路径重写为 /123 ，即删除 /api/order/ 部分，只保留后面的内容。

4.2 添加响应请求头 - AddResponseHeader

spring:
  cloud:
    gateway:
      routes:
        - id: order-route
          uri: lb://service-order  # lb（LoadBalance）代表负载均衡
          predicates:
            - name: Path # 路径断言
              args: # 参数
                pattern: /api/order/**  # 匹配路径
                matchTrailingSlash: true # 匹配尾部斜杠
          filters:
            - AddResponseHeader=X-Response-Abc, 123 # 添加响应请求头

在这里插入图片描述

4.3 默认filter - Default Filters

所有路由规则都生效默认filter里面配置的规则

spring:
  cloud:
    gateway:
      routes:
        - id: order-route
          uri: lb://service-order  # lb（LoadBalance）代表负载均衡
          predicates:
            - name: Path # 路径断言
              args: # 参数
                pattern: /api/order/**  # 匹配路径
                matchTrailingSlash: true # 匹配尾部斜杠
          filters:
            - RewritePath=/api/order/?(?<segment>.*), /$\{segment} # 重写路径
        - id: product-route
          uri: lb://service-product
          predicates:
            - Path=/api/product/**
          filters:
            - RewritePath=/api/product/?(?<segment>.*), /$\{segment} # 重写路径
      default-filters: # 默认过滤器
        - AddResponseHeader=X-Response-Abc, 123 # 添加响应头

4.4 全局filter - Global Filters

/**
 * 全局过滤器 - 耗时统计
 * @author jiangyiheng
 */
@Slf4j
@Component
public class RtGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String uri = exchange.getRequest().getURI().toString();
        long start = System.currentTimeMillis();
        log.info("请求开始【{}】开始时间：{}", uri, start);
        // ======================以上是前置逻辑======================
        Mono<Void> filter = chain.filter(exchange)
                .doFinally((result)->{
                    // ======================以下是后置逻辑======================
                    long end = System.currentTimeMillis();
                    log.info("请求结束【{}】结束时间：{} ,耗时：{}ms", uri, end, end - start);
                }); // 放行

        return filter;
    }

    // 优先级
    @Override
    public int getOrder() {
        return 0;
    }
}

在这里插入图片描述

4.5 自定义过滤器

创建一个XxxGatewayFilterFactory类继承AbstractNameValueGatewayFilterFactory工厂

/**
 * 自定义过滤器-令牌网关过滤器
 */
@Component
public class OneTokenGatewayFilterFactory extends AbstractNameValueGatewayFilterFactory {
    @Override
    public GatewayFilter apply(NameValueConfig config) {
        return new GatewayFilter() {
            @Override
            public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
                // 每次响应前，添加一个一次性令牌，支持 uuid,jwt等各种格式
                return chain.filter(exchange).then(Mono.fromRunnable(()->{
                    ServerHttpResponse response = exchange.getResponse();
                    String value = config.getValue();
                    if ("uuid".equalsIgnoreCase(value)) {
                        value = UUID.randomUUID().toString();
                    }
                    if ("jwt".equalsIgnoreCase(value)) {
                        value = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
                    }
                    response.getHeaders().add(config.getName(), value);
                }));
            }
        };
    }
}

在这里插入图片描述

五、CORS - 跨域处理

5.1 全局跨域

spring:
  cloud:
    gateway:
      globalcors:
        cors-configurations:
          '[/**]':
            allowed-origin-patterns: '*' # 允许所有跨域
            allowed-methods: '*' # 允许所有请求方式
            allowed-headers: '*' # 允许所有头

5.2 局部跨域

spring:
  cloud:
    gateway:
      routes:
      - id: cors_route
        uri: https://example.org
        predicates:
        - Path=/service/**
        metadata:
          cors:
            allowedOrigins: '*'
            allowedMethods:
              - GET
              - POST
            allowedHeaders: '*'
            maxAge: 30

面试题：微服务之间的调用经过网关吗？
在这里插入图片描述
微服务之间的调用一般不会经过网关。网关主要用于处理外部请求，负责路由、认证、限流等功能。而微服务之间的通信通常通过服务发现和负载均衡直接进行，不需要经过网关。然而，在某些特殊情况下，如果需要统一管理或控制，微服务之间的调用也可能通过网关。

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

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

相关文章

【JVM详解五】JVM性能调优

【JVM详解五】JVM性能调优

示例&#xff1a; 配置JVM参数运行 #前台运行 java -XX:MetaspaceSize-128m -XX:MaxMetaspaceSize-128m -Xms1024m -Xmx1024m -Xmn256m -Xss256k -XX:SurvivorRatio8 - XX:UseConcMarkSweepGC -jar /jar包路径 #后台运行 nohup java -XX:MetaspaceSize-128m -XX:MaxMetaspaceS…
阅读更多...
DeepSeek：搅动人工智能产业风云的鲶鱼效应深度解读

DeepSeek：搅动人工智能产业风云的鲶鱼效应深度解读

我的个人主页 我的专栏&#xff1a;人工智能领域&#xff0c;希望能帮助到大家&#xff01;&#xff01;&#xff01;点赞❤ 收藏❤ 引言 在当今科技飞速发展的时代&#xff0c;人工智能&#xff08;AI&#xff09;无疑是最为耀眼的领域之一。众多技术与平台如繁星般涌现&a…
阅读更多...
bingAI生成的易语言编程基础

bingAI生成的易语言编程基础

易语言编程基础 易语言&#xff08;EPL&#xff09;是一种基于中文的编程语言&#xff0c;旨在简化编程学习过程&#xff0c;特别适合初学者和有一定编程基础的开发者。它通过中文关键词和语法&#xff0c;降低了编程的门槛&#xff0c;使得代码更加直观易懂。 示例&#xff…
阅读更多...
DeepSeek AI R1推理大模型API集成文档

DeepSeek AI R1推理大模型API集成文档

DeepSeek AI R1推理大模型API集成文档 引言 随着自然语言处理技术的飞速发展&#xff0c;大语言模型在各行各业的应用日益广泛。DeepSeek R1作为一款高性能、开源的大语言模型&#xff0c;凭借其强大的文本生成能力、高效的推理性能和灵活的接口设计&#xff0c;吸引了大量开发…
阅读更多...
【算法-动态规划】、魔法卷轴: 两次清零机会整个数组最大累加和

【算法-动态规划】、魔法卷轴: 两次清零机会整个数组最大累加和

【算法-动态规划】、魔法卷轴: 两次清零机会整个数组最大累加和 文章目录 一、dp1.1 题意理解1.2 整体思路1.3 具体思路1.4 代码 二、多语言解法 一、dp 1.1 题意理解 nums 数组, 有正负0, 使用最多两次魔法卷轴, 希望使数组整体的累加和尽可能大. 求尽可能大的累加和 其实就…
阅读更多...
【R】Dijkstra算法求最短路径

【R】Dijkstra算法求最短路径

使用R语言实现Dijkstra算法求最短路径 求点2、3、4、5、6、7到点1的最短距离和路径 1.设置data&#xff0c;存放有向图信息 data中每个点所在的行序号为起始点序号&#xff0c;列为终点序号。 比如&#xff1a;值4的坐标为(1,2)即点1到点2距离为4&#xff1b;值8的坐标为(6,7)…
阅读更多...
深入浅出：探索 DeepSeek 的强大功能与应用

深入浅出：探索 DeepSeek 的强大功能与应用

深入浅出&#xff1a;探索 DeepSeek 的强大功能与应用 在人工智能技术飞速发展的今天&#xff0c;自然语言处理&#xff08;NLP&#xff09;作为其重要分支&#xff0c;正逐渐渗透到我们生活的方方面面。DeepSeek 作为一款功能强大的 NLP 工具&#xff0c;凭借其易用性和高效性…
阅读更多...
西门子S7-200 PLC串口PPI转以太网通讯的模块链接方式

西门子S7-200 PLC串口PPI转以太网通讯的模块链接方式

项目背景 某汽车零部件生产车间有30台自动化生产设备&#xff0c;控制系统采用西门子S7-200系列的CPU226。此前&#xff0c;设备的一个通讯端口用于和变频器进行自由口通讯&#xff0c;另一个通讯端口连接着一台昆仑通态触摸屏作为人机界面。车间计划进行智能化升级&#xff…
阅读更多...
win10向windows server服务器传输文件

win10向windows server服务器传输文件

win10向windows server服务器传输文件 遇到无法直接拖动文件进行传输时 解决方案&#xff1a; 1.点击显示选项 2.点击本地资源-详细信息 3.在窗口中选择你需要共享的磁盘 4.然后远程连接到Windows server服务器 5.登录Windows server服务器后&#xff0c;在此电脑下就能看…
阅读更多...
git服务器搭建，gitea服务搭建，使用systemclt管理服务

git服务器搭建，gitea服务搭建，使用systemclt管理服务

文章目录 页面展示使用二进制文件安装git服务下载选择架构使用wget下载安装 验证 GPG 签名服务器设置准备环境创建systemctl文件 备份与恢复备份命令 (dump)恢复命令 (restore) 页面展示 使用二进制文件安装git服务 所有打包的二进制程序均包含 SQLite&#xff0c;MySQL 和 Po…
阅读更多...
Mybatis快速入门与核心知识总结

Mybatis快速入门与核心知识总结

Mybatis 1. 实体类&#xff08;Entity Class&#xff09;1.1 实体类的定义1.2 简化编写1.2.1 Data1.2.2 AllArgsConstructor1.2.3 NoArgsConstructor 2. 创建 Mapper 接口2.1 Param2.2 #{} 占位符2.3 SQL 预编译 3. 配置 MyBatis XML 映射文件&#xff08;可选&#xff09;3.1 …
阅读更多...
用docker在本地用open-webui部署网页版deepseek

用docker在本地用open-webui部署网页版deepseek

前置条件 用Ollama在本地CMD窗口运行deepseek大模型-CSDN博客文章浏览阅读109次&#xff0c;点赞5次&#xff0c;收藏2次。首次运行需要下载deepseek的大模型包&#xff08;大约5GB&#xff0c;根据本地网速的不同在半个小时到几个小时之间下载完成&#xff09; &#xff0c;并…
阅读更多...
2025.2.8——一、[护网杯 2018]easy_tornado tornado模板注入

2025.2.8——一、[护网杯 2018]easy_tornado tornado模板注入

题目来源&#xff1a;BUUCTF [护网杯 2018]easy_tornado 目录 一、打开靶机&#xff0c;整理信息 二、解题思路 step 1&#xff1a;分析已知信息 step 2&#xff1a;目标——找到cookie_secret step 3&#xff1a;构造payload 三、小结 一、打开靶机&#xff0c;整理信…
阅读更多...
前端实现在PDF上添加标注(1)

前端实现在PDF上添加标注(1)

前段时间接到一个需求&#xff0c;用户希望网页上预览PDF&#xff0c;同时能在PDF上添加文字&#xff0c;划线&#xff0c;箭头和用矩形框选的标注&#xff0c;另外还需要对已有的标注进行修改&#xff0c;删除。 期初在互联网上一通搜索&#xff0c;对这个需求来讲发现了两个问…
阅读更多...
GitCode 助力 Easy-Es，革新 Elasticsearch 开发体验

GitCode 助力 Easy-Es，革新 Elasticsearch 开发体验

项目仓库&#xff08;点击阅读原文链接可直达&#xff09; https://gitcode.com/dromara/easy-es 项目背景&#xff1a;填补 Elasticsearch ORM 框架空白 在 Java 开发领域&#xff0c;Excel 和 Elasticsearch 的代码编写难度一直名列前茅&#xff0c;尤其是 Elasticsearch&a…
阅读更多...
EF Core中实现值对象

EF Core中实现值对象

目录 值对象优点 值对象的需求 值类型的实现 值类型GEO的实现 值类型MultilingualString的实现 案例&#xff1a;构建表达式树&#xff0c;简化值对象的比较 值对象优点 把有紧密关系的属性打包为一个类型把领域知识放到类的定义中 class shangjia {long id;string nam…
阅读更多...
《从入门到精通：蓝桥杯编程大赛知识点全攻略》（十一）-回文日期、移动距离、日期问题

《从入门到精通：蓝桥杯编程大赛知识点全攻略》（十一）-回文日期、移动距离、日期问题

前言 在这篇博客中&#xff0c;我们将通过模拟的方法来解决三道经典的算法题&#xff1a;回文日期、移动距离和日期问题。这些题目不仅考察了我们的基础编程能力&#xff0c;还挑战了我们对日期处理和数学推理的理解。通过模拟算法&#xff0c;我们能够深入探索每个问题的核心…
阅读更多...
Docker Compose介绍及安装使用MongoDB数据库详解

Docker Compose介绍及安装使用MongoDB数据库详解

在现代容器化应用部署中&#xff0c;Docker Compose是一种非常实用的工具&#xff0c;它允许我们通过一个docker-compose.yml文件来定义和运行多容器应用程序。然而&#xff0c;除了Docker之外&#xff0c;Podman也提供了类似的工具——Podman Compose&#xff0c;它允许我们在…
阅读更多...
11.swagger使用

11.swagger使用

菜单位置 未登录接口会返回401 登录的token存储的位置 配置文件swagger配置中将/dev-api修改/
阅读更多...
java高级知识之集合

java高级知识之集合

前言 集合是java开发中的重点内容&#xff0c;需要掌握的东西很多&#xff0c;面试中可问的东西很多&#xff0c;无论是深度还是广度。集合框架中Collection对应的实现类如下所示&#xff0c;这些都是要完全掌握&#xff0c;一个可以分为三大类List集合、Set‘集合以及Map集合…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023