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

相关文章

nginx -t、nginx -s stop 和 nginx -s reload 命令的详细解析(结合应用场景)

《nginx-t、nginx-sstop和nginx-sreload命令的详细解析(结合应用场景)》本文解析Nginx的-t、-sstop、-sreload命令,分别用于配置语法检... 以下是关于 nginx -t、nginx -s stop 和 nginx -s reload 命令的详细解析,结合实际应

Spring boot整合dubbo+zookeeper的详细过程

《Springboot整合dubbo+zookeeper的详细过程》本文讲解SpringBoot整合Dubbo与Zookeeper实现API、Provider、Consumer模式,包含依赖配置、... 目录Spring boot整合dubbo+zookeeper1.创建父工程2.父工程引入依赖3.创建ap

MyBatis中$与#的区别解析

《MyBatis中$与#的区别解析》文章浏览阅读314次,点赞4次,收藏6次。MyBatis使用#{}作为参数占位符时,会创建预处理语句(PreparedStatement),并将参数值作为预处理语句... 目录一、介绍二、sql注入风险实例一、介绍#(井号):MyBATis使用#{}作为参数占位符时,会

SpringBoot结合Docker进行容器化处理指南

《SpringBoot结合Docker进行容器化处理指南》在当今快速发展的软件工程领域,SpringBoot和Docker已经成为现代Java开发者的必备工具,本文将深入讲解如何将一个SpringBo... 目录前言一、为什么选择 Spring Bootjavascript + docker1. 快速部署与

Spring Boot spring-boot-maven-plugin 参数配置详解(最新推荐)

《SpringBootspring-boot-maven-plugin参数配置详解(最新推荐)》文章介绍了SpringBootMaven插件的5个核心目标(repackage、run、start... 目录一 spring-boot-maven-plugin 插件的5个Goals二 应用场景1 重新打包应用

SpringBoot+EasyExcel实现自定义复杂样式导入导出

《SpringBoot+EasyExcel实现自定义复杂样式导入导出》这篇文章主要为大家详细介绍了SpringBoot如何结果EasyExcel实现自定义复杂样式导入导出功能,文中的示例代码讲解详细,... 目录安装处理自定义导出复杂场景1、列不固定,动态列2、动态下拉3、自定义锁定行/列,添加密码4、合并

Spring Boot集成Druid实现数据源管理与监控的详细步骤

《SpringBoot集成Druid实现数据源管理与监控的详细步骤》本文介绍如何在SpringBoot项目中集成Druid数据库连接池,包括环境搭建、Maven依赖配置、SpringBoot配置文件... 目录1. 引言1.1 环境准备1.2 Druid介绍2. 配置Druid连接池3. 查看Druid监控

Java中读取YAML文件配置信息常见问题及解决方法

《Java中读取YAML文件配置信息常见问题及解决方法》:本文主要介绍Java中读取YAML文件配置信息常见问题及解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要... 目录1 使用Spring Boot的@ConfigurationProperties2. 使用@Valu

创建Java keystore文件的完整指南及详细步骤

《创建Javakeystore文件的完整指南及详细步骤》本文详解Java中keystore的创建与配置,涵盖私钥管理、自签名与CA证书生成、SSL/TLS应用,强调安全存储及验证机制,确保通信加密和... 目录1. 秘密键(私钥)的理解与管理私钥的定义与重要性私钥的管理策略私钥的生成与存储2. 证书的创建与

浅析Spring如何控制Bean的加载顺序

《浅析Spring如何控制Bean的加载顺序》在大多数情况下,我们不需要手动控制Bean的加载顺序,因为Spring的IoC容器足够智能,但在某些特殊场景下,这种隐式的依赖关系可能不存在,下面我们就来... 目录核心原则:依赖驱动加载手动控制 Bean 加载顺序的方法方法 1:使用@DependsOn(最直