Spring Cloud Gateway学习

news/2024/4/29 4:57:29/文章来源:https://blog.csdn.net/qq_39360632/article/details/129415926

文章大纲

在这里插入图片描述

为什么需要网关?

传统的单体架构只有一个服务开放给客户端调用,但是在微服务架构体系中是将一个系统拆分成多个微服务,那么作为客户端如何去调用这些微服务呢?如果没有网关的存在,就只能在本地记录每个微服务的调用地址。

在这里插入图片描述
无网关的微服务架构存在的问题:

  • 客户端多次请求不同的微服务,增加客户端代码或配置编写的复杂
  • 认证复杂,每个服务都需要独立认证
  • 存在跨域请求,在一定场景下处理相对复杂

网关的基本功能

  • 路由转发
  • 认证、鉴权
  • 熔断
  • 负载均衡
  • 限流
  • 日志监控

在这里插入图片描述

Spring Cloud Gateway 几个必知的术语?

1、路由(route)

gateway的基本构建模块。由ID、目标URI、断言集合和过滤器组成。如果断言结果为真,则匹配到该路由。

2、断言(Predicate)

参照Java8的特性Predicate,允许开发人员匹配HTTP请求中的任何内容,比如头或参数等。

3、过滤器(filter)

可以在返回请求之前或之后修改请求之前或之后修改请求和响应的内容。

网关如何搭建?

在这里插入图片描述
添加依赖:

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

ps:一定要去除spring-boot-starter-web 依赖,否则启动报错。

什么是Predicate(断言)?

Predicate 来自于Java8的接口。Predicate 接收一个输入参数,返回一个布尔值结果。该接口包含多种默认方法来将Predicate组合成其他复杂的逻辑(比如:与、或、非)。

可以用于接口请求参数校验、判断新老数据是否有变化需要进行更新操作。

Spring Cloud Gateway 内置了许多Predict:

在这里插入图片描述
下面就以最后一种权重断言为例介绍一下如何配置。配置如下:

spring:cloud:gateway:## 路由routes:## id只要唯一即可,名称任意- id: gateway-provider_1uri: http://localhost:9024## 配置断言predicates:## Path Route Predicate Factory断言,满足/gateway/provider/**这个请求路径的都会被路由到http://localhost:9024这个uri中- Path=/gateway/provider/**## Weight Route Predicate Factory,同一分组按照权重进行分配流量,这里分配了80%## 第一个group1是分组名,第二个参数是权重- Weight=group1, 8## id必须唯一- id: gateway-provider_2## 路由转发的uriuri: http://localhost:9025## 配置断言predicates:## Path Route Predicate Factory断言,满足/gateway/provider/**这个请求路径的都会被路由到http://localhost:9024这个uri中- Path=/gateway/provider/**## Weight Route Predicate Factory,同一分组按照权重进行分配流量,这里分配了20%## 第一个group1是分组名,第二个参数是权重- Weight=group1, 2

routes 下就是配置的路由策略,各个组件如下:

  • id:路由的唯一id,名称任意
  • uri:路由转发的uri
  • predicates:断言配置,可以配置多个

Spring Cloud Gateway中的断言命名都是有规划的,格式:xxxRoutePredicateFactory。

比如权重的断言:WeightRoutePredicateFactory,那么配置时直接取前面的Weight。

默认的路由转发如果路由到了两个,则是的按照配置先后顺序转发,上面都配置了路径:Path=/gateway/provider/**,如果没有配置权重,则肯定是转发到http://localhost:9024。但是既然配置配置了权重并且相同的分组,则按照权重比例进行分配流量。

什么时过滤器?

Gateway过滤器的生命周期:

  • PRE:这个过滤器在请求被路由之前调用。我们可以利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调式信息等。
  • POST:这种过滤器在路由到微服务以后执行。这种过滤器可以用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。

Gateway 的Filter从作用范围可以分为两种:

  • GatewayFilter:应用到单个路由或者一个分组的路由上(需要在配置文件中配置)。
  • GlobalFilter:应用到所有的路由上(无需配置,全局生效)。

GatewayFilter 局部过滤器

局部过滤器需要在指定路由配置才能生效,默认是不生效的。

AddResponseHeaderGatewayFilterFactory 这个过滤器为例,为原始响应添加Header,配置如下:

spring:cloud:gateway:## 路由routes:## id只要唯一即可,名称任意- id: gateway-provider_1uri: http://localhost:9024## 配置断言predicates:## Path Route Predicate Factory断言,满足/gateway/provider/**这个请求路径的都会被路由到http://localhost:9024这个uri中- Path=/gateway/provider/**## 配置过滤器(局部)filters:- AddResponseHeader=X-Response-Foo, Bar

浏览器请求,发现响应头中已经有了X-Respongse-Foo=Bar 这个键值对,如下图:
在这里插入图片描述
注意: 过滤器的名称只需要写前缀,过滤器命名必须是xxxGatewayFilterFactory(包括自定义的局部过滤器)。

虽然内置的过滤器能够解决很多场景,但是难免有一些特殊的需求需要定制一个过滤器。

场景:模拟一个授权验证的过程,如果请求头或者请求参数中携带token 则放行,否则直接拦截返回401,代码如下:

/*** 名称必须是xxxGatewayFilterFactory形式* todo:模拟授权的验证,具体逻辑根据业务完善*/
@Component
@Slf4j
public class AuthorizeGatewayFilterFactory extends AbstractGatewayFilterFactory<AuthorizeGatewayFilterFactory.Config> {private static final String AUTHORIZE_TOKEN = "token";//构造函数,加载Configpublic AuthorizeGatewayFilterFactory() {//固定写法,这里可以参过内置的局部过滤器的写法比如AddRequestGatewayFiltersuper(AuthorizeGatewayFilterFactory.Config.class);log.info("Loaded GatewayFilterFactory [Authorize]");}//读取配置文件中的参数 赋值到 配置类中@Overridepublic List<String> shortcutFieldOrder() {//Config.enabledreturn Arrays.asList("enabled");}@Overridepublic GatewayFilter apply(AuthorizeGatewayFilterFactory.Config config) {return (exchange, chain) -> {//判断是否开启授权验证if (!config.isEnabled()) {return chain.filter(exchange);}ServerHttpRequest request = exchange.getRequest();HttpHeaders headers = request.getHeaders();//从请求头中获取tokenString token = headers.getFirst(AUTHORIZE_TOKEN);if (token == null) {//从请求头参数中获取tokentoken = request.getQueryParams().getFirst(AUTHORIZE_TOKEN);}ServerHttpResponse response = exchange.getResponse();//如果token为空,直接返回401,未授权if (StringUtils.isEmpty(token)) {response.setStatusCode(HttpStatus.UNAUTHORIZED);//处理完成,直接拦截,不再进行下去return response.setComplete();}/*** todo chain.filter(exchange) 之前的都是过滤器的前置处理** chain.filter().then(*  过滤器的后置处理...........* )*///授权正常,继续下一个过滤器链的调用return chain.filter(exchange);};}@Data@AllArgsConstructor@NoArgsConstructorpublic static class Config {// 控制是否开启认证private boolean enabled;}
}

局部过滤器需要在路由中配置才能生效,配置如下:

spring:cloud:gateway:## 路由routes:## id只要唯一即可,名称任意- id: gateway-provider_1uri: http://localhost:9024## 配置断言predicates:## Path Route Predicate Factory断言,满足/gateway/provider/**这个请求路径的都会被路由到http://localhost:9024这个uri中- Path=/gateway/provider/**## 配置过滤器(局部)filters:- AddResponseHeader=X-Response-Foo, Bar## AuthorizeGatewayFilterFactory自定义过滤器配置,值为true需要验证授权,false不需要- Authorize=true

此时直接访问:http://localhost:9023/gateway/provider/port,不携带token,返回如下图:
在这里插入图片描述
请求参数带上token:http://localhost:9023/gateway/provider/port?token=abcdcdecd-ddcdeicd12,成功返回,如下图:
在这里插入图片描述
上述的AuthorizeGatewayFilterFactory只是涉及到了过滤器的前置处理,后置处理是在chain.filter().then()中的then()方法中完成的,具体可以看下项目源码中的TimeGatewayFilterFactory,代码就不再贴出来了,如下图:
在这里插入图片描述

GlobalFilter 全局过滤器

全局过滤器应用到全部路由上,无需开发者配置,Spring Cloud Gateway也内置了一些全局过滤器,如下图:
在这里插入图片描述
GlobalFilter 的功能其实很和GatewayFilter 是相同的。只是GlobalFilter 的作用域是所有的路由配置,而不是绑定在指定路由配置上。多个GlobalFilter 可以通过@Order 或者getOrder() 方法指定每个GlobalFilter 的执行顺序,order值越小,GlobalFilter执行的优先级越高。

注意,由于过滤器有pre和post两种类型,pre类型过滤器如果order值越小,那么它就应该在pre过滤器链的顶层,post类型过滤器如果order值越小,那么它就应该在pre过滤器链的底层。示意图如下:

在这里插入图片描述
当然除了内置的全局过滤器,实际工作中还需要定制过滤器,下面来介绍一下如何自定义。

场景:模拟Nginx的Access Log 功能,记录每次请求的相关信息。代码如下:

/*** 实现GlobalFilter*/
@Slf4j
@Component
@Order(value = Integer.MIN_VALUE)
public class AccessLogGlobalFilter implements GlobalFilter {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {//filter的前置处理ServerHttpRequest request = exchange.getRequest();String path = request.getPath().pathWithinApplication().value();InetSocketAddress remoteAddress = request.getRemoteAddress();return chain//继续调用filter.filter(exchange)//filter的后置处理.then(Mono.fromRunnable(() -> {ServerHttpResponse response = exchange.getResponse();HttpStatus statusCode = response.getStatusCode();log.info("请求路径:{},远程IP地址:{},响应码:{}", path, remoteAddress, statusCode);}));}
}

好了,全局过滤器不必在路由上配置,注入到IOC容器中即可全局生效。

此时发出一个请求,控制台打印信息如下:

请求路径:/gateway/provider/port,远程IP地址:/0:0:0:0:0:0:0:1:64114,响应码:200 OK

如何集成注册中心?

上述demo中并没有集成注册中心,每次路由配置都是指定固定的服务uri,如下图:
在这里插入图片描述
这样做有什么坏处呢?

  • 服务的IP的地址一旦修改了,路由配置中的uri必须修改
  • 服务集群中无法实现负载均衡

此时就需要集成的Nacos注册中心,使得网关能够从注册中心自动获取uri(负载均衡)。

pom文件中新增Nacos依赖,如下:

<!--nacos注册中心--><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId></dependency>

启动类上开启注册中心功能,如下图:
在这里插入图片描述
配置文件中指定nacos注册中心的地址:

spring:application:## 指定服务名称,在nacos中的名字name: cloud-gatewaycloud:nacos:discovery:# nacos的服务地址,nacos-server中IP地址:端口号server-addr: 127.0.0.1:8848

路由配置中唯一不同的就是路由的uri,格式:lb://service-name,这是固定写法:

  • lb:固定格式,指的是从nacos中按照名称获取微服务,并遵循负载均衡策略
  • service-name:nacos注册中心的服务名称,这里并不是IP地址形式的

集成Nacos注册中心完整的配置demo如下:

spring:application:## 指定服务名称,在nacos中的名字name: cloud-gatewaycloud:nacos:discovery:# nacos的服务地址,nacos-server中IP地址:端口号server-addr: 127.0.0.1:8848gateway:## 路由routes:## id只要唯一即可,名称任意- id: gateway-provider_1## 使用了lb形式,从注册中心负载均衡的获取uriuri: lb://gateway-provider## 配置断言predicates:## Path Route Predicate Factory断言,满足/gateway/provider/**这个请求路径的都会被路由到http://localhost:9024这个uri中- Path=/gateway/provider/**## 配置过滤器(局部)filters:- AddResponseHeader=X-Response-Foo, Bar

为什么指定了lb就可以开启负载均衡,前面说过全局过滤器LoadBalancerClientFilter就是负责路由寻址和负载均衡的,可以看到如下源码:
在这里插入图片描述

如何实现动态路由?

上述例子都是将网关的一系列配置写到项目的配置文件中,一旦路由发生改变必须要重新项目,这样维护成本很高。

其实我们可以将网关的配置存放到配置中心中,这样由配置中心统一管理,一旦路由发生改变,只需要在配置中心修改,这样便能达到一处修改,多出生效的目的。

这里当然要使用Nacos作为配置中心了,添加依赖如下:

<!--    nacos配置中心的依赖--><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId></dependency>

bootstrap.yml文件中指定Nacos作为配置中心的一些相关配置:

spring:application:## 指定服务名称,在nacos中的名字name: cloud-gatewaycloud:nacos:## todo 此处作为演示,仅仅配置了后缀,其他分组,命名空间根据需要自己配置config:server-addr: 127.0.0.1:8848## 指定文件后缀未yamlfile-extension: yaml

在nacos中的public命名空间中创建dataId为cloud-gateway.yaml的配置(未指定环境),配置内容如下:
在这里插入图片描述

如何自定义全局异常处理?

通过前面的测试可以看到一个现象:一旦路由的微服务下线或者失联了,Spring Cloud Gateway直接返回了一个错误页面,如下图:

在这里插入图片描述
显然这种异常信息不友好,前后端分离架构中必须定制返回的异常信息。

传统的Spring Boot 服务中都是使用@ControllerAdvice来包装全局异常处理的,但是由于服务下线,请求并没有到达。

因此必须在网关中也要定制一层全局异常处理,这样才能更加友好的和客户端交互。

直接创建一个类GlobalErrorExceptionHandler,实现ErrorWebExceptionHandler,重写其中的handle方法,代码如下:

/*** 用于网关的全局异常处理* @Order(-1):优先级一定要比ResponseStatusExceptionHandler低*/
@Slf4j
@Order(-1)
@Component
@RequiredArgsConstructor
public class GlobalErrorExceptionHandler implements ErrorWebExceptionHandler {private final ObjectMapper objectMapper;@SuppressWarnings({"rawtypes", "unchecked", "NullableProblems"})@Overridepublic Mono<Void> handle(ServerWebExchange exchange, Throwable ex) {ServerHttpResponse response = exchange.getResponse();if (response.isCommitted()) {return Mono.error(ex);}// JOSN格式返回response.getHeaders().setContentType(MediaType.APPLICATION_JSON);if (ex instanceof ResponseStatusException) {response.setStatusCode(((ResponseStatusException) ex).getStatus());}return response.writeWith(Mono.fromSupplier(() -> {DataBufferFactory bufferFactory = response.bufferFactory();try {//todo 返回响应结果,根据业务需求,自己定制CommonResponse resultMsg = new CommonResponse("500",ex.getMessage(),null);return bufferFactory.wrap(objectMapper.writeValueAsBytes(resultMsg));}catch (JsonProcessingException e) {log.error("Error writing response", ex);return bufferFactory.wrap(new byte[0]);}}));}
}

好了,全局异常处理已经定制完成了,在测试一下,此时正常返回JSON数据了,如下图:

在这里插入图片描述
原文地址:Spring Cloud Gateway

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

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

相关文章

Buuctf [GUET-CTF2019]number_game 题解

目录 一.主函数逻辑 二.level_stor()函数 三.mid_stor函数 四.operate函数 五.judge2函数 六.求解flag 一.主函数逻辑 ①先输入一个字符串,然后judge1()函数遍历它,判断字符是否在[0,4]区间范围内 ②将输入的字符串用层次遍历的方式存储为一个二叉树root ③再将二叉树r…

React解决样式冲突问题的方法

React解决样式冲突问题的方法 前言&#xff1a; 1、React最终编译打包后都在一个html页面中&#xff0c;如果在两个组件中取一样类名分别引用在自身&#xff0c;那么后者会覆盖前者。 2、默认情况下&#xff0c;只要导入了组件&#xff0c;不管组件有没有显示在页面中&#x…

科技成果赋智中小企业深度行 边界无限靖云甲ADR入选十大优秀案例

近日&#xff0c;国家工业信息安全发展研究中心、青岛市工业和信息化局、青岛市民营经济发展局、青岛市即墨区人民政府、青岛蓝谷管理局联合举办的科技成果赋智中小企业“深度行”活动&#xff08;青岛站&#xff09;成功举办&#xff0c;同步举行了赋智“深度行”活动&#xf…

打怪升级之发送单个UDP包升级版

目标 1.message的输入由edit_control进行&#xff0c;需要捕获输入。 2.用户的主机地址和发送地址不一样&#xff0c;需要分别设置并绑定。 设计RC外观 必备组件&#xff1a;主机IP与端口&#xff0c;从机IP与端口&#xff0c;消息框&#xff0c;发送&#xff0c;连接按钮。…

KDHG-A变频互感器综合测试仪

一、概述 KDHG-A电流互感器现场综合测试仪是一种专门为测试互感器&#xff1a;伏安特性、变比、极性、误差曲线、计算拐点和二次侧回路检查等设计的多功能现场试验仪器。 二、主要特点 1&#xff0e;单机220V输入时最大电压输出0-2500V&#xff0c;单机最大电流输出0-1000A&am…

k8s--pod管理-资源清单-生命周期

文章目录一、资源清单1. 格式和内容的书写方法2. 示例及执行操作二、pod生命周期:Init容器&探针1.简介2.Init 容器3.探针3.1存活探针3.2就绪探针一、资源清单 - 格式如下&#xff1a;apiVersion: group/version  //指明api资源属于哪个群组和版本&#xff0c;同一个组可…

金三银四面试热潮将至,靠这一份软件测试面经,offer拿到手软

不知不觉又到了新一年的金三银四&#xff0c; 去年的疫情紧张&#xff0c;造成的一系列影响我相信大家都还历历在目&#xff0c;尤其是工作这块更是如此&#xff0c;找工作的紧迫度&#xff0c;导致很大部分人群在工作发展可能并没有想象中的那样迅速。 作为一名在职的测试人员…

git团队合作 - branch分支的使用、主分支合并、冲突处理方案

情景例子开发部3人&#xff0c;组长man&#xff0c; 组员devA&#xff0c;devB&#xff1b;1&#xff09;组长man负责代码合并、冲突处理、检查代码、合并代码到master主分支&#xff1b;2&#xff09;组员devA负责开发3&#xff09;组员devB负责开发git仓库主次分支安排1&…

C++ linux下获取时间戳 秒、微妙、纳秒

1.例子#include <iostream>#include <sys/time.h>#include <cstdlib>#include <cstdio>#include <ctime>#include <cmath>#include <unistd.h>usingnamespace std;time_t clocktime(){time_t t time(NULL);std::cout << &quo…

swoole的强大之处,你可能只是略知一二!

首先 swoole 是 php 的一个扩展程序swoole 是一个为 php 用 c 和 c 编写的基于事件的高性能异步 & 协程并行网络通信引擎swoole 是一个多进程模型的框架&#xff0c;当启动一个进程 swoole 应用时&#xff0c;一共会创建 2nm 个进程&#xff0c;n 为 worker 进程数&#xf…

vector你得知道的知识

vector的基本使用和模拟实现 一、std::vector基本介绍 1.1 常用接口说明 std::vector是STL中的一个动态数组容器&#xff0c;它可以自动调整大小&#xff0c;支持在数组末尾快速添加和删除元素&#xff0c;还支持随机访问元素。 以下是std::vector常用的接口及其说明&#xf…

熬夜30天吃透这九大Java核心专题,我收割了3个大厂offer

这次一共收割了3个大厂offer&#xff0c;分别是蚂蚁金服、美团和网易&#xff0c;特意分享这次对我帮助非常大的宝典资料&#xff0c;一共涉及九大核心专题&#xff0c;分别是计算机网络、操作系统、MySQL、Linux、JAVA、JVM、Redis、消息队列与分布式、网站优化相关&#xff0…

DSF深度搜索时到底是如何回溯的(小tip)

这一段让我迷了两次&#xff0c;为什么回溯的时候&#xff0c;恢复了最后一位&#xff0c;往上递归一层之后&#xff0c;把最后一位填在它前一位&#xff0c;但是原本的前一位没有恢复&#xff0c;最后一位要怎么办&#xff1f;其实这还是递归没明白 也就是这一步是如何实现的 …

一点就分享系列(实践篇6——上篇)【迟到补发】Yolo-High_level系列算法开源项目融入V8 旨在研究和兼容使用【持续更新】

一点就分享系列&#xff08;实践篇5-补更篇&#xff09;[迟到补发]—Yolo系列算法开源项目融入V8旨在研究和兼容使用[持续更新] 题外话 去年我一直复读机式强调High-level在工业界已经饱和的情况&#xff0c;目的是呼吁更多人看准自己&#xff0c;不管是数字孪生交叉领域&#…

C++基础了解-21-C++ 继承

C 继承 一、C 继承 面向对象程序设计中最重要的一个概念是继承。继承允许我们依据另一个类来定义一个类&#xff0c;这使得创建和维护一个应用程序变得更容易。这样做&#xff0c;也达到了重用代码功能和提高执行效率的效果。 当创建一个类时&#xff0c;不需要重新编写新的…

量子计算(8)pyqpanda编程3测量操作

作为一名高产博主&#xff0c;小编我一天不写文章就浑身难受&#xff0c;这不&#xff0c;一闲下来就来给大家科普量子计算编程操作了。 今天我们要来探讨“测量操作”&#xff0c;众所周知&#xff0c;薛定谔的猫是一种既死又活的状态&#xff0c;很多人认为&#xff0c;猫是死…

Java代码优化|提高代码质量的一些小技巧

1.需要 Map 的主键和取值时&#xff0c;应该迭代 entrySet()当循环中只需要 Map 的主键时&#xff0c;迭代 keySet() 是正确的。但是&#xff0c;当需要主键和取值时&#xff0c;迭代 entrySet() 才是更高效的做法&#xff0c;比先迭代 keySet() 后再去 get 取值性能更佳。正例…

Git设置SSH Key

一、git 配置 &#xff08;1&#xff09;打开 git 命令窗口 &#xff08;2&#xff09;配置用户名&#xff08;填自己的姓名&#xff09; git config --global user.name “xinyu.xia” &#xff08;3&#xff09;配置用户邮箱&#xff08;填自己的邮箱&#xff0…

Python+Yolov8目标识别特征检测

Yolov8目标识别特征检测如需安装运行环境或远程调试&#xff0c;见文章底部个人QQ名片&#xff0c;由专业技术人员远程协助&#xff01;前言这篇博客针对<<Yolov8目标识别特征检测>>编写代码&#xff0c;代码整洁&#xff0c;规则&#xff0c;易读。 学习与应用推荐…

Easy Deep Learning——PyTorch中的自动微分

目录 什么是深度学习&#xff1f;它的实现原理是怎么样的呢&#xff1f; 什么是梯度下降&#xff1f;梯度下降是怎么计算出最优解的&#xff1f; 什么是导数&#xff1f;求导对于深度学习来说有何意义&#xff1f; PyTorch 自动微分&#xff08;自动求导&#xff09; 为什么…