SpringCloud-Gateway网关的使用

news2024/12/23 10:25:43

本文介绍如何再 SpringCloud 项目中引入 Gateway 网关并完成网关服务的调用。Gateway 网关是一个在微服务架构中起到入口和路由控制的关键组件。它负责处理客户端请求，进行路由决策，并将请求转发到相应的微服务。Gateway 网关还可以实现负载均衡、安全认证、日志记录等功能，集中管理服务间的通信，提升整体系统的可维护性和安全性。通过 Gateway 网关，可以实现统一的访问点，简化客户端与后端微服务之间的交互，同时也能够更灵活地进行流量控制和监控。

一、Gateway网关介绍

Gateway 网关是一个基于 Spring Cloud 的 API 网关服务，它提供了路由、过滤、监控、日志等功能，用于统一管理和转发微服务的请求流量。作为微服务架构中的入口点，Gateway 网关可以实现负载均衡、安全认证、请求转发等功能，提高了系统的安全性、可用性和可维护性。

网关的作用：

  • 对用户请求做身份认证、权限校验
  • 将用户请求路由到微服务，并实现负载均衡
  • 对用户请求做限流

含 Gateway 网关项目结构示意图：

二、搭建Gateway网关

搭建Gateway网关需要以下步骤：

1、创建Gateway模块

我们需要的开发环境中创建一个新的Spring Boot项目。
不会创建的可以参考我之前的文章：SpringCloud-创建多模块项目

在SpringCloud项目上我们创建Gateway模块，我命名为 springcloud-gateway。

2、引入SpringCloud-Gateway依赖

在 springcloud-gateway 项目的 pom.xml 文件中引入 Spring Cloud Gateway 的依赖。

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

3、配置路由规则

编辑 applicatin.yml，配置 Gateway 网关的路由规则，包括定义路由路径、目标服务等信息。

server:
  port: 8090
spring:
  application:
    name: springcloud-gateway
  cloud:
    nacos:
      server-addr: localhost:8848
    gateway:
      discovery:
          locator:
              enabled: true # 开启自动路由
      routes: # 网关路由配置
        - id: gateway-service # 路由id，自定义，唯一
          uri: lb://target # 路由的目标地址，lb表示负载均衡
          predicates: # 路由断言，判断请求是否符合路由规则
            - Path=/gateway/** # 要求请求路径以/user/开头，否则404
          filters:
            - StripPrefix=1 # 转发请求时uri过滤掉/gateway

我们添加了动态路由，这里的动态路由属性可以自动让网关的转发请求负载均衡。

这里我们用到了一个 Path 断言，要求请求路径以 /user/ 开头，否则请求会返回404 (未找到服务) 。这里我们还用到了一个过滤器，让网关转发请求时，去掉前缀 /gateway。断言工厂和过滤器的概念我们在下文进行详细讲解。

4、添加断言

在Spring Cloud Gateway中，断言（Predicate）用于定义请求匹配的条件，从而决定是否应用某个过滤器链。以下是一些常见的Gateway断言种类和相应的示例：

断言种类匹配规则示例
Path根据请求的路径进行匹配。- Path=/api/**
匹配路径为 "/api/**" 的请求。
Method根据请求的HTTP方法进行匹配。- Method=GET
匹配GET请求。
Header根据请求的头部信息进行匹配。- Header=Authorization, \d+
匹配包含 "Authorization" 头部的请求。
Host根据请求的主机名进行匹配。- Host=example.com
匹配主机名为 "example.com" 的请求。
Query根据请求的查询参数进行匹配。- Query=category, \w+
匹配包含 "category" 参数的请求。
Cookie根据请求的Cookie进行匹配。- Cookie=sessionId, \d+
匹配包含名为 "sessionId" 的Cookie的请求。
Combining将多个断言组合成一个逻辑条件，
实现更复杂的匹配。		- Path=/api/** AND Method=GET
同时匹配路径为 "/api/**" 且是GET请求的请求。

下面来举个例子：

server:
  port: 8090
spring:
  application:
    name: springcloud-gateway
  cloud:
    nacos:
      server-addr: localhost:8848
    gateway:
      discovery:
          locator:
              enabled: true # 开启自动路由
      routes:
        - id: gateway-service
          uri: lb://target
          predicates:
            - Header=Authorization, Bearer 831B175-D251501-31A3F301-711636-9CAE

这里用到的最常用的 Header 断言中的鉴权断言，要求访问网关的请求必须在请求头里带有 <Authorization, Bearer 831B175-D251501-31A3F301-711636-9CAE> 的鉴权码，如果没有鉴权码或者鉴权码不匹配，则返回 404。

5、添加过滤器

Spring Cloud Gateway提供了丰富的过滤器种类，这些过滤器用于在请求进入网关或响应离开网关时执行各种操作。以下是一些常见的Gateway过滤器种类：

过滤器种类过滤器作用
Pre Filters
(前置过滤器)		AddRequestHeader: 添加请求头。
AddRequestParameter: 添加请求参数。
ModifyRequestBody: 修改请求体。
Route Filters
(路由过滤器)		AddResponseHeader: 添加响应头。
AddResponseParameter: 添加响应参数。
Hystrix: 集成Hystrix断路器，提供服务容错能力。
Post Filters
(后置过滤器)		SetStatus: 设置响应状态码。
ModifyResponseBody: 修改响应体。
Error Filters
(错误过滤器)		SendError: 处理请求发生错误时的操作。
ExceptionHandler: 自定义异常处理。
Global Filters
(全局过滤器)		GlobalFilter: 全局过滤器，适用于所有路由。
Ordered: 为过滤器设置顺序。
Custom Filters
(自定义过滤器)		自定义实现GatewayFilter接口: 开发者可以通过实现该接口创建自定义的过滤器。

这些过滤器可以按照需求进行组合和配置，使得开发者可以在Gateway中实现各种复杂的请求和响应处理逻辑。通过合理配置过滤器，可以实现日志记录、认证授权、请求重试、熔断器等功能，提高网关的灵活性和可扩展性。

下面我们来举个例子：

server:
  port: 8090
spring:
  application:
    name: springcloud-gateway
  cloud:
    nacos:
      server-addr: localhost:8848
    gateway:
      discovery:
          locator:
              enabled: true # 开启自动路由
      routes:
        - id: gateway-service
          uri: lb://target
          predicates:
            - Path=/gateway/**
          filters:
            - StripPrefix=1
            - AddRequestHeader=test_header, damon0806

这里可以看到，我们在 routes（网关路由）下配置了 filters（过滤器）。

  • StripPrefix=1：表示从请求的URI中去除前缀的数量。在这里，1 表示去除两级路径的前缀。例如，如果原始请求是 /path1/rest-of-the-uri，使用此配置后，转发到后端的请求 URI 将是 /rest-of-the-uri。
  • AddRequestHeader=test_header, damon0806：表示在请求头中添加一个自定义的头部。具体来说，它添加了一个名为 test_header 的头部，其值为 damon0806。这可以用于在请求发送到后端服务时传递额外的信息或标识。

6、启动网关服务

编写 springcloud-gateway 的启动类，启动 Gateway 网关服务，使其开始监听和转发请求。

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

@SpringBootApplication
public class SpringcloudGatewayApplication {

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

7、测试路由

可以使用 Postman 等接口测试工具发送请求，测试 Gateway 网关是否能够正确转发请求到相应的微服务，以及断言工厂或者过滤器是否实现。

三、Gatway网关的作用

Gateway 网关作为微服务架构中的入口点，扮演着关键的角色。

其作用主要体现在以下几个方面：

作用点详细描述
路由
(Routing)		Gateway能够根据请求的路径，将请求路由到相应的微服务实例上。简化了服务调用的过程，使得客户端无需直接关注每个微服务的位置和细节。
负载均衡
(Load Balancing)		Gateway支持负载均衡，可将请求均匀地分发到多个微服务实例，提高系统的可用性和性能。有效避免了单一服务实例的过载，提高了整体系统的稳定性。
过滤
(Filtering)		Gateway可以通过过滤器实现对请求和响应进行处理，如添加、修改请求头、记录日志、认证、鉴权等操作。统一处理与安全、日志、性能等相关的逻辑，使得系统更加易于维护和管理。
熔断器
(Circuit Breaker)		Gateway支持熔断器机制，当某个微服务出现故障或超时时，能够自动切换到备用服务，防止故障向下游传递。提高了系统的容错性，减少了因单一服务故障而导致整个系统不稳定的风险。
统一异常处理
(Exception Handling)		Gateway可以统一处理微服务中的异常，提供友好的错误提示，防止细节泄露给客户端。提高了系统的安全性和用户体验，降低了对异常的不良影响。
协议转换
(Protocol Transformation)		Gateway支持协议的转换，可以将外部请求转换成内部微服务所需的协议。降低了微服务之间的耦合度，允许使用不同的协议进行通信。

Gateway网关在微服务架构中承担了集中处理、管理和保护服务的责任，通过提供统一的入口和处理机制，使得微服务系统更加稳定、灵活和易于维护。

四、Gateway网关服务的调用

下面是前端 Ajax 调用网关服务的实例：

前端 JavaScript 代码：

$.ajax({
    type: "POST",
    url: "http://localhost:8090/gateway/getUserList",
    data: {},
    dataType: 'json'
});

网关配置如下：

server:
  port: 8090
spring:
  application:
    name: springcloud-gateway
  cloud:
    nacos:
      server-addr: localhost:8848
    gateway:
      discovery:
          locator:
              enabled: true # 开启自动路由
      routes:
        - id: gateway-service
          uri: lb://target
          predicates:
            - Path=/gateway/**
          filters:
            - StripPrefix=1
            - AddRequestHeader=test_header, damon0806

当我们执行上述 Ajax 请求时，请求会被网关转发到 lb://target/getUserList 上。

五、Gateway网关总结

Gateway网关作为微服务架构中的关键组件，承担着诸多重要任务，为整个系统提供了一种高效、可靠的服务入口。以下是对Gateway网关的总结：

要点要点详细内容
统一入口Gateway网关为微服务提供了一个统一的入口，客户端通过与网关交互，无需直接访问每个微服务，简化了服务调用的复杂性。
路由与负载均衡Gateway能够根据路由规则将请求动态转发到不同的微服务实例，同时支持负载均衡，提高了系统的可用性和性能。
过滤器与拦截通过过滤器，Gateway网关能够在请求进入网关或响应离开网关时执行一系列操作，如鉴权、认证、日志记录等，增强了系统的安全性和可维护性。
熔断与异常处理Gateway网关支持熔断器机制，能够处理微服务的异常情况，避免故障的扩散。统一的异常处理机制提高了系统的稳定性和用户体验。
协议转换与透明性Gateway网关允许协议的转换，为微服务提供了透明的通信机制。这使得微服务之间可以使用不同的通信协议，提高了系统的灵活性。
集中式管理Gateway网关提供了集中管理微服务的能力，可以在一个地方配置和管理所有微服务的路由规则和过滤器，降低了系统的维护成本。
性能监控与日志记录Gateway网关可以通过集成性能监控工具和记录详细日志，帮助开发人员更好地了解系统的运行状况，方便进行性能优化和故障排查。

综上所述，Gateway网关在微服务架构中扮演了不可或缺的角色，通过集中化管理、智能路由和强大的过滤器机制，为构建高效、可扩展的微服务系统提供了有力支持。其优势在于简化了开发、提高了系统的可维护性，并在面对复杂的微服务架构时提供了一种优雅的解决方案。

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

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

相关文章

大蟒蛇（Python）笔记（总结，摘要，概括）——第5章 if 语句

大蟒蛇（Python）笔记（总结，摘要，概括）——第5章 if 语句

目录 5.1 一个简单的示例 5.2 条件测试 5.2.1 检查是否相等 5.2.2 如何在检查是否相等时忽略大小写 5.2.3 检查是否不等 5.2.4 数值比较 5.2.5 检查多个条件 5.2.6 检查特定的值是否在列表中 5.2.7 检查特定的值是否不在列表中 5.2.8 布尔表达式 5.3 if 语句 5.3.1 简单的if…
阅读更多...
【视频编解码】M-JPEG压缩、H.264压缩 对比

【视频编解码】M-JPEG压缩、H.264压缩 对比

简介 参考这篇文章&#xff1a;https://blog.csdn.net/qq_41248872/article/details/83590337 写的比较好&#xff0c;这里就不赘述了。 我们在视频传输的时候&#xff0c;需要压缩&#xff0c;常见的压缩包括: jpeg 压缩h264 压缩 当然使用最多的还是 264, 毕竟他的压缩比…
阅读更多...
游戏配置二级缓存一致性问题解决方案

游戏配置二级缓存一致性问题解决方案

游戏服务器进程在启动的时候&#xff0c;一般会把所有策划配置数据加载到内存里&#xff0c;将主键以及对应的记录存放在一个HashMap容器里&#xff0c;这称为一级缓存。部分功能可能还需要缓存其他数据&#xff0c;这些称为二级缓存。举个例子&#xff0c;对于如下的玩家升级表…
阅读更多...
QT-模拟电梯上下楼

QT-模拟电梯上下楼

QT-模拟电梯上下楼 一、演示效果二、核心程序三、下载链接 一、演示效果 二、核心程序 #include "ElevatorController.h" #include <QGridLayout> #include <QLabel> #include <QGroupBox> #include <QGridLayout> #include <QPushButto…
阅读更多...
采用uniapp实现的银行卡卡片, 支持H5和微信小程序

采用uniapp实现的银行卡卡片, 支持H5和微信小程序

采用uniapp-vue3实现的银行卡卡片 支持H5、微信小程序&#xff08;其他小程序未测试过&#xff0c;可自行尝试&#xff09; 可用于参考学习 可到插件市场下载尝试&#xff1a; https://ext.dcloud.net.cn/plugin?id16736 使用示例
阅读更多...
crontab history查看命令的执行时间

crontab history查看命令的执行时间

crontab crontab学习网站&#xff08;19. crontab 定时任务 — Linux Tools Quick Tutorial&#xff09; 例子 今天实际工作里用到的&#xff08;已经进行了防信息泄露处理 比如我现在希望每周三上午10:00之行一个php脚本 --gpt生成 00 10 * * 3 cd /home/user/project/r…
阅读更多...
5、电源管理入门之 arm-scmi和mailbox核间通信

5、电源管理入门之 arm-scmi和mailbox核间通信

目录 1. 整体架构介绍 2 Linux中reset模块 2.1 Reset consumer 2.2 Reset provider 3. Linux SCMI reset通信 3.1 SCMI reset协议初始化 3.2 SCMI reset消息收发 4. SCP中reset 4.1 固件新增module 4.2 scmi_reset_domain初始化 4.3 scmi_reset_domain消息处理 4.3…
阅读更多...
Windows / Linux dir 命令

Windows / Linux dir 命令

Windows / Linux dir 命令 1. dir2. dir *.* > data.txt3. dir - list directory contentsReferences 1. dir 显示目录的文件和子目录的列表。 Microsoft Windows [版本 10.0.18363.900] (c) 2019 Microsoft Corporation。保留所有权利。C:\Users\cheng>dir驱动器 C 中…
阅读更多...
《图解设计模式》笔记（一）适应设计模式

《图解设计模式》笔记（一）适应设计模式

图灵社区 - 图解设计模式 - 随书下载 评论区 雨帆 2017-01-11 16:14:04 对于设计模式&#xff0c;我个人认为&#xff0c;其实代码和设计原则才是最好的老师。理解了 SOLID&#xff0c;如何 SOLID&#xff0c;自然而然地就用起来设计模式了。Github 上有一个 tdd-training&…
阅读更多...
Android的ViewModel

Android的ViewModel

前言 在Compose的学习中&#xff0c;我们在可组合函数中使用rememberSaveable​​​​​​​保存应用数据&#xff0c;但这可能意味着将逻辑保留在可组合函数中或附近。随着应用体量不断变大&#xff0c;您应将数据和逻辑从可组合函数中移出。 而在之前的应用架构学习中&…
阅读更多...
Duilib显示gif颜色背景与原图不符GifUI

Duilib显示gif颜色背景与原图不符GifUI

//xml <GifUI name"gif_option_new" float"true" pos"608,28,0,0" width"28" height"14" gif"new.gif"/>遇到两个问题。 1、图片背景只有第一帧显示&#xff0c;每一帧的背景色一样&#xff0c;字不同&…
阅读更多...
FISCO BCOS（十七）利用脚本进行区块链系统监控

FISCO BCOS（十七）利用脚本进行区块链系统监控

要利用脚本进行区块链系统监控&#xff0c;你可以使用各种编程语言编写脚本&#xff0c;如Python、Shell等 利用脚本进行区块链系统监控可以提高系统的稳定性、可靠性&#xff0c;并帮助及时发现和解决潜在问题&#xff0c;从而确保区块链网络的正常运行。本文可以利用脚本来解…
阅读更多...
Redis-内存管理

Redis-内存管理

Redis是基于内存存储的&#xff0c;非关系型&#xff0c;键值对数据库。因此&#xff0c;对Redis来说&#xff0c;内存空间的管理至关重要。那Redis是如何内存管理的呢&#xff1f; 一、最大内存限制 Redis 提供了 maxmemory 参数允许用户设置 Redis 可以使用的最大内存大小。…
阅读更多...
【2024.02.22】定时执行专家 V7.0 发布 - TimingExecutor V7.0 Release - 龙年春节重大更新版本

【2024.02.22】定时执行专家 V7.0 发布 - TimingExecutor V7.0 Release - 龙年春节重大更新版本

目录 ▉ 新版本 V7.0 下载地址 ▉ V7.0 新功能 ▼2024-02-21 V7.0 - 更新日志▼ ▉ V7.0 新UI设计 ▉ 新版本 V7.0 下载地址 BoomWorks软件的最新版本-CSDN博客文章浏览阅读10w次&#xff0c;点赞9次&#xff0c;收藏41次。▉定时执行专家—毫秒精度、专业级的定时任务执行…
阅读更多...
psp游戏存档收集SAVEDATA

psp游戏存档收集SAVEDATA

不想从头开始 ppsspp存档目录 pc&#xff1a;ppsspp解压目录\memstick\PSP\SAVEDATA 安卓&#xff1a;根目录\PSP\SAVEDATA 噬神者2(日版) NPJH50832099c645531020001000 風燐-https://wwl.lanzouq.com/iI1R01owozxa 咲夜-https://wwl.lanzouq.com/id1tX1owp2uf につてのぬ…
阅读更多...
Laravel01 课程介绍以及Laravel环境搭建

Laravel01 课程介绍以及Laravel环境搭建

Laravel01 课程介绍 1. Laravel2. mac开发环境搭建(通过Homebrew)3. 创建一个项目 1. Laravel 公司中面临着PHP项目与Java项目并行&#xff0c;所以需要我写PHP的项目&#xff0c;公司用的框架就是Laravel&#xff0c;所以在B站上找了一门课学习。 Laravel中文文档地址 https…
阅读更多...
(っ•̀ω•́)っ 如何在PPT中为文本框添加滚动条

(っ•̀ω•́)っ 如何在PPT中为文本框添加滚动条

本人在写技术分享的PPT时&#xff0c;遇到问题&#xff1a;有一大篇的代码&#xff0c;如何在一张PPT页面上显示&#xff1f;急需带有滚动条的文本框&#xff01;百度了不少&#xff0c;自己也来总结一篇&#xff0c;如下&#xff1a; 1、找到【文件】-【选项】 2、【自定义功…
阅读更多...
数据库管理-第153期 Oracle Vector DB AI-05（20240221）

数据库管理-第153期 Oracle Vector DB AI-05（20240221）

数据库管理153期 2024-02-21 数据库管理-第153期 Oracle Vector DB & AI-05&#xff08;20240221&#xff09;1 Oracle Vector的其他特性示例1&#xff1a;示例2 2 简单使用Oracle Vector环境创建包含Vector数据类型的表插入向量数据 总结 数据库管理-第153期 Oracle Vecto…
阅读更多...
如何修改docker容器的端口映射

如何修改docker容器的端口映射

要修改 Docker 容器的端口映射&#xff0c;你需要停止并删除现有的容器&#xff0c;然后使用新的端口映射重新运行容器。以下是详细步骤&#xff1a; 停止容器&#xff1a; 使用 docker stop 命令停止正在运行的容器。替换 <container_id> 为你要停止的容器的 ID 或者容器…
阅读更多...
物联网在智慧景区中的应用：提升游客体验与运营效率

物联网在智慧景区中的应用：提升游客体验与运营效率

目录 一、物联网技术概述 二、物联网在智慧景区中的应用 1、智能门票系统 2、智能导览系统 3、智能安全监控系统 4、智能环保系统 三、物联网在智慧景区中提升游客体验 1、提高游览便捷性 2、个性化服务体验 3、提升游客安全感 四、物联网在智慧景区中提升运营效率 …
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023