Spring Cloud Gateway网关的高级特性之GatewayFilter Factories(路由过滤器)

spring cloud gateway 网关路由转发及request、response的加解密处理 sygateway的介绍和使用原理请自行查阅和学习,本章内容需在对spring cloud gateway的基本的了解和一定的知识基础上进行的。附上一个可供学习的博文:SpringCloud gateway (史上最全) - 疯狂创客圈 - 博客园 需求场景: 前端对post请求的数据进行加密(主流的加密方式),后端需要解密,将接口的响应数据进行加密返回,前端解密并展示或其他操作等。出于安全性的考虑和可扩展性故使用了网关来做。 涉及到的问题: 1、request的body数据流读取只能读取一次,co 阅读详情

1、GatewayFilter Factories(路由过滤器)

官方访问地址:点击这里

来自官方的解释如下图所示:
在这里插入图片描述

简单来说就是:

  • 客户端向 Spring Cloud Gateway 发送请求。
  • 如果请求与某个路由匹配,则该请求会被传递给 Gateway Web Handler。
  • Gateway Web Handler 将请求通过一系列过滤器,这些过滤器可以做一些预处理工作(比如添加头部信息、修改请求参数等)。
  • 过滤器处理完成后,实际的代理请求才会被发送到目标服务。
  • 当响应从目标服务返回时,它还会经过相同的过滤器链,这时过滤器可以做一些后处理工作(例如修改响应内容、添加响应头等)。
  • 最终处理完毕后,响应被返回给客户端。

路由过滤器的主要作用就是用来做请求鉴权、异常处理等,比较典型的就有记录接口调用时长统计。

2、 Filter过滤的类型

  1. 全局默认过滤器Global Filters:官网;gateway出厂默认已有的,直接用即可,主要作用于所有的路由不需要在配置文件中配置,作用在所有的路由上,实现GlobalFilter接口即可;
  2. 单一内置过滤器GatewayFilter: 官网;也可以称为网关过滤器,这种过滤器主要是作用于单一路由或者某个路由分组;
  3. 定义过滤器

3、 Gateway内置的过滤器

这里只演示常用的内置过滤器,其他的原理都是一样的。

3.1 The AddRequestHeader GatewayFilter Factory(指定请求头内容ByName)

我们在网关controller中编写测试接口:
Example 14. GateWayController.java

@RestController
public class GateWayController{
    @GetMapping(value = "/pay/gateway/filter")
    public ResultData<String> getGatewayFilter(HttpServletRequest request){
        String result = "";
        Enumeration<String> headers = request.getHeaderNames();
        while(headers.hasMoreElements()) {
            String headName = headers.nextElement();
            String headValue = request.getHeader(headName);
            System.out.println("请求头名: " + headName +"\t\t\t"+"请求头值: " + headValue);
            if(headName.equalsIgnoreCase("X-Request-red")
                    || headName.equalsIgnoreCase("X-Request-my"))  {
                result = result+headName + "\t " + headValue +" ";
            }
        }
        return ResultData.success("getGatewayFilter 过滤器 test: "+result+" \t "+ DateUtil.now());
    }
}

Example 14. application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: https://example.org
        filters:
        - AddRequestHeader=X-Request-red, blue # 请求头kv,若一头含有多参则重写一行设置
        - AddRequestHeader=X-Request-my,name

重启服务,并访问http://localhost:端口号/pay/gateway/filter,查看控制台信息。

3.2 The RemoveRequestHeader GatewayFilter Factory (删除请求头ByName)

spring:
  cloud:
    gateway:
      routes:
      - id: removerequestheader_route
        uri: https://example.org
        filters:
        - RemoveRequestHeader=sec-fetch-site	# 删除请求头sec-fetch-site

注意:观察删除前后控制台打印的信息
删除前:
在这里插入图片描述
删除后:
在这里插入图片描述

3.3 The SetPath GatewayFilter Factory(修改请求头)

spring:
  cloud:
    gateway:
      routes:
      - id: setpath_route
        uri: https://example.org
        predicates:
        - Path=/red/{segment}
        filters:
        - SetRequestHeader=sec-fetch-mode,Blue-updatebyzzyy # 将请求头sec-fetch-mode对应的值修改为Blue-updatebyzzyy

修改前:
在这里插入图片描述

修改后(注意要重启服务):
在这里插入图片描述

3.4 The AddRequestParameter\RemoveRequestParameter GatewayFilter Factory(添加\删除请求参数)

spring:
  cloud:
    gateway:
      routes:
      - id: removerequestparameter_route
        uri: https://example.org
        filters:
        - RemoveRequestParameter=customerName # 删除url请求参数customerName,你传递过来也是null
        - AddRequestParameter=customerId,9527001 # 新增请求参数Parameter:k ,v

修改controller中的接口方法:

@GetMapping(value = "/pay/gateway/filter")
public ResultData<String> getGatewayFilter(HttpServletRequest request){
    String result = "";
    Enumeration<String> headers = request.getHeaderNames();
    while(headers.hasMoreElements()) {
            String headName = headers.nextElement();
            String headValue = request.getHeader(headName);
            System.out.println("请求头名: " + headName +"\t\t\t"+"请求头值: " + headValue);
            if(headName.equalsIgnoreCase("X-Request-red")
                    || headName.equalsIgnoreCase("X-Request-my"))  {
                result = result+headName + "\t " + headValue +" ";
            }
        }

    System.out.println("=============================================");
    String customerId = request.getParameter("customerId");
    System.out.println("request Parameter customerId: "+customerId);

    String customerName = request.getParameter("customerName");
    System.out.println("request Parameter customerName: "+customerName);
    System.out.println("=============================================");

    return ResultData.success("getGatewayFilter 过滤器 test: "+result+" \t "+ DateUtil.now());
}
访问地址:
http://localhost:端口号/pay/gateway/filter 
http://localhost:端口号/pay/gateway/filter?customerld=9999&customerName=z3 

注意观察控制台打印信息。。

3.5 响应头相关的配置

  1. The AddResponseHeader GatewayFilter Factory
  2. The RemoveResponseHeader GatewayFilter Factory
  3. ** The SetRequestHeader GatewayFilter Factory**
spring:
  cloud:
    gateway:
      routes:
      - id: add_response_header_route
        uri: https://example.org
        filters:
        - AddResponseHeader=X-Response-Red, Blue #新增响应头参数,并将X-Response-Red的值设置为Blue
        - RemoveResponseHeader=Content-Type # 将默认自带Content-Type回应属性删除
        - SetResponseHeader=Date,2099-11-11 # 设置响应头Date值为2099-11-11

3.6 前缀和路径相关的配置

  1. The PrefixPath GatewayFilter Factory(自动添加路径前缀)
  2. The SetPath GatewayFilter Factory(修改访问路径)
  3. The RedirectTo GatewayFilter Factory(重定向到某个页面)
spring:
  cloud:
    gateway:
      routes:
      - id: prefixpath_route
        uri: https://example.org
      # - Path=/gateway/filter/** # 真实地址
      - Path=/gateway/filter/** # 断言,为配合PrefixPath测试过滤
      - Path=/XYZ/abc/{segment}  # 断言,为配合SetPath测试,{segment}的内容最后被SetPath取代
        filters:
        - PrefixPath=/mypath	# 表示加了这个前缀胡访问的就是http://localhost:端口号/mypath/gateway/filter,,但是实际上调用的还是http://localhost:端口号/gateway/filter
        - SetPath=/pay/gateway/{segment}  # {segment}表示占位符,你写abc也行但要上下一致
        - RedirectTo=302, http://www.baidu.com/ # 访问http://localhost:9527/gateway/filter跳转到http://www.baidu.com/

4、自定义全局Filter

需求:统计接口调用耗时情况。
通过自定义全局过滤器搞定上述需求。

自定义全局过滤器的官方地址点击这里查看

4.1 实现步骤

1、新建类MyGlobalFilter并实现GlobalFilter,Ordered两个接口

@Component
@Slf4j
public class MyGlobalFilter implements GlobalFilter, Ordered{
    /**
     * 数字越小优先级越高
     * @return
     */
    @Override
    public int getOrder(){
        return 0;
    }

    private static final String BEGIN_VISIT_TIME = "begin_visit_time";//开始访问时间
    /**
     *第2版,各种统计
     * @param exchange
     * @param chain
     * @return
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //先记录下访问接口的开始时间
        exchange.getAttributes().put(BEGIN_VISIT_TIME, System.currentTimeMillis());

        return chain.filter(exchange).then(Mono.fromRunnable(()->{
            Long beginVisitTime = exchange.getAttribute(BEGIN_VISIT_TIME);
            if (beginVisitTime != null){
                log.info("访问接口主机: " + exchange.getRequest().getURI().getHost());
                log.info("访问接口端口: " + exchange.getRequest().getURI().getPort());
                log.info("访问接口URL: " + exchange.getRequest().getURI().getPath());
                log.info("访问接口URL参数: " + exchange.getRequest().getURI().getRawQuery());
                log.info("访问接口时长: " + (System.currentTimeMillis() - beginVisitTime) + "ms");
                log.info("我是美丽分割线: ###################################################");
                System.out.println();
            }
        }));
    }
}

2、yml配置文件

server:
  port: 9527

spring:
  application:
    name: cloud-gateway #以微服务注册进consul或nacos服务列表内
  cloud:
    consul: #配置consul地址
      host: localhost
      port: 8500
      discovery:
        prefer-ip-address: true
        service-name: ${spring.application.name}
    gateway:
      routes:
        - id: pay_routh1 #pay_routh1                #路由的ID(类似mysql主键ID),没有固定规则但要求唯一,建议配合服务名
          uri: lb://cloud-payment-service                #匹配后提供服务的路由地址
          predicates:
            - Path=/pay/gateway/get/**              # 断言,路径相匹配的进行路由
            - After=2023-12-30T23:02:39.079979400+08:00[Asia/Shanghai]

        - id: pay_routh2 #pay_routh2                #路由的ID(类似mysql主键ID),没有固定规则但要求唯一,建议配合服务名
          uri: lb://cloud-payment-service
          predicates:
            - Path=/pay/gateway/info/**              # 断言,路径相匹配的进行路由

        - id: pay_routh3 #pay_routh3
          uri: lb://cloud-payment-service                #匹配后提供服务的路由地址
          predicates:
            - Path=/pay/gateway/filter/**              # 断言,路径相匹配的进行路由,默认正确地址
          filters:
            - AddRequestHeader=X-Request-atguigu1,atguiguValue1  # 请求头kv,若一头含有多参则重写一行设置

3、测试
浏览器访问:

  • http://localhost:9527/pay/gateway/info
  • http://localhost:9527/pay/gateway/get/1
  • http://localhost:9527/pay/gateway/filter
    http://localhost:9527/pay/gateway/info
    请注意,上述示例代码仅供参考,你可能需要根据你的项目需求和实际情况进行适当的调整。
Spring Cloud - 手写 Gateway 源码,实现自定义局部 FilterFactory 例如,自定义一个 Token 局部过滤器,那么就可以创建一个类 filter.factory.TokenGatewayFilterFactory在 apply 中的过滤逻辑就是,判断前端是否传入 token,如果没有就抛异常,如果有就去 redis 上看看是否存在这个 token,如果存在就放行,不存在就抛异常.@Slf4j@Component // 表示在工厂中创建对象@Autowired/*** 核心方法: 处理过滤* @return*/@Override@Override。 阅读详情

相关推荐

【1.3 API服务网关(SpringCloudGateway)】Spring Cloud Gateway入门介绍 - 网关过滤器工厂

Spring Cloud Gateway中GlobalFilter和AbstractGatewayFilterFactory的区别

奶爸的编程之路,也就一周冷个三天 1260

Gateway 网关 (四) GatewayFilterFactory 局部过滤器 权限校验

废话 业务多,逻辑复杂的情况下,可能不同的域名过来的请求、不同的路径就需要配置不同的权限校验方式,这种情况的话直接用全局过滤器似乎就不是很方便了。 用这种方式的话确实会比较灵活,但是……老实说业务太复杂了也是配置文件挺大的,条件也多。 所以这里采用了一个专门用来做权限校验的局部过滤器(也可实现其他业务逻辑),搭配nacos动态配置,基本上可以满足业务需求。 缺点,gateway搭配nacos只能是用json的形式(yml理论上也可以,但是需要写的处理逻辑就太多了,麻烦),而nacos中json和y.

qq_33601179的博客 2775

ESP8266+Mixly+MIXIO物联网实战:用色盘控制WS2812 RGB灯(附完整代码)

本文详细介绍了如何利用ESP8266微控制器、Mixly图形化编程工具与MIXIO物联网平台,快速构建一个可通过网页色盘远程控制WS2812 RGB智能灯带的实战项目。内容涵盖硬件接线、平台配置、代码编写与调试全流程,旨在帮助物联网爱好者与初学者轻松实现创意灯光应用,掌握智能硬件开发的核心技能。

gin88的博客 262

Spring Cloud Gateway(十):网关过滤器工厂 GatewayFilterFactory

本文基于 spring cloud gateway 2.0.1 1、GatewayFilterFactory 简介 路由过滤器允许以某种方式修改传入的HTTP请求或传出的HTTP响应。 路径过滤器的范围限定为特定路径。 Spring Cloud Gateway包含许多内置的GatewayFilter工厂。 网关过滤器工厂接口有多个实现类,在每个 ...

weixin_30951231的博客 1941

CTP Python API及Demo(利用Swig 封装)Windows版(6.6.1traderapi)

环境:visual studio2015、python3.9、 参考的是景色大神的教程自己制作,因为直接用它编译好的无法使用,遂自己编译。 从CTP官网上下载CTP API点击下载。这里用的版本是v6.6.1_P1_tradeapi,想使用不同的版本下载即可: 安装Swig软件,本文中所用的Swig是swigwin-4.0.2版本,点击下载。下载后解压,将swig路径添加到环境变量中。 安装python,注意要安装64位版本,将环境变量配置好。本文所用的是3.9版本。 通过Swig得到pyth.

ProgramVAE的博客 2545

STM32 HAL库串口DMA接收不定长数据的两种实战方法:IDLE中断与超时管理详解

本文详细解析了STM32 HAL库中串口DMA接收不定长数据的两种实战方法:IDLE中断与超时管理。通过对比分析两种方案的硬件要求、响应速度和适用场景,为嵌入式开发者提供了高效可靠的串口通信解决方案,特别适用于智能家居、传感器网络等需要处理不定长数据包的应用场景。

weixin_30954265的博客 473

Spring cloud gateway 详解和配置使用(文章较长)

目录 spring cloud gateway 介绍 1. 网关是怎么演化来的 2. 网关的基本功能 3.关于Spring Cloud Gateway 4.Spring Cloud Gateway 功能特征 5.predicate简介 6.GatewayFilter 工厂介绍 7.集成Hystrix的断路器功能 8.请求限流 pom.xml application.ym...

荡漾 21万+

【可信数据空间-连接器技术架构设计方案】

一句话概括连接器是可信数据空间的“数据保镖”和“外交官”。连接器就是一个部署在你本地的软件代理,它代表你安全地对外提供数据服务,确保在共享数据价值的同时,牢牢守住数据的所有权和控制权。它是实现“数据可用不可见”这一理想的关键技术部件。一个生动的比喻:银行的金库和接待员想象一下,你的数据就是藏在银行金库里的黄金和钞票。金库(你的内部数据库): 绝对安全,外人绝对不能进。接待员(连接器): 坐在银行大厅里,负责与客户打交道。客户向接待员提出请求:“我想取1000元。

u014716614的博客 2278

Spring Cloud Gateway中GatewayFilter Factories(网关过滤工厂)的详细介绍

在 Spring Cloud Gateway 中,GatewayFilter Factories(网关过滤工厂) 主要用于 拦截和修改 HTTP 请求或响应,可以在请求被路由到目标服务之前或者返回客户端之前进行处理。作用范围:前置过滤(Pre-Filter):在请求被转发到下游服务前执行,如权限校验、日志记录、参数修改等。后置过滤(Post-Filter):在请求处理完毕返回响应时执行,如添加响应头、记录响应日志等。路由过滤器允许以某种方式修改传入的 HTTP 请求或传出的 HTTP 响应。

tigerhhzz的博客 1443

IAR9.30以上版本安装、注册、新建工程和配置过程详细介绍

IAR 一般是指一款嵌入式软件的集成开发环境,类似于 MDK-Keil 这款软件。IAR 对于不同的内核处理器,是对应不同的 IAR 软件的,IAR 到目前为止支持大部分的MCU,比如8051系列、ARM架构系列、MSP430系列、AVR系列等等这些常用的芯片架构。对于 ARM 架构的芯片,有对应的 IAR Embedded Workbench for ARM 软件平台,因为我主要是使用 ARM 架构芯片,下面安装、注册和使用都是基于这个版本进行介绍的。

luobeihai的博客 6万+

嵌入式系统开发笔记96:将STM32CubeIDE设置为中文

本文介绍将STM32CubeIDE设置为中文的方法。

snmplink的博客 8540

【JavaEE】【SpringCloud】网关_GateWay

网关GateWay

yj20040627的博客 1448

看28377代码笔记

使用的是20MHz外部晶振,为取200MHz系统时钟,倍频设为20,分频设为2,这样sysclock = 20MHz * 20 / 2,正好200MHz。注意:SPISTE配置成普通的GPIO端口,是为了更好控制芯片,配置芯片的时序。FMULT_0:小数点位数,小数只能有0,0.25,0.5,0.75四个选择。XTAL_OSC:表示使用外部晶振。GPIO_MUX_CPU1:复用类型。GPIO_MUX_CPU1:复用类型。PLLCLK_BY_2:表示2分频。IMULT_20:表示倍频数。

小柚子的博客 809

【深入解析spring cloud gateway】03 网关内置过滤器工厂( GatewayFilter Factories)

网关内置过滤器工厂讲解

程序员笔记 998

记录:解决Ubuntu20.04安装ros报错E: Unable to locate package ros-kinetic-desktop-full【亲测有效】

报错:E: Unable to locate package ros-kinetic-desktop-full.尝试好久一直都无法下载,最后得知真相的我眼泪哗哗的直流。

**My Coding Family** 6万+

Camera2Demo

在Camera2 的基础上进行封装,使得Camera2一堆初始化逻辑与Activity分离,降低耦合度,完成预览拍照并保存的操作

Spring Cloud系列—Gateway统一服务入口

Gateway的路由匹配基于Route Predicate Factories(路由断言工厂),在Gateway的配置文件中,通常会定义路由匹配规则,服务启动时Route Predicate Factories会识别路由匹配规则并转化为Predicate对象,然后由这些Predicate的条件组合来进行请求的路由。GlobalFilter是Gateway的全局过滤器,也是用来条件过滤的,不同的是GlobalFilter应用于全局所有请求,而GatewayFilter只应用于对应设置的路由。

sniper_fandc的博客 1347

假人有限元模型

假人模型,车辆碰撞假人有限元模型,适合做乘员安全的研究者利用

【Gateway】Gateway Filter Factories

GatewayFilter讲解以及过滤器的执行顺序和自定义过滤器

关关的博客 1689

Outlook Express 6 (OE6) for Win7/Win8/Win10

英文版 Outlook Express6.0, 兼容Win7/Win10/WinXP,解压就可用。

ssm框架搭建

这个是一个在idea上成功跑起来的ssm框架项目,保存在这里方便以后使用直接下载

Spring-cloud 主键Gateway

摘要:本文介绍了API网关的核心概念及其在微服务架构中的作用,包括身份验证、动态路由、负载均衡和限流等功能。重点讲解了Spring Cloud Gateway的实现方式,包括项目创建、依赖配置、路由规则设置和过滤器应用。详细解析了RoutePredicateFactories路由断言和GatewayFilterFactories过滤器的使用,并演示了如何自定义过滤器和全局过滤器。文章还涉及过滤器执行顺序的优先级规则,为微服务架构中的API网关实现提供了完整的技术指导。

2302_81705247的博客 855

【SpringCloud】Gateway Filter Factories && 过滤器执行顺序 && 自定义过滤器

Spring Cloud Gateway的过滤器分为GatewayFilter和GlobalFilter两种类型。GatewayFilter通过配置文件实现,作用于单个路由或路由组;GlobalFilter通过代码实现,作用于所有路由。GatewayFilter示例展示了如何通过AddRequestParameter为请求添加参数,而default-filters可配置全局生效的过滤器。GlobalFilter提供了更高的灵活性,支持业务资源访问和精确的顺序控制,但需要编写代码实现。两者共同作用于请求

lirendada的博客 1324

《Spring Cloud Gateway 快速入门:从路由到自定义 Filter 的完整教程》​

Spring Cloud Gateway提供了过滤器的扩展功能,开发者可以根据实际业务来自定义过滤器,同样自定义过滤器也支持GatewayFilter和GlobalFilter两种自定义GatewayFilter需要去实现对应的接口GatewayFilterFactory,SpringBoot默认帮我们实现的抽象类是,可以直接使用,由于我们还要声明该过滤器的优先级,所以还要去实现Ordered接口,分别去重写里面的方法。

2302_80826557的博客 1291

Spring Cloud Gateway - GatewayFilter路由过滤器

本文会对Spring cloud Gateway 作更深入的应用解析。既然网关会对请求进行权限验证, 这一步就会在GatewayFilter里实现。

nvd11的专栏 449

统一服务入口——Spring Cloud Gateway

API网关也是一个服务其中,id可以随便起一个,uri中的lb表示负载均衡,predicates表示路由条件(在当前配置表示所有路径符合Path规则的请求,都会代理到uri参数指定的地址)

zhakakqns的博客 1202

Spring cloud组件gateway网关详细剖析

Spring Cloud Gateway 的核心配置通常在文件中完成。spring:cloud:gateway:routes:- id: user-service-route # 路由ID,唯一# lb:// 前缀表示启用服务发现和负载均衡,userservice 为服务名predicates: # 断言:匹配 /user/ 开头的请求filters: # 过滤器:移除第一级路径前缀 /userfilters:断言工厂说明示例Path基于请求路径匹配Method匹配HTTP请求方法。

qq_39126115的博客 548

微服务_Spring Cloud_OpenFeign与网关

OpenFeign 是声明式 Web 服务客户端,用于微服务之间远程 HTTP 调用,特点: 只需要定义接口 + 添加注解,就能像调用本地 Service 一样调用远程微服务接口,写法风格和 Controller 完全一致,屏蔽了 RestTemplate、原生 HttpClient 拼接 URL、处理请求的繁琐过程。

2501_93103214的博客 272

【Spring Cloud Alibaba】Gateway(一)

我们微服务的架构,就是将一个大的业务/服务,拆分成多个小的业务与服务。每个业务都会需要鉴权、限流、权限校验、跨域等逻辑,如果每个业务都各自为战,自己造轮子实现一遍,会很蛋疼,完全可以抽出来,放到一个统一的地方去做。

Blue_Pepsi_Cola的博客 605

统一服务入口-Gateway

前面的课程中,我们通过 Eureka,Nacos 解决了服务注册,服务发现的问题,使用 Spring Cloud LoadBalanced 解决了负载均衡问题,使用 OpenFeign 解决了远程调用问题。但是,当前的所有微服务接口都是直接对外暴露的,可以直接通过外部进行访问。为了保证对外服务的安全性,服务端实现的微服务接口通常带有一定的权限校验。由于使用了微服务模块,原本一个应用的多个模块被拆分成了多个应用,导致我们需要进行多次逻辑校验。当逻辑校验发生变化时,就需要改变多个应用。

Zz_waiting的博客 1135
上一篇: 利用Maven与MyBatis Generator自动化生成实体类与Mapper组件:微服务开发效率提升策略
下一篇: 你是如何克服编程学习中的挫折感的?
-今非昔比°
博客等级 码龄5年 213粉丝 83原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

-今非昔比°

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值