Spring Cloud全解析:网关之GateWay过滤器

2024-08-31 05:12

本文主要是介绍Spring Cloud全解析:网关之GateWay过滤器,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

GateWay过滤器

路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应,只能指定路由进行使用,由GatewayFilter的工厂类来产生,Gateway官方提供了很多的路由过滤器,也可以实现自己的自定义过滤器

内置过滤器

请求头/响应头过滤器
  • AddRequestHeaderGatewayFilterFactory

  • AddResponseHeaderGatewayFilterFactory

  • DedupeResponseHeaderGatewayFilterFactory 处理重复响应头

    有三种策略 RETAIN_FIRST、RETAIN_LAST、RETAIN_UNIQUE

    spring:cloud:gateway:default-filters:- DedupeResponseHeader=Access-Control-Allow-Credentials, RETAIN_LAST #规则写在最后
    
  • PreserveHostHeaderGatewayFilterFactory

  • RemoveRequestHeaderGatewayFilterFactory

  • RemoveResponseHeaderGatewayFilterFactory

  • RequestHeaderSizeGatewayFilterFactory

  • SecureHeadersGatewayFilterFactory

  • SetRequestHeaderGatewayFilterFactory

  • SetResponseHeaderGatewayFilterFactory

请求参数过滤器
  • AddRequestParameterGatewayFilterFactory

    spring:cloud:gateway:default-filters:- AddRequestHeader=X-Request-red, blue
    
  • RemoveRequestParameterGatewayFilterFactory

路径过滤器
  • PrefixPathGatewayFilterFactory 为匹配的url添加指定前缀

    spring:cloud:gateway:default-filters:- PrefixPath=/mypath # 增加指定前缀,如/hello变成/mypath/hello
    
  • RewritePathGatewayFilterFactory 采用正则表达式替换参数

    spring:cloud:gateway:default-filters:- RewritePath=/red/?(?<segment>.*), /$\{segment} # 两个参数,一个是请求路径的正则表达式,一个是替换的路径参数,如/red/blue会变成/blue
    
  • SetPathGatewayFilterFactory

  • StripPrefixGatewayFilterFactory 在将请求发送到下游之前从请求中剥离的路径个数

    spring:cloud:gateway:default-filters:- StripPrefix=2 # 如/mypath/red/blue会变成/blue
    
请求体/响应体过滤器
  • RequestSizeGatewayFilterFactory
响应状态过滤器
  • SetStatusGatewayFilterFactory

    spring:cloud:gateway:default-filters:- SetStatus=401
    
会话过滤器
  • SaveSessionGatewayFilterFactory
重定向过滤器
  • RedirectToGatewayFilterFactory
重试过滤器
  • RetryGatewayFilterFactory
限流过滤器
  • RequestRateLimiterGatewayFilterFactory

自定义

自定义全局过滤器

实现自定义的全局过滤器,需要实现GlobalFilter和Ordered接口,全局过滤器,不需要在配置文件中配置,作用在所有的路由上,最终通过 GatewayFilterAdapter 包装成 GatewayFilterChain 可识别的过滤器,为请求业务以及路由的 URI 转换为真实业务服务请求地址的核心过滤器,不需要配置系统初始化时加载,并作用在每个路由上

@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {System.out.println("过滤器进入");String token = exchange.getRequest().getQueryParams().getFirst("token");if(StringUtils.isBlank(token)){System.out.println("不包含token");exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);return exchange.getResponse().setComplete();}// 继续执行过滤器链return chain.filter(exchange);}@Overridepublic int getOrder() {return 0;}
}

全局过滤器不需要在配置文件中配置

自定义网关过滤器
实现GatewayFilter方式

需要实现GatewayFilter和Ordered接口

@Component
public class MyCustomFilter implements GatewayFilter, Ordered {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {System.out.println("自定义过滤器进入");// 继续执行过滤器链return chain.filter(exchange);}@Overridepublic int getOrder() {return 0;}
}

需要使用java编码来配置自定义过滤器

@Configuration
public class MyConfig {/**配置自定义过滤器*/@Beanpublic RouteLocator routeLocator(RouteLocatorBuilder builder) {return builder.routes().route(r ->r.path("/provider/**")//用户访问的路径.uri("lb://service-provider")//路由的真实服务器ip+端口.filters(new MyCustomFilter()) // 局部过滤器.id("provider_route")) // 路由id.build();}
}

使用GatewayFilter还需要硬编码,不太好用,那么有没有更方便的方式呢?

继承AbstractGatewayFilterFactory
public class MyCustomGatewayFilterFactory extends AbstractGatewayFilterFactory<MyCustomGatewayFilterFactory.Config> {public MyCustomGatewayFilterFactory() {super(Config.class);}@Overridepublic GatewayFilter apply(Config config, Class<Config> configClass) {// 在这里创建并返回过滤器实例return (exchange, chain) -> {// 过滤器逻辑return chain.filter(exchange);};}public static class Config {// 过滤器的配置参数}
}

配置

spring:cloud:gateway:routes:- id: myuri: http://example.comfilters:- MyCustom=1predicates:- Path=/api/**

https://zhhll.icu/2021/框架/微服务/springcloud/网关/GateWay/3.GateWay过滤器/

这篇关于Spring Cloud全解析:网关之GateWay过滤器的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1122986

相关文章

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流(parallelStream)的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS

Java中Redisson 的原理深度解析

《Java中Redisson的原理深度解析》Redisson是一个高性能的Redis客户端,它通过将Redis数据结构映射为Java对象和分布式对象,实现了在Java应用中方便地使用Redis,本文... 目录前言一、核心设计理念二、核心架构与通信层1. 基于 Netty 的异步非阻塞通信2. 编解码器三、

SpringBoot基于注解实现数据库字段回填的完整方案

《SpringBoot基于注解实现数据库字段回填的完整方案》这篇文章主要为大家详细介绍了SpringBoot如何基于注解实现数据库字段回填的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以了解... 目录数据库表pom.XMLRelationFieldRelationFieldMapping基础的一些代

一篇文章彻底搞懂macOS如何决定java环境

《一篇文章彻底搞懂macOS如何决定java环境》MacOS作为一个功能强大的操作系统,为开发者提供了丰富的开发工具和框架,下面:本文主要介绍macOS如何决定java环境的相关资料,文中通过代码... 目录方法一:使用 which命令方法二:使用 Java_home工具(Apple 官方推荐)那问题来了,

Java HashMap的底层实现原理深度解析

《JavaHashMap的底层实现原理深度解析》HashMap基于数组+链表+红黑树结构,通过哈希算法和扩容机制优化性能,负载因子与树化阈值平衡效率,是Java开发必备的高效数据结构,本文给大家介绍... 目录一、概述:HashMap的宏观结构二、核心数据结构解析1. 数组(桶数组)2. 链表节点(Node

Java AOP面向切面编程的概念和实现方式

《JavaAOP面向切面编程的概念和实现方式》AOP是面向切面编程,通过动态代理将横切关注点(如日志、事务)与核心业务逻辑分离,提升代码复用性和可维护性,本文给大家介绍JavaAOP面向切面编程的概... 目录一、AOP 是什么?二、AOP 的核心概念与实现方式核心概念实现方式三、Spring AOP 的关

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储:配置灵活性:编码示例引入依赖:配置ehcache.XML文件:配置

Java 虚拟线程的创建与使用深度解析

《Java虚拟线程的创建与使用深度解析》虚拟线程是Java19中以预览特性形式引入,Java21起正式发布的轻量级线程,本文给大家介绍Java虚拟线程的创建与使用,感兴趣的朋友一起看看吧... 目录一、虚拟线程简介1.1 什么是虚拟线程?1.2 为什么需要虚拟线程?二、虚拟线程与平台线程对比代码对比示例:三

一文解析C#中的StringSplitOptions枚举

《一文解析C#中的StringSplitOptions枚举》StringSplitOptions是C#中的一个枚举类型,用于控制string.Split()方法分割字符串时的行为,核心作用是处理分割后... 目录C#的StringSplitOptions枚举1.StringSplitOptions枚举的常用

Python函数作用域与闭包举例深度解析

《Python函数作用域与闭包举例深度解析》Python函数的作用域规则和闭包是编程中的关键概念,它们决定了变量的访问和生命周期,:本文主要介绍Python函数作用域与闭包的相关资料,文中通过代码... 目录1. 基础作用域访问示例1:访问全局变量示例2:访问外层函数变量2. 闭包基础示例3:简单闭包示例4