Spring Cloud Gateway详解

文章目录

    • Gateway搭建
    • 路由(route)
    • 断言(Predicate )
      • 自定义断言
    • 过滤器(filter)
      • 自定义全局过滤器

引言

  在传统的单体项目中,前端和后端的交互相对简单,只需通过一个调用地址即可实现。然而,随着微服务架构的兴起,后端服务被拆分成多个微服务,这给前端带来了新的挑战:需要记住每个微服务的地址才能进行交互。显然,这种做法不仅繁琐,还容易导致前端代码的不可维护性和耦合度的增加。为了解决这一问题,网关应运而生!

  在微服务中,比较常见的网关有Spring Cloud GatewayNetflix Zuul等等,由于Zuul已经停止维护了,并且Spring Cloud Gateway 在性能、灵活性、易用性和社区支持等方面都具有优势,所以现目前常用Gateway作为微服务的网关。

Gateway搭建

版本说明:

<spring-cloud.version>Greenwich.SR5</spring-cloud.version>
<spring-cloud-alibaba.version>2.1.2.RELEASE</spring-cloud-alibaba.version>

创建一个Gateway微服务项目,引入依赖

<dependencies>
    <!--Gateway-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
</dependencies>

再写个启动类,启动即可

下面介绍Gateway的配置三要素,路由(route)断言(Predicate )过滤器(filter)

路由(route)

  在网关中,路由决定了请求应该被转发到哪个后端服务处理,路由功能使得网关能够将请求动态地转发到不同的后端服务,从而实现请求的分发和负载均衡。

从代码中不难看出,路由的配置主要有下面几个属性
在这里插入图片描述

spring:
  cloud:
    gateway:
      ## 路由
      routes:
        ## id名称任意,唯一即可
        - id: gateway-service-01
          ## 路由转发的uri
          uri: http://localhost:8011
          

        - id: gateway-service-02
          uri: http://localhost:8012
          

  routes下面是可以配置多个路由的,如上图所示,那到底什么时候走8011,什么时候走8012呢,这就需要用到Gateway中非常重要的组件,Predicate断言!

断言(Predicate )

  简单来说,Gateway的断言就是一种条件判断,用来控制请求向那个路由转发,可以根据需要灵活地定制路由规则。

  在Gateway中,内置的断言有很多,可以根据不同的属性进行配置,提供的路由断言工厂有如下几个:
在这里插入图片描述

  比如有根据请求路径的PathRoutePredicateFactory,有根据请求方法的MethodRoutePredicateFactory,有根据请求头的HeaderRoutePredicateFactory,等等,因为这些断言的命名都是有规范的,都是xxxRoutePredicateFactory的格式,所以在配置的时候只需要写前面部分的名称就行了,比如Path,Method。

好,现在我们就来配置一个根据Path的断言

spring:
  cloud:
    gateway:
      ## 路由
      routes:
        ## id名称任意,唯一即可
        - id: gateway-service-01
          ## 路由转发的uri
          uri: http://localhost:8011
          ## 配置断言
          predicates:
            ## 满足/api/orderService/** 这个请求路径的,都会被路由到http://localhost:8011
            - Path=/api/orderService/**

        - id: gateway-service-02
          uri: http://localhost:8012
          ## 配置断言
          predicates:
            ## 满足/api/userService/** 这个请求路径的,都会被路由到http://localhost:8012
            - Path=/api/userService/**

当然,断言可以配置多个,之间是and的关系,比如我们可以配置权重比例

spring:
  cloud:
    gateway:
      ## 路由
      routes:
        ## id名称任意,唯一即可
        - id: gateway-service-01
          ## 路由转发的uri
          uri: http://localhost:8011
          ## 配置断言
          predicates:
            ## 满足/api/orderService/** 这个请求路径的,都会被路由到http://localhost:8011
            - Path=/api/orderService/**
            
            
        - id: gateway-service-02
          uri: http://localhost:8012
          ## 配置断言
          predicates:
            ## 满足/api/userService/** 这个请求路径的,都会被路由到http://localhost:8012
            - Path=/api/userService/**
            ## 同一分组按照权重进行分配流量,这里分配了60%
            ## 第一个userGroup是分组名,第二个参数是权重
            - Weight=userGroup, 6
        
        - id: gateway-service-03
          uri: http://localhost:8013
          predicates:
            - Path=/api/userService/**
            - Weight=userGroup, 4    

  这里路由gateway-service-02和gateway-service-03断言的Path都是一样的,但是加了Weight权重,当大量请求过来时,路由到8012的流量大约有60%,路由到8013的流量大约有40%,做到负载均衡的作用。

下面建立OrderService和UserService服务进行验证

// userService
@RestController
@RequestMapping("/api/userService")
@Slf4j
public class UserController {

    @GetMapping("/test")
    public ResponseEntity<String> testOrder() {
        log.info("进入userService...");
        return ResponseEntity.ok().body("进入userService");
    }
}

// orderService
@RestController
@RequestMapping("/api/orderService")
@Slf4j
public class OrderController {

    @GetMapping("/test")
    public ResponseEntity<String> testOrder(){
        log.info("进入orderService...");
        return ResponseEntity.ok().body("进入orderService");
    }
}

我这里启动网关服务,一个订单服务,两个用户服务
在这里插入图片描述

启动两个userService是为了测试权重的配置

输入地址,注意这里是网关的IP+端口

http://localhost:8010/api/orderService/test
在这里插入图片描述

http://localhost:8010/api/userService/test
在这里插入图片描述

网关配置的Path起到了效果

再测试下权重的配置

连续访问http://localhost:8010/api/userService/test 10次
在这里插入图片描述
在这里插入图片描述

可以看出和我们在网关配置的比例大致相等,做到了按权重分发请求流量

自定义断言

接下来,我们自己定义一个断言来试试

/**
 * 自定义一个指定时间访问的断言
 * 1.类名称必须是配置+RoutePredicateFactory
 * 2.必须继承AbstractRoutePredicateFactory<自定义的内部类>
 */
@Component
public class MyHourRoutePredicateFactory extends AbstractRoutePredicateFactory<MyHourRoutePredicateFactory.MyConfig> {

    /**
     * 必须用无参构造
     */
    public MyHourRoutePredicateFactory() {
        super(MyHourRoutePredicateFactory.MyConfig.class);
    }

    /**
     * 通过apply进行逻辑判断 true就是匹配成功 false匹配失败
     *
     * @param config
     * @return
     */
    @Override
    public Predicate<ServerWebExchange> apply(MyHourRoutePredicateFactory.MyConfig config) {
        return new Predicate<ServerWebExchange>() {
            @Override
            public boolean test(ServerWebExchange serverWebExchange) {
                // 获取当前时间
                LocalDateTime now = LocalDateTime.now();
                int hour = now.getHour();
                // 判断时间是否大于配置的时间
                if (hour >= config.getMyHour()) {
                    return true;
                }
                return false;
            }
        };
    }

    /**
     * 读取配置文件的参数值,赋值到配置类中的属性上
     *
     * @return
     */
    @Override
    public List<String> shortcutFieldOrder() {
        // 顺序必须必须和yml文件中的配置顺序一致
        return Arrays.asList("myHour");
    }


    /**
     * 接收配置参数
     */
    @Data
    @NoArgsConstructor
    public static class MyConfig {
        private int myHour;
    }

}

我们直接在OrderService增加这个配置

spring:
  cloud:
    gateway:
      ## 路由
      routes:
        ## id名称任意,唯一即可
        - id: gateway-service-01
          ## 路由转发的uri
          uri: http://localhost:8011
          ## 配置断言
          predicates:
            ## 满足/api/orderService/** 这个请求路径的,都会被路由到http://localhost:8011
            - Path=/api/orderService/**
            ## 自定义的断言 当前时间在16点后才允许访问
            - MyHour=16  

在这里插入图片描述

如上图所示,当前时间是15点,未到16点,不能访问,我再把时间配置为15点试试
在这里插入图片描述

顺利进入!

过滤器(filter)

  接下来,介绍下另外一个重要组件,过滤器,路由过滤器会对请求或响应做相应的处理,Gateway目前有30多种内置的过滤器,具体可参考 https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories

其中分为局部过滤器和全局过滤器。

常见的局部过滤器:

名称说明
AddRequestHeaderGatewayFilterFactory添加一个请求头
RemoveRequestHeaderGatewayFilterFactory移除一个请求头
RemoveResponseHeaderGatewayFilterFactory移除一个响应头
RequestRateLimiterGatewayFilterFactory请求限流设置
AddResponseHeaderGatewayFilterFactory添加一个响应头

我们简单举个例子,使用AddResponseHeaderGatewayFilterFactory,为请求添加响应头

配置的时候还是和断言一样的,只需要写前面的AddResponseHeader即可

spring:
  cloud:
    gateway:
      ## 路由
      routes:
        ## id名称任意,唯一即可
        - id: gateway-service-01
          ## 路由转发的uri
          uri: http://localhost:8011
          ## 配置断言
          predicates:
            ## 满足/api/orderService/** 这个请求路径的,都会被路由到http://localhost:8011
            - Path=/api/orderService/**
            - MyHour=15
          # 过滤器配置(局部)
          filters:
            - AddResponseHeader=myKey,myVal

访问下就可以看到设置的值已经在响应头了
在这里插入图片描述

但是对于其他的请求是没有的,下面将配置一个默认过滤器配置 ,也是个全局过滤器,默认过滤器default-filters的配置和routes是平级的。

server:
  port: 8010

spring:
  cloud:
    gateway:
      ## 路由
      routes:
        ## id名称任意,唯一即可
        - id: gateway-service-01
          ## 路由转发的uri
          uri: http://localhost:8011
          ## 配置断言
          predicates:
            ## 满足/api/orderService/** 这个请求路径的,都会被路由到http://localhost:8011
            - Path=/api/orderService/**
            - MyHour=15

        - id: gateway-service-02
          uri: http://localhost:8012
          ## 配置断言
          predicates:
            ## 满足/api/userService/** 这个请求路径的,都会被路由到http://localhost:8012
            - Path=/api/userService/**
            ## 同一分组按照权重进行分配流量,这里分配了60%
            ## 第一个userGroup是分组名,第二个参数是权重
            - Weight=userGroup, 6

        - id: gateway-service-03
          uri: http://localhost:8013
          predicates:
            - Path=/api/userService/**
            - Weight=userGroup, 4
        # 默认过滤器,对所有路由生效
      default-filters:
        - AddResponseHeader=myKey,myVal

在这里插入图片描述
在这里插入图片描述

配置一个,全局生效

自定义全局过滤器

  和断言一样,也可以自定义过滤器,自定义局部过滤器需要extends AbstractGatewayFilterFactory,自定义全局过滤器需要实现GlobalFilter ,我们这里定义一个全局的过滤器吧。

/**
 * 全局过滤器 认证
 */
@Component
@Order(-1)
public class MyGatewayFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1.获取请求参数
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        // 2.获取user参数
        String userName = params.getFirst("name");
        if ("root".equals(userName)) {
            return chain.filter(exchange);// 继续执行后续的过滤器
        }
        // 3.拦截
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);// 禁止访问
        return exchange.getResponse().setComplete();
    }
}

在这里插入图片描述
在这里插入图片描述

我们可以定义多个过滤器,那么Order的值就决定了执行的先后顺序

Order的值越大,优先级越低,值越小,优先级越高

定义Order的值有两种方式

  • 实现Ordered接口,重写getOrder方法
  • 实用@Order注解

过滤器的执行顺序:默认过滤器(default-filters) ----> 局部过滤器------> 全局过滤器

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

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

相关文章

蓝桥杯单片机之模块代码《多样点灯方式》

过往历程 历程1&#xff1a;秒表 历程2&#xff1a;按键显示时钟 历程3&#xff1a;列矩阵按键显示时钟 历程4&#xff1a;行矩阵按键显示时钟 历程5&#xff1a;新DS1302 历程6&#xff1a;小数点精确后两位ds18b20 历程7&#xff1a;35定时器测量频率 历程8&#xff…

JavaFX布局-HBox

JavaFX布局-HBox 常用属性alignmentspacingchildrenmarginpaddinghgrow 实现方式Java实现Xml实现 综合案例 HBox按照水平方向排列其子节点改变窗口大小,不会该部整体布局窗口太小会遮住内部元素&#xff0c;不会产生滚动条 常用属性 alignment 对齐方式 new HBox().setAlign…

SC-Lego-LOAM建图与ndt_localization的实车实现

参考&#xff1a;https://blog.csdn.net/weixin_44303829/article/details/121524380 https://github.com/AbangLZU/SC-LeGO-LOAM.git https://github.com/AbangLZU/ndt_localizer.git 将建图和定位分别使用lego-loam和ndt来进行&#xff0c;实车上的效果非常不错&#xff0c;…

C++语法|智能指针的实现及智能指针的浅拷贝问题、auto_ptr、scoped_ptr、unique_ptr、shared_ptr和weak_ptr详细解读

文章目录 1.自己实现智能指针智能指针引起的浅拷贝问题尝试定义自己的拷贝构造函数解决浅拷贝 2.不带引用计数的智能指针auto_ptrscoped_ptrunique_ptr&#xff08;推荐&#xff09; 3.带引用计数的智能指针模拟实现引用计数shared_ptr和weak_ptr循环引用&#xff08;交叉引用&…

LeetCode---396周赛

题目列表 3136. 有效单词 3137. K 周期字符串需要的最少操作次数 3138. 同位字符串连接的最小长度 3139. 使数组中所有元素相等的最小开销 一、有效单词 按照题目要求&#xff0c;统计个数&#xff0c;看是否符合条件即可&#xff0c;代码如下 class Solution { public:b…

Java - Json字符串转List<LinkedHashMap<String,String>>

需求&#xff1a;在处理数据时&#xff0c;需要将一个Object类型对象集合转为有序的Map类型集合。 一、问题 1.原代码&#xff1a; 但在使用时出现报错&#xff1a; Incompatible equality constraint: LinkedHashMap<String, String> and LinkedHashMap 不兼容的相等…

初识sql注入--手工注入

目录 可能使用的sql函数 入侵网站方式 1、文件上传漏洞 2、rce 3、sql注入 SQL注入 什么是sql注入 进行SQL注入 实验环境 开始实验&#xff08;使用information_shema数据库&#xff09; 1、进入靶场 2、报列数 下面来解释一下为什么要照上面SQL语句写 url编码 单…

Linux-vi、vim

使用Xshell远程登录到Linux主机进行操作 命令行不用全部掌握&#xff0c; 一般编辑大文件&#xff0c;比较复杂的情况下&#xff0c; 我们还是使用Xftp工具&#xff0c; down下来再恢复回去。

有边数限制的最短路

文章目录 题目 有边数限制的最短路算法分析1、问题&#xff1a;为什么Dijkstra不能使用在含负权的图中&#xff1f;dijkstra详细步骤2、什么是bellman - ford算法&#xff1f;3、bellman - ford算法的具体步骤4、在下面代码中&#xff0c;是否能到达n号点的判断中需要进行if(di…

Seaborn : 超好用的Python可视化工具

1. 引言 说到数据可视化&#xff0c;Seaborn就像一颗隐藏的宝石&#xff01;在进行探索性数据分析时&#xff0c;我们通常从Matplotlib 开始&#xff0c;而对 Seaborn 的探索相对较少&#xff01;但是&#xff0c;只要你了解 Seaborn 的全部潜力&#xff0c;你就会惊奇地发现&…

安全工程师面试题

安全工程师面试题安全工程师是一个非常重要的职位&#xff0c;他们负责保护公司的网络和系统免受黑客和恶意软件的攻击。如果你想成为一名安全工程师&#xff0c;那么你需要准备好面试。下面是一… 1安全工程师面试题 安全工程师是一个非常重要的职位&#xff0c;他们负责保护…

C++Linux系统编程——makefile

Makefile Makefile简介 一个工程中的源文件不计其数&#xff0c;其按类型、功能、模块分别放在若干个目录中&#xff0c;makefile定义了一系列的规则来指定&#xff0c;哪些文件需要先编译&#xff0c;哪些文件需要后编译&#xff0c;哪些文件需要重新编译&#xff0c;甚至于…

基于Django实现的校园疫情监控平台

基于Django实现的校园疫情监控平台 开发语言:Python 数据库&#xff1a;MySQL所用到的知识&#xff1a;Django框架工具&#xff1a;pycharm、Navicat、Maven 系统功能实现 登录注册功能 用户在没有登录自己的用户名之前只能浏览本网站的首页&#xff0c;想要使用其他功能都会…

sqli-labs靶场第十四关

目录 1&#xff1a;分析 找闭合符&#xff1a; 2&#xff1a;开始注入 报错注入&#xff1a; 注入数据库名&#xff1a; 注入表名&#xff1a; 注入列名&#xff1a; 注入具体值&#xff1a; 1&#xff1a;分析 经过我们的实验发现当我们输入的密码后面存在双引号时会报…

构建内网yum仓库

1、环境介绍 系统&#xff1a;龙蜥os 7.9 2、安装epel源 yum install epel-release -y3、安装nginx服务器并启动 yum install nginx httpd -y配置 server {listen 80;server_name repo.wtown.com;root /usr/share/nginx/html/repo;index index.html index.htm;location / {…

阿里云ECS服务器实例挂载数据盘步骤(磁盘自动挂载.、访问挂载点)

阿里云ECS服务器实例挂载数据盘步骤 相关指令 df -h 查看磁盘空间 du -sh * 查看使用内存大小1.磁盘自动挂载 首先登录阿里云ECS服务器&#xff0c;通过 df -h 命令查看当前磁盘挂载情况 通过 fdisk -l 命令查看磁盘情况&#xff0c;可以发现有两个盘&#xff1a; 系统盘 …

Ubuntu 和 Windows之间无法复制粘贴问题解决方法

需要安装open-vm-tools&#xff0c;官方安装open-vm-tools的网址&#xff1a;安装 Open VM Tools (vmware.com)

安全测试工具Nessus安装和使用

安装 下载地址&#xff1a;https://pan.baidu.com/s/1OaYMDdQqYI4BbZ_uUErrTw 提取码: yg2g 安装Nessus-8.14.0-x64.msi&#xff0c;按照提示next至安装完成&#xff0c;显示如下页面&#xff0c;点击Connect via SSL 点击“高级”、“继续访问” 选择 【Managed Scanner】选…

Visual Studio,第1个hello world,入门C++,分别编译一个可以在Windows和Linux下运行的程序

本人的VxTerm&#xff0c;是在Visual Studio 2022下编写的。 其它的语言工具是不是也可以那么方便的使用&#xff0c;本人并不得而知&#xff0c;至少本人能知道&#xff1a;对于我来说&#xff0c;Visual Studio可以让我觉得C/C语言非常简单&#xff01; 一、安装Visual Stu…

stm32——OLED篇

技术笔记&#xff01; 一、OLED显示屏介绍&#xff08;了解&#xff09; 1. OLED显示屏简介 二、OLED驱动原理&#xff08;熟悉&#xff09; 1. 驱动OLED驱动芯片的步骤 2. SSD1306工作时序 三、OLED驱动芯片简介&#xff08;掌握&#xff09; 1. 常用SSD1306指令 2. …