从零开始 Spring Cloud 7：Gateway

从零开始 Spring Cloud 7：Gateway

image-20230714102655393

图源：laiketui.com

Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

网关的核心功能特性：

  • 请求路由
  • 权限控制
  • 限流

架构图：

image-20210714210131152

权限控制：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。

路由和负载均衡：一切请求都必须先经过gateway，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务有多个时，还需要做负载均衡。

限流：当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大。

在SpringCloud中网关的实现包括两种：

  • gateway
  • zuul

Zuul是基于Servlet的实现，属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能。

下面我们看如何用 gateway 作为项目的网关。

本文的示例代码在前文的示例项目基础上进行修改。

基础

需要先为网关创建一个单独的子模块 gateway。

添加依赖

<dependencies><!--网关--><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-gateway</artifactId></dependency><!--nacos服务发现依赖--><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId></dependency>
</dependencies>

这里添加 nacos 的服务发现依赖是必须的，因为网关负责将用户请求转发到具体的微服务实例，所以必须要能够用服务名称从服务的注册中心（这里是 Nacos）获取到关联的微服务实例地址。

添加启动类

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

添加配置文件

server:port: 10010
spring:application:name: gatewaycloud:nacos:server-addr: localhost:8848gateway:routes:- id: shopping-useruri: lb://shopping-userpredicates:- Path=/user/**- id: shopping-orderuri: lb://shopping-orderpredicates:- Path=/order/**

配置中包含两部分，一部分是连接 Nacos 所需的配置信息，包括 Nacos 服务地址、应用名称等。另一部分是 Gateway 所需的配置。

Gateway 配置主要是 routes 配置项，它代表 Gateway 的路由规则。这个配置项是一个列表，每一个元素包含3个属性：

  • id，路由的id，必须唯一。
  • uri，路由对应的微服务地址。lb://表示用负载均衡（load balance）的方式访问目标服务。也可以直接指定具体微服务实例的地址，比如http://localhost:8081。
  • predicates：断言。只有请求的路径符合断言，才会被路由到目标微服务。

测试

启动项目的所有子模块后，反问 http://localhost:10010/order/101 和 http://localhost:10010/user/1，这说明 Gateway 服务已经生效。

路由断言工厂

路由断言工厂（Route Predicate Factory）是 Spring Cloud 中的一系列类，它们有一个共同的抽象基类org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory。

其用途是读取配置文件中的 predicates 配置内容，并用其生成可以直接判断true或者false的Predicate对象，以便 Gateway 在对请求进行路由处理时提供判断依据。

Spring Cloud Gateway 默认提供以下路由工厂：

名称说明示例
After是某个时间点后的请求- After=2037-01-20T17:42:47.789-07:00[America/Denver]
Before是某个时间点之前的请求- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
Between是某两个时间点之前的请求- Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]
Cookie请求必须包含某些cookie- Cookie=chocolate, ch.p
Header请求必须包含某些header- Header=X-Request-Id, \d+
Host请求必须是访问某个host（域名）- Host=.somehost.org,.anotherhost.org
Method请求方式必须是指定方式- Method=GET,POST
Path请求路径必须符合指定规则- Path=/red/{segment},/blue/**
Query请求参数必须包含指定参数- Query=name, Jack或者- Query=name
RemoteAddr请求者的ip必须是指定范围- RemoteAddr=192.168.1.1/24
Weight权重处理

每种路由工厂处理不同的路由断言，比如PathRoutePredicateFactory就用于处理之前我们使用的Path=xxx这种路由断言。

再比如，如果我们需要限制某个微服务的请求需要在某个时间点之后才能路由（访问），可以：

spring:cloud:gateway:routes:- id: shopping-useruri: lb://shopping-userpredicates:- Path=/user/**- After=2023-07-20T17:42:47.789+08:00[Asia/Shanghai]

这里的2023-07-20T17:42:47.789是格林尼治时间，所以要+08:00（上海是东八区）。

各种路由断言工厂对应的断言配置写法，可以参考官方文档。

网关过滤器

可以在 Gateway 中添加网关过滤器（Gateway Filter），其用途是改变请求或返回信息。

Gateway 的网关过滤器的用途与 Spring Boot 的过滤器用途是类似的。

网关过滤器的工作原理可以用下图表示：

image-20210714212312871

网关过滤器分为三种：

  • 具体路由的过滤器
  • 默认路由的过滤器
  • 全局过滤器

下面依次介绍其功能和用法。

具体路由的过滤器

具体路由的过滤器的使用方式与路由断言类似，都是在配置文件中定义，并由预定义的网关过滤器工厂（Gateway Filter Factory）类来进行处理。

Spring Cloud Gateway 提供了多种类型的网关过滤器工厂，下面是部分：

名称说明
AddRequestHeader给当前请求添加一个请求头
RemoveRequestHeader移除请求中的一个请求头
AddResponseHeader给响应结果中添加一个响应头
RemoveResponseHeader从响应结果中移除有一个响应头
RequestRateLimiter限制请求的流量

完整的列表可以参考官方文档。

下面通过使用AddRequestHeader过滤器给请求信息添加请求头来说明如何使用。

在子模块 gateway 的配置文件中为相关路由添加过滤器：

spring:cloud:gateway:routes:- id: shopping-useruri: lb://shopping-userpredicates:- Path=/user/**filters:- AddRequestHeader=X-Request-color, blue

这里的AddRequestHeader=X-Request-color, blue意思是为路由添加一个AddRequestHeader过滤器工厂创建的过滤器，其用途是对所有通过 gateway 对 lb://shopping-user/user/** 的访问都添加上一个头信息X-Request-color=blue。

这里用,作为请求头的 key 和 value 的分隔符。

修改子模块 shopping-user 的 Controller，从请求中获取头信息 X-Request-color 并打印：

public class UserController {// ...@GetMapping("/{id}")public Result<User> getUserInfo(@Min(1) @NotNull @PathVariable Long id,@RequestHeader(value = "X-Request-color", required = false) String color) {System.out.println(String.format("color:%s", color));return Result.success(userService.findUserById(id));}
}

这里使用 Spring MVC 的注解@RequestHeader可以很方便地获取请求头信息。

重启所有微服务。

现在请求 http://localhost:10010/user/1，就能看到某个 shopping-user 实例的控制台输出color:blue。

这个过滤器仅对所在的路由起作用，所以如果请求 http://localhost:10010/order/101，是不会给请求添加新的请求头的。

此外还需要注意的是，过滤器仅对通过 Gateway 发起的请求有效，所以直接请求服务实例（比如 http://localhost:8081/user/1），同样不会生效。

默认路由的过滤器

如果我们需要为所有 Gateway 管理的路由添加一个过滤器，可以使用默认路由的过滤器：

spring:cloud:gateway:routes:- id: shopping-useruri: lb://shopping-userpredicates:- Path=/user/**- After=2023-07-20T17:42:47.789+08:00[Asia/Shanghai]filters:- AddRequestHeader=X-Request-color, blue- id: shopping-orderuri: lb://shopping-orderpredicates:- Path=/order/**default-filters:- AddRequestHeader=X-Request-msg, Hello world!

这里使用了一个配置项default-filters，让所有经过 Gateway 路由的请求都添加了一个请求头X-Request-msg。

可以用之前的方式进行验证，这里不再赘述。

全局过滤器

前面两种过滤器都只能通过修改配置文件来使用 Gateway 定义好的过滤器工厂，如果要自己定义过滤器的处理规则，就需要使用全局过滤器（Global Filter）：

package org.springframework.cloud.gateway.filter;
public interface GlobalFilter {Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

下面举例进行说明其用法。

在子模块 gateway 中添加一个类，并实现GlobalFilter接口：

@Component
@Order(1)
public class AuthrizeFilter implements GlobalFilter {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {return null;}
}

要让自定义的过滤器生效，必须将其注册为一个 bean，所以这里使用了@Component注解。

其次，如果存在多个自定义过滤器，就可能需要控制过滤器的执行顺序，所以这里添加@Order注解来指定过滤器的执行顺序。

  • 和 AOP 编程中为 Aspect 指定顺序一样，除了使用@Order注解，还可以实现Ordered接口。
  • Mono是 Java 响应式编程中定义的一个类型。

下面我们实现filter方法，可以通过exchange参数获取和变更请求和响应信息，并通过chain参数“推动”过滤器链，让控制流转到下一个过滤器：

@Component
@Order(1)
public class AuthrizeFilter implements GlobalFilter {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {MultiValueMap<String, String> queryParams = exchange.getRequest().getQueryParams();String auth = queryParams.getFirst("auth");if ("admin".equals(auth)){return chain.filter(exchange);}ServerHttpResponse response = exchange.getResponse();response.setStatusCode(HttpStatus.UNAUTHORIZED);return response.setComplete();}
}

重启子模块 gateway，访问 http://localhost:10010/order/101，此时浏览器会显示页面错误，错误代码是401。

HttpStatus.UNAUTHORIZED对应的就是 HTTP 错误码 401，意思是身份验证出错。

现在所有经过 Gateway 路由的请求，只有存在查询参数auth，并且值是admin的请求才会通过过滤器转发到相应的微服务，比如请求 http://localhost:10010/order/101?auth=admin。

执行顺序

全局过滤器的执行顺序由@Order注解或者Ordered接口指定。具体路由的过滤器和默认路由的过滤器由其定义的顺序决定。Gateway 会按照其定义的顺序从1开始分配序号。

也就是说，下面这种情况下，存在的三种过滤器的序号都是1：

spring:cloud:gateway:routes:- id: shopping-useruri: lb://shopping-userpredicates:- Path=/user/**- After=2023-07-20T17:42:47.789+08:00[Asia/Shanghai]filters:- AddRequestHeader=X-Request-color, blue- id: shopping-orderuri: lb://shopping-orderpredicates:- Path=/order/**default-filters:- AddRequestHeader=X-Request-msg, Hello world!

@Component
@Order(1)
public class AuthrizeFilter implements GlobalFilter {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {// ...}
}

过滤器的工作过程是：对于某一个请求，将先匹配路由，匹配到路由后获取这个路由可以使用的所有过滤器（包括上面介绍的三种过滤器），然后按照过滤器序号进行排序并组成过滤器链后依次执行。如果存在过滤器种类不同，但序号相同的情况，会按照默认路由过滤器 > 具体路由过滤器 > 全局过滤器的顺序进行排序。

跨域问题

因为安全原因，浏览器在向服务端发送 AJAX 请求时，会检查当前页面的域名和端口号是否与目标服务的域名及端口号一致，如果不一致，默认会禁止请求的发送和接收。这就是所谓的“跨域问题”。

在企业开发中，通常前端框架与后端框架是单独部署的，所以必然会处在不同的域名和端口号下，所以一般我们都要解决跨域的问题。

  • 也可以考虑将前端和后端用 Web Service 反向代理到同一个域名和端口下。
  • 解决跨域有多种方案，这里讨论如何用 CORS 解决跨域问题。

在我们当前的项目中，因为我们使用了统一网关 Gateway，理论上所有用户请求都是通过 Gateway 路由和转发的，所以我们只需要处理浏览器对子模块 gateway 的跨域问题即可。

下面用实例说明如何在项目中解决跨域问题。

为了能够进行验证，首先我们需要利用 Web Service 运行一个与服务端端口不同的前端页面。

这里我使用的是 Nginx，配置如下：

    server {listen       8100;server_name  localhost;location / {root   html/test;index  index.html index.htm;}}

在 Nginx 的根目录下的 html 目录中添加一个 test 目录，在其中添加一个 index.html 文件：

<!DOCTYPE html>
<html lang="en">
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
<script>axios.get("http://localhost:10010/user/1?auth=admin").then(resp => console.log(resp.data)).catch(err => console.log(err))
</script>
</html>

这个 html 文件只包含一个 AJAX 调用，显然是跨域的。因为运行页面的服务端口号是 8100，这个 AJAX 调用请求的服务端口号是 10010（也就是 Gateway 运行的实例地址）。

用浏览器请求 http://localhost:8100/ 可以看到控制台输出类似下面的内容：

Access to XMLHttpRequest at 'http://localhost:10010/user/1?auth=admin' from origin 'http://localhost:8100' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.

说的很清楚，AJAX 请求被 CORS 规则阻止，因为服务端并没有按照约定返回 Access-Control-Allow-Origin 头信息来允许跨域访问。

修改子模块 gateway 的配置文件，以允许 CORS 跨域：

spring:cloud:gateway:globalcors: # 全局的跨域处理# ...add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题corsConfigurations:'[/**]':allowedOrigins: # 允许哪些网站的跨域请求- "http://localhost:8100"allowedMethods: # 允许的跨域ajax的请求方式- "GET"- "POST"- "DELETE"- "PUT"- "OPTIONS"allowedHeaders: "*" # 允许在请求中携带的头信息allowCredentials: true # 是否允许携带cookiemaxAge: 360000 # 这次跨域检测的有效期,单位 秒

重启子模块 gateway 后再访问 http://localhost:8100/ 就会发现已经可以正常访问，控制台正确输出了返回信息。

有一个 JS 报错，不影响测试，忽略即可。

The End，谢谢阅读。

可以从这里获取本文的完整示例代码。

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

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

相关文章

ICC2删除所有电源的方法

ICC2删除所有电源的方法

我正在「拾陆楼」和朋友们讨论有趣的话题&#xff0c;你⼀起来吧&#xff1f;知识星球入口 remove_pg_patterns -all remove_pg_strategies -all remove_pg_strategy_via_rules -all remove_pg_via_master_rules -all remove_pg_regions -all remove_routes -net_types {p…
阅读更多...
网安周报 | 银行业成为开源软件供应链攻击的目标

网安周报 | 银行业成为开源软件供应链攻击的目标

网安周报是棱镜七彩推出的安全资讯专栏&#xff0c;旨在通过展示一周内发生的与开源安全、软件供应链安全相关攻击事件&#xff0c;让用户了解开源及软件供应链威胁&#xff0c;提高对安全的重视&#xff0c;做好防御措施。 1、银行业成为开源软件供应链攻击的目标 网络安全研…
阅读更多...
微服务入门---SpringCloud（二）

微服务入门---SpringCloud（二）

微服务入门---SpringCloud&#xff08;二&#xff09; 1.Nacos配置管理1.1.统一配置管理1.1.1.在nacos中添加配置文件1.1.2.从微服务拉取配置 1.2.配置热更新1.2.1.方式一1.2.2.方式二 1.3.配置共享1&#xff09;添加一个环境共享配置2&#xff09;在user-service中读取共享配置…
阅读更多...
vue2+wangEditor5富文本编辑器（图片视频自定义上传七牛云/服务器）

vue2+wangEditor5富文本编辑器（图片视频自定义上传七牛云/服务器）

1、安装使用 安装 yarn add wangeditor/editor # 或者 npm install wangeditor/editor --save yarn add wangeditor/editor-for-vue # 或者 npm install wangeditor/editor-for-vue --save在main.js中引入样式 import wangeditor/editor/dist/css/style.css在使用编辑器的页…
阅读更多...
Android 截图功能实现

Android 截图功能实现

Android 截图功能实现 简介效果图功能实现1. 截取当前可见范围屏幕2. 截取当前可见范围屏幕&#xff08;不包含状态栏&#xff09;3. 截取某个控件4. 截取ScrollView5. 长截图6. 截屏动画效果7. 显示截屏结果&#xff0c;自动消失6. 完整代码 简介 在Android应用中开发截图功能…
阅读更多...
顺序表的实现

顺序表的实现

文章目录 1.概念及结构 2.接口实现 3.数组相关oj题 4.顺序表的问题及思考 文章内容 1.概念及结构 线性表&#xff08;linear list&#xff09;是n个具有相同特性的数据元素的有限序列。 线性表是一种在实际中广泛使 用的数据结构&#xff0c;常见的线性表&#xff1a;顺序…
阅读更多...
【物理】模拟粒子在电场和磁场中的轨迹研究（Matlab代码实现）

【物理】模拟粒子在电场和磁场中的轨迹研究（Matlab代码实现）

目录 &#x1f4a5;1 概述 &#x1f4da;2 运行结果 &#x1f389;3 参考文献 &#x1f308;4 Matlab代码实现 &#x1f4a5;1 概述 模拟粒子在电场和磁场中的轨迹研究是物理学中的一个重要研究领域&#xff0c;涉及到电磁场、粒子运动、轨迹分析等多个方面。在这个研究中&…
阅读更多...
Python爬虫实例之淘宝商品页面爬取（api接口）

Python爬虫实例之淘宝商品页面爬取（api接口）

可以使用Python中的requests和BeautifulSoup库来进行网页爬取和数据提取。以下是一个简单的示例&#xff1a; import requests from bs4 import BeautifulSoupdef get_product_data(url):# 发送GET请求&#xff0c;获取网页内容headers {User-Agent: Mozilla/5.0 (Windows NT…
阅读更多...
【Spring框架】Spring读取与存储综合练习

【Spring框架】Spring读取与存储综合练习

练习 在 Spring 项⽬中&#xff0c;通过 main ⽅法获取到 Controller 类&#xff0c;调⽤ Controller ⾥⾯通过注⼊的⽅式调⽤ Service 类&#xff0c;Service 再通过注⼊的⽅式获取到 Repository 类&#xff0c;Repository 类⾥⾯有⼀个⽅法构建⼀个 User 对象&#xff0c;返…
阅读更多...
抖音账号矩阵系统开发源码

抖音账号矩阵系统开发源码

一、技术自研框架开发背景&#xff1a; 抖音账号矩阵系统是一种基于数据分析和管理的全新平台&#xff0c;能够帮助用户更好地管理、扩展和营销抖音账号。 部分源码分享&#xff1a; ic function indexAction() { //面包屑 $breadcrumbs [ [tit…
阅读更多...
虚拟机 RHEL8 安装 MySQL 8.0.34

虚拟机 RHEL8 安装 MySQL 8.0.34

目录 安装步骤一、清除所有残留的旧MySQL二、安装MySQL 报错问题1. 提示未找到匹配的参数&#xff1a; mysql-community-server2. 公钥问题 安装步骤 一、清除所有残留的旧MySQL 1. 关闭MySQL [rootlocalhost /]# service mysqld stop Redirecting to /bin/systemctl stop …
阅读更多...
【导入外部jar包到maven项目中--亲测可行】

【导入外部jar包到maven项目中--亲测可行】

若项目为springweb项目&#xff0c;则先将jar放到WEB-INF/lib 目录下选中对应的jar包&#xff0c;右键选项 add-lirrary &#xff1b;成功加入之后的jar包是一个项目的目录结构&#xff1a; 至此&#xff0c;项目能够正常运行&#xff0c;在代码周也能够进行导包 转折点&…
阅读更多...
一文谈谈Git

一文谈谈Git

"And if forever lasts till now Alright" 为什么要有git&#xff1f; 想象一下&#xff0c;现如今你的老师同时叫你和张三&#xff0c;各自写一份下半年的学习计划交给他。 可是你的老师是一个极其"较真"的人&#xff0c;发现你俩写的学习计划太"水&…
阅读更多...
QT：当登录成功时，关闭登录界面，跳转到新的界面中

QT：当登录成功时，关闭登录界面，跳转到新的界面中

1> 继续完善登录框&#xff0c;当登录成功时&#xff0c;关闭登录界面&#xff0c;跳转到新的界面中 widget.h #include "widget.h" //#include "ui_widget.h"Widget::Widget(QWidget *parent): QWidget(parent)//, ui(new Ui::Widget) {//ui->setu…
阅读更多...
使用python部署chineseocr_lite

使用python部署chineseocr_lite

使用python部署chineseocr_lite 简介安装报错解决python调用结果 简介 项目地址&#xff1a;https://github.com/DayBreak-u/chineseocr_lite chineseocr_lite 是一个开源项目&#xff0c;用来实现中文的文字识别&#xff0c;支持竖排文字识别、繁体识别&#xff0c;总模型只…
阅读更多...
某制造企业基于 KubeSphere 的云原生实践

某制造企业基于 KubeSphere 的云原生实践

背景介绍 随着业务升级改造与软件产品专案的增多&#xff0c;常规的物理机和虚拟机方式逐渐暴露出一些问题&#xff1a; 大量服务部署在虚拟机上&#xff0c;资源预估和硬件浪费较大&#xff1b;大量服务部署在虚拟机上&#xff0c;部署时间和难度较大&#xff0c;自动化程度…
阅读更多...
加利福尼亚大学｜3D-LLM：将3D世界于大规模语言模型结合

加利福尼亚大学｜3D-LLM：将3D世界于大规模语言模型结合

来自加利福尼亚大学的3D-LLM项目团队提到&#xff1a;大型语言模型 (LLM) 和视觉语言模型 (VLM) 已被证明在多项任务上表现出色&#xff0c;例如常识推理。尽管这些模型非常强大&#xff0c;但它们并不以 3D 物理世界为基础&#xff0c;而 3D 物理世界涉及更丰富的概念&#xf…
阅读更多...
Mybatis 新增/批量新增， 拿到返回的自增主键ID

Mybatis 新增/批量新增， 拿到返回的自增主键ID

单个新增 &#xff1a; /** * 插入菜单 * param menuInfo * return */ int insertMenuInfo(MenuInfo menuInfo); xml&#xff1a; <insert id"insertMenuInfo" parameterType"com.XXXX..MenuInfo" keyProperty"id&quo…
阅读更多...
GoogleLeNet V2 V3 —— Batch Normalization

GoogleLeNet V2 V3 —— Batch Normalization

文章目录 Batch Normalizationinternal covariate shift激活层的作用BN执行的位置数据白化网络中的BN层训练过程 BN的实验效果MNIST与GoogleLeNet V1比较 GoogleLeNet出来之后&#xff0c;Google在这个基础上又演进了几个版本&#xff0c;一般来说是说有4个版本&#xff0c;之前…
阅读更多...
Redis 数据库的高可用

Redis 数据库的高可用

文章目录 一.Redis 数据库的持久化1.Redis 高可用概念2.Redis 实现高可用的技术2.1 持久化2.2 主从复制2.3 哨兵2.4 Cluster集群 3.Redis 持久化3.1 持久化的功能3.2 Redis 提供持久化的方式3.2.1 RDB 持久化3.2.2 AOF 持久化&#xff08;append only file&#xff09; 3.3 RDB…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023