Spring Cloud Gateway教程

1 微服务网关概述

Spring Cloud Gateway是在 Spring 生态系统之上构建的API网关服务，旨在为微服务架构应用提供一种简单有效的统一的API路由管理方式。

Spring Cloud Gateway主要功能：

  • 反向代理
  • 认证鉴权
  • 流量控制
  • 熔断
  • 日志监控

2 Spring Cloud Gateway三大核心概念

  • 路由（Route）：它由一个 ID、一个目标 URI、断言集合和过滤器集合。如果断言为真，则路由匹配。
  • 断言（Predicate）：参考的是 Java8 的 java.util.function.Predicate，开发人员可以匹配 HTTP 请求中的所有内容（例如请求头或请求参数），如果与断言相匹配则进行路由。
  • 过滤器（Filter）：指的是 GatewayFilter 实例，可以在请求被路由之前或之后修改请求和响应。

3 Spring Cloud Gateway工作流程

客户端向 Spring Cloud Gateway 发出请求。然后在 Gateway Handler Mapping 中找到与请求相匹配的路由，将其发送到 Gateway Web Handler。Handler 再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。

过滤器被虚线分开的原因是过滤器可以在发送代理请求之前（pre）和之后（post）运行逻辑。执行所有“pre”过滤器逻辑。然后发出代理请求。在发出代理请求之后，运行“post”过滤器逻辑。

总结：断言判断–>路由转发–>执行过滤器链

4 Spring Cloud Gateway网关微服务开发

  1. 新建网关微服务模块
  2. 修改pom文件，引入依赖
  3. 修改yml文件和主启动类，在Consul中进行服务注册

4.1 引入依赖

<dependencies>
    <!--Spring Cloud Gateway-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    <!--Consul服务注册-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-consul-discovery</artifactId>
    </dependency>
    <!--指标监控健康检查的actuator-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
</dependencies>

4.2 网关微服务注册

server:
  port: 9527 # 网关服务端口

spring:
  application:
    name: gateway-service # 网关服务名称
  cloud:
    consul:
      host: 47.120.52.144 # Consul服务地址
      port: 8500 # Consul服务端口
      discovery:
        prefer-ip-address: true # 服务注册时优先使用IP地址而不是主机名
        service-name: ${spring.application.name} # 在Consul中注册的服务名称
        heartbeat:
          enabled: true # 启用心跳检测，定期检查服务健康状态

@SpringBootApplication
@EnableDiscoveryClient // 服务注册
public class Gateway9527 {
    public static void main(String[] args) {
        SpringApplication.run(Gateway9527.class, args);
    }
}

服务注册使用了 Consul，如果要使用 Nacos 进行服务注册，修改 pom 文件中的依赖和 yml 文件中的配置！

image-20240308150657584

4.3 路由配置

假设场景，商城系统用户下单支付。

Consul注册中心8500
订单微服务8001
网关微服务9527
支付微服务8002
用户

网关微服务yml配置：

spring:
  gateway:
    routes:
      - id: order-route # 路由ID，没有固定规则但要求唯一，建议配合服务名
        uri: http://localhost:8001 # 路由转发地址
        predicates:
          - Path=/gateway/order/**/** # 断言，匹配请求路径
      - id: pay-route
        uri: http://localhost:8002
        predicates:
          - Path=/gateway/pay/**/**

如果要使用OpenFeign，订单微服务8001调用支付微服务8002，

Consul注册中心8500
OpenFeign
订单微服务8001
网关微服务9527
支付微服务8002
用户

服务调用链：

  1. 用户调用网关微服务9527
  2. 网关微服务9527根据配置的路由匹配到订单微服务8001
  3. 订单微服务8001根据业务需要使用OpenFeign远程调用支付微服务8002
    1. 因为支付微服务8002也需要通过网关访问，因此也要通过网关微服务9527
    2. 网关微服务9527根据配置的路由匹配到支付微服务8002，到此完成服务调用

此时，网关微服务yml配置：

spring:
  gateway:
    routes:
      - id: order-route # 路由ID，没有固定规则但要求唯一，建议配合服务名
        uri: lb://order-service # 路由转发地址，负载均衡
        predicates:
          - Path=/order/**/** # 断言，匹配请求路径
      - id: pay-route
        uri: lb://pay-service
        predicates:
          - Path=/pay/**/**
  • @FeignClient(value = “gateway-service”)注解不再使用微服务名，而是使用网关服务名称！
  • 动态获取服务URI：根据微服务名称而不是固定IP+port的方式获取URI！

Spring Cloud Gateway支持丰富的路由匹配逻辑，以应对各种类型的业务诉求：

断言示例说明
Path- Path=/httpbin/**路径与/httpbin/**匹配的请求会被转发
Cookie- Cookie=chocolate, ch.p携带Cookie且内容为chocolate=ch.p的请求会被转发
Header- Header=X-Request-Id, \d+请求有一个名为 X-Request-Id 的头，其值与 \d+ 正则表达式匹配（即它的值为一位或多位），则此路由匹配。
Method- Method=GET,POST请求方法是 GET 或 POST ，则此路由匹配。
Before- Before=2017-01-20T17:42:47.789+08:00[Asia/Shanghai]在2017年01月20日17时42分47.789秒之前的请求，才会被转发
After- Before=2017-01-20T17:42:47.789+08:00[Asia/Shanghai]在2017年01月20日17时42分47.789秒之后的请求，才会被转发
Between- Between=2017-01-20T17:42:47.789+08:00[Asia/Shanghai],2017-01-21T17:42:47.789+08:00[Asia/Shanghai]在2017年01月20日17时42分47.789秒到在2017年01月21日17时42分47.789秒之间的请求，才会被转发

4.4 过滤器配置
过滤器分类
全局过滤器GlobalFilter
网关过滤器GatewayFilter
自定义过滤器
  • 全局过滤器GlobalFilter：作用在所有路由上，不需要在配置文件中配置，实现GlobalFilter接口即可
  • 网关过滤器GatewayFilter：作用在单一路由或某个路由分组上，通过spring.cloud.gateway.routes.filters配置在具体的路由上，也可以通过配置spring.cloud.gateway.default-filters让它作用于全局路由上。
  • 自定义过滤器：

4.4.1 全局过滤器

/**
 * Contract for interception-style, chained processing of gateway requests that may be
 * used to implement cross-cutting, application-agnostic requirements such as security,
 * timeouts, and others.
 *
 * Only applies to matched gateway routes.
 *
 * Copied from framework WebFilter
 *
 * @author Rossen Stoyanchev
 * @since 5.0
 */
public interface GlobalFilter {

	/**
	 * Process the Web request and (optionally) delegate to the next {@code GatewayFilter}
	 * through the given {@link GatewayFilterChain}.
	 * @param exchange the current server exchange
	 * @param chain provides a way to delegate to the next filter
	 * @return {@code Mono<Void>} to indicate when request processing is complete
	 */
	Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);

}

4.4.2 网关过滤器

官网地址：https://docs.spring.io/spring-cloud-gateway/docs/4.0.9/reference/html/#gatewayfilter-factories。这里只列举一些常见的网关过滤器。

  1. 请求头（RequestHeader）相关

    1. AddRequestHeader
    2. RemoveRequestHeader
    3. SetRequestHeader
    spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: http://example.org
        filters:
        - AddRequestHeader=X-Request-red, blue
        - RemoveRequestHeader=X-Request-Foo
        - SetRequestHeader=X-Request-Red, Blue

  2. 请求参数（RequestParameter）相关

    1. AddRequestParameter
    2. RemoveRequestParameter
    spring:
  cloud:
    gateway:
      routes:
      - id: add_request_parameter_route
        uri: http://example.org
        filters:
        - AddRequestParameter=red, blue
        - RemoveRequestParameter=red

  3. 响应头（ResponseHeader）相关

    1. AddResponseHeader
    2. RemoveResponseHeader
    3. SetResponseHeader
    spring:
  cloud:
    gateway:
      routes:
      - id: add_response_header_route
        uri: http://example.org
        filters:
        - AddResponseHeader=X-Response-Red, Blue
        - RemoveResponseHeader=X-Response-Foo
        - SetResponseHeader=X-Response-Red, Blue

  4. 前缀和路径相关

    1. PrefixPath

      spring:
  cloud:
    gateway:
      routes:
      - id: prefixpath_route
        uri: http://example.org
        predicates:
        - Path=/red
        filters:
        - PrefixPath=/mypath

      浏览器访问地址：http://example.org/red

      实际微服务地址：http://example.org/mypath/red

    2. SetPath

      spring:
  cloud:
    gateway:
      routes:
      - id: prefixpath_route
        uri: http://example.org
        predicates:
        - Path=/red
        filters:
        - SetPath=/blue

      浏览器访问地址：http://example.org/red

      实际微服务地址：http://example.org/blue

    3. RedirectTo

      spring:
  cloud:
    gateway:
      routes:
      - id: prefixpath_route
        uri: http://example.org
        predicates:
        - Path=/red
        filters:
        - RedirectTo=302, http://www.baidu.com

      浏览器访问地址：http://example.org/red

      实际微服务地址：http://www.baidu.com

  5. 其他

    1. Default：添加过滤器用于所有路由，相当于全局过滤器。

      spring:
  cloud:
    gateway:
      default-filters:
      - AddResponseHeader=X-Response-Default-Red, Default-Blue
      - PrefixPath=/httpbin

如果调用链中再加入远程调用，调用链还是很复杂的！

4.4.3 自定义过滤器

🔔Spring Cloud Gateway自定义过滤器参考另一篇笔记

参考

  • https://mp.weixin.qq.com/s/ua_VlF30fzdMjkuKVnGhvw
  • https://www.cnblogs.com/duanxz/p/14780675.html

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

目标检测——YOLOX算法解读

目标检测——YOLOX算法解读

论文&#xff1a;YOLOX: Exceeding YOLO Series in 2021(2021.7.18) 作者&#xff1a;Zheng Ge, Songtao Liu, Feng Wang, Zeming Li, Jian Sun 链接&#xff1a;https://arxiv.org/abs/2107.08430 代码&#xff1a;https://github.com/Megvii-BaseDetection/YOLOX YOLO系列算法…
阅读更多...
爬虫案例-网站分词索引与站内搜索

爬虫案例-网站分词索引与站内搜索

文章目录 1.案例简介2.设计思路3.设计结构4.关键技术5.数据结构6.数据集合7.设计过程7.1 信息采集模块7.2 索引模块7.3 网页排名和搜索 8.示例效果 1.案例简介 本例使用Python建立一个指定网站专用的Web搜索引擎&#xff0c;它能爬取所有指定的网页信息&#xff0c;然后准确的…
阅读更多...
智慧安全：守护智慧城市的安全屏障

智慧安全：守护智慧城市的安全屏障

随着信息技术的迅猛发展&#xff0c;智慧城市已成为现代城市发展的重要方向。智慧城市通过集成应用先进的信息通信技术&#xff0c;实现城市管理、服务、运行的智能化&#xff0c;为城市的可持续发展注入了新的活力。然而&#xff0c;在智慧城市的建设过程中&#xff0c;安全问…
阅读更多...
综合案例-淘宝轮播图

综合案例-淘宝轮播图

代码&#x1f447; <!DOCTYPE html><html lang"en" xmlns"http://www.w3.org/1999/xhtml"> <head><meta charset"utf-8" /><title>淘宝轮播图</title><style>*{margin:0px;padding:0px;}.tb-promo {…
阅读更多...
流畅的 Python 第二版（GPT 重译）（四）

流畅的 Python 第二版（GPT 重译）（四）

第二部分&#xff1a;函数作为对象 第七章&#xff1a;函数作为一等对象 我从未认为 Python 受到函数式语言的重大影响&#xff0c;无论人们说什么或想什么。我更熟悉命令式语言&#xff0c;如 C 和 Algol 68&#xff0c;尽管我将函数作为一等对象&#xff0c;但我并不认为 Py…
阅读更多...
Java 设计模式系列：行为型-中介者模式

Java 设计模式系列：行为型-中介者模式

简介 中介者模式是一种行为型设计模式&#xff0c;它定义了一个中介对象&#xff0c;用于简化对象之间的交互。中介者模式通过引入一个中介对象来解耦多个对象之间的交互&#xff0c;使得这些对象可以独立地改变和复用。 中介者模式的适用场景包括多个对象之间存在复杂的引用…
阅读更多...
asp.net在线租车平台

asp.net在线租车平台

说明文档 运行前附加数据库.mdf&#xff08;或sql生成数据库&#xff09; 主要技术&#xff1a; 基于asp.net架构和sql server数据库 功能模块&#xff1a; asp.net在线租车平台 用户功能有首页 行业新闻用户注册车辆查询租车介绍访问后台 后台管理员可以进行用户管理 管…
阅读更多...
xinput1_3.dll丢失如何修复，xinput1_3.dll的安装修复教程分享

xinput1_3.dll丢失如何修复，xinput1_3.dll的安装修复教程分享

在Windows操作系统环境下&#xff0c;我们经常会遇到一些错误提示&#xff0c;其中之一就是“找不到xinput13.dll”。由于xinput1_3.dll是微软DirectX SDK的一部分&#xff0c;主要用于支持游戏手柄和其他外部设备的输入功能&#xff0c;缺失这一动态链接库文件可能导致某些依赖…
阅读更多...
【WEB3安全基建项目Secwarex】空投指南

【WEB3安全基建项目Secwarex】空投指南

GoPlusSecurity是WEB3安全基建项目&#xff0c;3月8日完成400万美元的私募融资&#xff0c;目前总融资已经高达1500万美元&#xff0c;其中包括Binance Labs、Huobi Incubator、Kucoin Ventures、Avalanche等知名机构参投。 1、打开网址&#xff1a;secwarex.io&#xff0c;点…
阅读更多...
node.js常用的命令

node.js常用的命令

Node.js 是一个用于执行 JavaScript 代码的运行时环境。以下命令是 Node.js 开发中常用的命令&#xff0c;可以帮助你进行包管理、项目配置和代码执行等操作。 node -v&#xff1a;检查 Node.js 的版本。npm -v&#xff1a;检查 npm&#xff08;Node.js 包管理器&#xff09;的…
阅读更多...
通配符ssl证书有哪几种

通配符ssl证书有哪几种

通配符SSL证书是数字证书中比较特别的一种。它可以同时保护主域名以及主域名下所有的子域名&#xff0c;对所保护的网站传输数据进行加密。在证书有效期内&#xff0c;通配符SSL证书还可以免费增加子域名站点。随着互联网的发展&#xff0c;越来越多的个人和企事业单位的开发者…
阅读更多...
01.Queue-Basic

01.Queue-Basic

1. 队列简介 队列&#xff08;Queue&#xff09;&#xff1a;一种线性表数据结构&#xff0c;是一种只允许在表的一端进行插入操作&#xff0c;而在表的另一端进行删除操作的线性表。 我们把队列中允许插入的一端称为 「队尾&#xff08;rear&#xff09;」&#xff1b;把允许删…
阅读更多...
nginx使用与配置文件

nginx使用与配置文件

nginx服务配置与配置优化 nginx服务脚本配置 mkdir wwwroot cd wwwroot/ mkdir nginx1 touch index.php vim index.php<?php echo $_SERVER["REMOTE_ADDR"]; ​ ​ vim conf/nginx.confserver {listen 80;server_name localhost;root /www/wwwroot/nginx…
阅读更多...
分布式之SleuthZipkin

分布式之SleuthZipkin

Sleuth&Zipkin 学习当前课程&#xff0c;比必须要先掌握SpringCloud的基本应用&#xff08;Nacos&#xff0c;Feign调用&#xff09; 对Docker有一定的了解&#xff0c;知道docker-compose.yml如何启动一个容器 RabbitMQ&#xff0c;Elasticsearch有一定了解。 而且学习…
阅读更多...
SQLiteC/C++接口详细介绍sqlite3_stmt类（五）

SQLiteC/C++接口详细介绍sqlite3_stmt类（五）

返回&#xff1a;SQLite—系列文章目录 上一篇&#xff1a;SQLiteC/C接口详细介绍sqlite3_stmt类&#xff08;四&#xff09;- 下一篇&#xff1a; 无 12. sqlite3_bind_text16函数 sqlite3_bind_text16函数用于将UTF-16编码的文本数据&#xff08;字符串&#xff09;绑定…
阅读更多...
HTML，子元素使用float后，导致父元素高度塌陷

HTML，子元素使用float后，导致父元素高度塌陷

HTML学习中遇到的一个任务&#xff1a;header 标签有两个元素 div&#xff08;标题&#xff09; 和 nav&#xff08;导航&#xff09;&#xff0c;希望实现的效果是标题在左侧&#xff0c;导航在右侧。 基础代码如下&#xff1a; <!DOCTYPE html> <html><head&…
阅读更多...
辐射展—2024深圳辐射监测与防护展览会

辐射展—2024深圳辐射监测与防护展览会

2024深圳辐射监测与防护展览会 展会时间&#xff1a;2024年5月15-17日 展会地点&#xff1a;深圳国际会展中心&#xff08;宝安&#xff09; 主办单位&#xff1a;广东省辐射防护协会 广东省环境监测协会 深圳中国环境监测总站技术创新研究院&#xff08;福田&#xff09;…
阅读更多...
mysql未完成事务查看

mysql未完成事务查看

因为MySQL的事务管理主要是基于InnoDB存储引擎的&#xff0c;并且事务的状态&#xff08;例如&#xff0c;是否已提交或回滚&#xff09;通常是内部的、不直接暴露给用户的,但是可以通过一些方法间接地检查或诊断与事务相关的问题 查看正在运行的事务 使用SHOW ENGINE INNODB…
阅读更多...
Flink RocksDB状态后端优化总结

Flink RocksDB状态后端优化总结

截至当前&#xff0c;Flink 作业的状态后端仍然只有 Memory、FileSystem 和 RocksDB 三种可选&#xff0c;且 RocksDB 是状态数据量较大&#xff08;GB 到 TB 级别&#xff09;时的唯一选择。RocksDB 的性能发挥非常仰赖调优&#xff0c;如果全部采用默认配置&#xff0c;读写性…
阅读更多...
小程序应用市场的前世今生

小程序应用市场的前世今生

最开始的开始&#xff0c;为软件开发者提供软件发布、运营和推广服务的平台称之为软件应用市场&#xff0c;其发展经历了以下3个阶段&#xff1a; 起源阶段&#xff1a;应用市场的起源可以追溯到桌面互联网时代&#xff0c;当时软件的开发和分发主要依靠软件网站。软件开发者可…
阅读更多...
最新文章

Copyright @ 2022~2023