【云原生】Spring Cloud Alibaba 之 Gateway 服务网关实战开发

news2024/11/16 2:23:12

目录

一、什么是网关

⛅网关的实现原理

二、Gateway 与 Zuul 的区别？

三、Gateway 服务网关 快速入门

⛄需求

⏳项目搭建

✅启动测试

四、Gateway 断言工厂

五、Gateway 过滤器

⛽过滤器工厂

♨️全局过滤器

六、源码地址

⛵小结

一、什么是网关

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

⛅网关的实现原理

Gateway 服务网关是所有请求的统一入口，每次请求由服务网关接受并根据路径条件转发至不同的微服务中。

网关的核心特性

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

架构图

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

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

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

二、Gateway 与 Zuul 的区别？

Spring Cloud 中的 网关类型

  • Gateway
  • Zuul

两者之间的区别

  • Zuul 是基于Servlet 的实现，属于 阻塞式编程
  • Spring Cloud Alibaba Gateway 服务网关是基于 Spring5.x 提供的WebFlux，属于响应式编程的实现，具备更好的性能。

三、Gateway 服务网关 快速入门

⛄需求

基于 Spring Cloud Alibaba Gateway 服务网关完成 路由转发，具体要求如下

  • 必须基于 Gateway 服务网关转发路由至指定的微服务
  • 配置路由的访问时间，order-service 服务 访问必须在2022-07-09之前
  • 配置服务的负载均衡，防止大规模请求造成服务无法访问

⏳项目搭建

新建 module

右击 nacos-demo 新建 module

Next 下一步，命名为 gateway，单击 Finish完成创建

引入依赖

<!--网关-->
<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>
<!--客户端负载均衡loadbalancer-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>

配置项目基本信息

server:
  port: 10010 # 网关端口
spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id，自定义，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://userService # 路由的目标地址 lb就是负载均衡，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求
        - id: order-service # 路由id，自定义，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://orderService
          predicates:
            - Path=/order/**
            - Before=2022-07-09T17:42:47.789-07:00[Asia/Shanghai]

我们将符合Path 规则的一切请求，都代理到 uri参数指定的地址。

我们将 /user/**开头的请求，代理到lb://userService， /order/** 开头的请求，代理到 lb://orderService ， lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。
新建 Application 启动类

package com.chen;

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

@SpringBootApplication
public class GatewayApplication {

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

✅启动测试

依赖服务启动

在启动之前，请务必启动 Nacos 服务，所有的服务都需要依赖于 Nacos服务注册中心来实现

启动 order-service、user-service、gateway服务

测试访问

访问 localhost:10010/user/1，符合/user/**规则，请求转发 uri 至 http://userService/user/1，得到结果

访问 localhost:10010/order/101，符合 /order/** 规则，但不符合 Before=2022-07-09T17:42:47.789-07:00[Asia/Shanghai] 规则，所以，转发uri失败！

测试成功，访问user服务成功访问，访问order服务由于已过期限，所以报404未找到！

小结 Gateway服务网关项目

网关搭建步骤：

  1. 创建项目，引入nacos服务发现和gateway依赖

  2. 配置application.yml，包括服务基本信息、nacos地址、路由

路由配置包括：

  1. 路由id：路由的唯一标示

  2. 路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡

  3. 路由断言（predicates）：判断路由的规则，

  4. 路由过滤器（filters）：对请求或响应做处理

四、Gateway 断言工厂

我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件

例如Path=/user/**是按照路径匹配，这个规则是由

org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来

处理的，像这样的断言工厂在SpringCloudGateway还有十几个:
名称    说明    示例
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    权重处理    

例如，Path、 Before，在Gateway项目快速入门中就用到了该断言工厂

具体的详细配置可看 Spring Cloud Alibaba Gateway 官网

五、Gateway 过滤器

GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理：

⛽过滤器工厂

路由器的种类

Spring提供了31种不同的路由过滤器工厂。例如：

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

请求头过滤器

下面我们以AddRequestHeader 为例来讲解。

需求：给所有进入userservice的请求添加一个请求头：Truth= Hello WHC !!!

只需修改 gateway 服务的 application.yaml 文件即可添加路由过滤即可

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userService 
        predicates: 
        - Path=/user/** 
        filters: # 过滤器
        - AddRequestHeader=Truth, Hello WHC !!! # 添加请求头

在userService 下写过滤器，只对userService服务生效，重新启动即可生效

默认过滤器

如果要对所有的路由都生效，则可以将过滤器工厂写到default下。格式如下：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 默认过滤项，全局生效
      - AddRequestHeader=Truth, Hello WHC !!! # 添加请求头

添加该默认过滤器，对所有微服务生效，重新启动服务即可生效

过滤器小结

过滤器的作用是什么？

  1. 对路由的请求和响应做加工处理，比如添加请求头，返回指定响应信息
  2. 配置在路由下的过滤器只对当前服务生效

defaultFilters的作用是什么？

  • 配置过滤器，并对全局服务生效

♨️全局过滤器

上一节的过滤器中，可以看出，这些过滤器都是固定的，如果我们想要拦截请求，做自己的业务逻辑更是无法实现

全局过滤器的作用

全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义，处理逻辑是固定的；而GlobalFilter的逻辑需要自己写代码实现。

实现流程

实现GlobalFilter接口

public interface GlobalFilter {
    /**
     *  处理当前请求，有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
     *
     * @param exchange 请求上下文，里面可以获取Request、Response等信息
     * @param chain 用来把请求委托给下一个过滤器 
     * @return {@code Mono<Void>} 返回标示当前过滤器业务结束
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

在filter中编写自定义逻辑，可以实现下列功能：

  • 登录状态判断
  • 权限校验
  • 请求限流等

自定义全局过滤器

需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件：

  • 参数中是否有authorization，

  • authorization参数值是否为admin

如果同时满足则放行，否则拦截

核心代码

package com.chen.gateway;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

/**
 * 认证过滤器类
 * 需要通过注解或接口的形式去管理过滤器的顺序，因为一个项目中可能有多个过滤器
 */
//@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 网关基于 WebFlux 响应式编程编写，api可能有些不一样

        // 1. 获取请求参数
        ServerHttpRequest request = exchange.getRequest();
        // 2. 获取参数中的authorization 参数
        MultiValueMap<String, String> params = request.getQueryParams();
        // 3， 判断参数值是否等于 admin
        String auth = params.getFirst("authorization");
        // 4. 如果相等，放行
        if ("admin".equals(auth)) {
            return chain.filter(exchange);
        }

        // 设置响应码，未登录
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);

        // 5，如果不等，则拦截
        return exchange.getResponse().setComplete();
    }

    @Override
    public int getOrder() {
        return -1;
    }
}

过滤器的执行顺序

请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter

请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行每个过滤器：

排序的规则是什么呢？

  • 每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。
  • GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定
  • 路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增。
  • 当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
     

详细内容，可以查看源码：

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters，然后再加载某个route的filters，然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器，与前面的过滤器合并后根据order排序，组织过滤器链

六、源码地址

GitHub开源地址：GitHub - wanghuichen/nacos-demo: Spring Cloud Alibaba 是目前最火的分布式开源框架，目前已归于Spring官方托管，Spring Cloud Alibaba 服务注册Nacos、Feign远程调用，以及Gateway网关，等等最新前沿技术及代码示例均在本项目，欢迎各位开发者 Star~

GitEE 开源地址： nacos-demo: Spring Cloud Alibaba 是目前最火的分布式开源框架，目前已归于Spring官方托管，Spring Cloud Alibaba 服务注册Nacos、Feign远程调用，以及Gateway网关，等等最新前沿技术均在本项目，欢迎各位开发者 Star~

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

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

相关文章

STM32 寄存器配置笔记——USART配置 打印

STM32 寄存器配置笔记——USART配置 打印

一、概述 本文主要介绍如何配置USART&#xff0c;并通过USART打印验证结果。以stm32f10为例&#xff0c;将PA9、PA10复用为USART功能&#xff0c;使用HSE PLL输出72MHZ时钟 APB2 clk不分频提供配置9600波特率。波特率计算公式如下&#xff1a; fck即为APB2 clk参考计算&#xf…
阅读更多...
孟德尔随机化写作技巧mr

孟德尔随机化写作技巧mr

阅读更多...
electron使用electron-builder macOS windows 打包 签名 更新 上架

electron使用electron-builder macOS windows 打包 签名 更新 上架

0. 前言 0.1 项目工程 看清目录结构&#xff0c;以便您阅读后续内容 0.2 参考资料 &#xff08;1&#xff09;macOS开发 证书等配置/打包后导出及上架 https://www.jianshu.com/p/c9c71f2f6eac首先需要为Mac App创建App ID&#xff1a; 填写信息如下—Description为"P…
阅读更多...
3.计算机网络

3.计算机网络

1.重点概念 MSL&#xff08;Maximum segment lifetime&#xff09;&#xff1a;TCP 报⽂最⼤⽣存时间。它是任何 TCP 报⽂在⽹络上存在的 最⻓时间&#xff0c;超过这个时间报⽂将被丢弃。实际应⽤中常⽤的设置是 30 秒&#xff0c;1 分钟和 2 分钟。 TTL&#xff08;Time to …
阅读更多...
1.8w 字详解 SQL 优化

1.8w 字详解 SQL 优化

来源&#xff1a;捡田螺的小男孩 1、MySQL的基本架构 2、SQL优化 3、explain执行计划常用关键字详解 很多朋友在做数据分析时&#xff0c;分析两分钟&#xff0c;跑数两小时&#xff1f; 在使用SQL过程中不仅要关注数据结果&#xff0c;同样要注意SQL语句的执行效率。 本文…
阅读更多...
多元函数奇偶性

多元函数奇偶性

多元函数奇偶性 多元函数的定义域 定义域根据函数的变量数不同,有不同的形式 一元函数 y f ( x ) yf(x) yf(x),定义域可以是数集二元函数 z f ( x , y ) zf(x,y) zf(x,y),定义域可以是一平面区域,是平面点集三元函数 v f ( x , y , z ) vf(x,y,z) vf(x,y,z),定义域是一块空…
阅读更多...
基恩士软件的基本操作（四，快速编辑plc技巧）

基恩士软件的基本操作（四，快速编辑plc技巧）

目录 单元软原件注释快速添加 双击单元配置&#xff0c;进入单元编辑器 KV一键添加注释 双击软元件注释 进入软元件编辑界面 &#xff0c;对弹出的列表中软元件打勾点击登录 元件注释就自动添加了 注释收索&#xff0c;快速编辑软元件 自定义注释收索 空软元件快速查找 …
阅读更多...
平民如何体验一把大模型知识库

平民如何体验一把大模型知识库

背景 随着openai发布的chatgpt,各界掀起大模型热. 微软、谷歌、百度、阿里等大厂纷纷拥抱人工智能, 表示人工智能将是下一个风口.确实, chatgpt的表现确实出乎大部分的意料之外,网上也不断流传出来,chatgpt未来会替换很多白领.作为一名普通的程序员,觉得非常有必要随波逐流一下…
阅读更多...
Servlet执行流程Servlet 生命周期

Servlet执行流程Servlet 生命周期

Servlet 生命周期 对象的生命周期指一个对象从被创建到被销毁的整个过程 import javax.servlet.*; import javax.servlet.annotation.WebServlet; import java.io.IOException; WebServlet(urlPatterns "/demo",loadOnStartup 10) public class ServletDemo imple…
阅读更多...
html实现计算器源码

html实现计算器源码

文章目录 1.设计来源1.1 主界面1.2 计算效果界面 2.效果和源码2.1 动态效果2.2 源代码 源码下载 作者&#xff1a;xcLeigh 文章地址&#xff1a;https://blog.csdn.net/weixin_43151418/article/details/134532725 html实现计算器源码&#xff0c;计算器源码&#xff0c;简易计…
阅读更多...
Java 异常处理、继承、重写/重载

Java 异常处理、继承、重写/重载

一、java异常处理&#xff1a; 三种类型的异常&#xff1a;检查性异常、运行时异常、错误。 所有的异常类是从java.lang.Exception类继承的子类。Exception类是Throwable类的子类。除了Exception类外&#xff0c;Throwable还有一个子类Error。 异常类有两个主要的子类&#…
阅读更多...
计算机毕业设计选题推荐-网上产品商城-Python项目实战

计算机毕业设计选题推荐-网上产品商城-Python项目实战

✨作者主页&#xff1a;IT研究室✨ 个人简介&#xff1a;曾从事计算机专业培训教学&#xff0c;擅长Java、Python、微信小程序、Golang、安卓Android等项目实战。接项目定制开发、代码讲解、答辩教学、文档编写、降重等。 ☑文末获取源码☑ 精彩专栏推荐⬇⬇⬇ Java项目 Python…
阅读更多...
同为科技（TOWE）工业连接器：保障高效、可靠、安全的电气连接

同为科技（TOWE）工业连接器：保障高效、可靠、安全的电气连接

国内经济快速的发展&#xff0c;人们生活水平的不断提高&#xff0c;基础设施的建设是发展的基础&#xff0c;完善的基础设施对加速经济的发展起到至关重要的作用。其中&#xff0c;基础建设中机场、港口、电力、通讯等公共设施必须配套相应的电气设施&#xff0c;工业用插头插…
阅读更多...
华为无线ac+fit三层组网，每个ap发射不同的业务vlan

华为无线ac+fit三层组网，每个ap发射不同的业务vlan

ap管理dhcp在ac控制器上&#xff0c;业务dhcp在汇聚上 配置WLAN业务 &#xff08;1&#xff09;配置VAP模板 • 配置员工网络的VAP模板&#xff08;employee&#xff09; [AC-wlan-view] security-profile name employee //创建名为“employee”的安全模板 [AC-wlan-sec-prof-…
阅读更多...
Windows to Go U盘系统制作（未测完成）

Windows to Go U盘系统制作（未测完成）

三、Windows U盘系统制作 1、下载windows镜像&#xff0c;并通过Windows To Go方式制作&#xff0c;具体选项参考下面截图 2、选择Windows版本 3、配置Windows 体验相关参数
阅读更多...
dvwa 代码注入impossible代码审计

dvwa 代码注入impossible代码审计

dvwa 代码注入impossible代码审计 <?phpif( isset( $_POST[ Submit ] ) ) {// Check Anti-CSRF tokencheckToken( $_REQUEST[ user_token ], $_SESSION[ session_token ], index.php ); // 检查token值是否正确// Get input$target $_REQUEST[ ip ]; $target stripslas…
阅读更多...
Tensorrt 实现 yolov5-cls 遇到的问题

Tensorrt 实现 yolov5-cls 遇到的问题

yolov5-6.2增加了分类训练、验证、预测和导出&#xff08;所有 11 种格式&#xff09;&#xff0c;还提供了 ImageNet 预训练的 YOLOv5m-cls、ResNet&#xff08;18、34、50、101) 和 EfficientNet (b0-b3) 模型. 官方Git : https://github.com/ultralytics/yolov5 分类模型与…
阅读更多...
树莓派的的串口通信协议

树莓派的的串口通信协议

首先&#xff0c;回顾一下串口的核心知识点&#xff0c;也是面试重点&#xff1a; 串口通信通常使用在多机通讯中串口通信是全双工的决定串口通信的成功与否的是 数据格式 和 波特率数据格式&#xff1a;1. 数据位 2.停止位 3. 奇偶校验位 树莓派恢复串口 回忆前几节树莓派刷机…
阅读更多...
ES 查询语法-详解

ES 查询语法-详解

文章目录 1.DSL查询文档1.1.DSL查询分类1.2.全文检索查询1.2.1.使用场景1.2.2.基本语法1.2.3.总结 1.3.精准查询1.3.1.term查询1.3.2.总结 1.DSL查询文档 elasticsearch的查询依然是基于JSON风格的DSL来实现的。 1.1.DSL查询分类 Elasticsearch提供了基于JSON的DSL&#xff…
阅读更多...
gwas数据获取如何获取完整的GWAS summary数据（1）------GWAS catalog数据库

gwas数据获取如何获取完整的GWAS summary数据（1）------GWAS catalog数据库

IEU OpenGWAS project (mrcieu.ac.uk) UK Biobank - UK Biobank GWAS Catalog 在孟德尔随机化&#xff08;Mendelian randomization&#xff0c;MR&#xff09;研究中&#xff0c;对于暴露数据我们只需要那些显著的SNP信息&#xff0c;这样的信息在各种GWAS数据库中都是很容…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023