Gateway过滤器详解

2年前 (2022) 程序员胖胖胖虎阿
225 0 0

本文来详细说下gateway中的过滤器相关的知识与内容。

文章目录

  • 概述
  • 过滤器类型
    • 局部过滤器(GatewayFilter)
    • 全局过滤器(GlobalFilter)
  • 本文小结

概述

三个知识点

  1. 作用:过滤器就是在请求的传递过程中,对请求和响应做一些手脚
  2. 生命周期:Pre Post
  3. 分类:局部过滤器(作用在某一个路由上)全局过滤器(作用全部路由上)

在Gateway中,Filter的生命周期只有两个:“pre”和“post”。

  • PRE:这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
  • POST:这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。

Gateway过滤器详解


过滤器类型

Gateway 的Filter从作用范围可分为两种:GatewayFilter与GlobalFilter。

  • GatewayFilter:应用到单个路由或者一个分组的路由上。
  • GlobalFilter:应用到所有的路由上。

局部过滤器(GatewayFilter)

局部过滤器(GatewayFilter)是针对单个路由的过滤器,对访问的URL过滤,切面处理。在Spring Cloud Gateway中通过GatewayFilter的形式内置了很多不同类型的局部过滤器。

过滤器工厂 作用 参数
AddRequestHeader 为原始请求添加Header Header的名称及值
AddRequestParameter 为原始请求添加请求参数 参数名称及值
AddResponseHeader 为原始响应添加Header Header的名称及值
DedupeResponseHeader 剔除响应头中重复的值 需要去重的Header名称及去重策略
Hystrix 为路由引入Hystrix的断路器保护 Hystrixcommand的名称
FallbackHeaders 为fallbackUri的请求头中添加具体的异常信息 Header的名称
PrefixPath 为原始请求路径添加前缀 前缀路径
PreserveHostHeader 为请求添加一个preserveHostHeader=true的属性,路由过滤器会检查该属性以决定是否要发送原始的Host
RequestRateLimiter 用于对请求限流,限流算法为令牌桶 keyResolver、rateLimiter、statusCode、denyEmptyKey、emptyKeyStatus
RedirectTo 将原始请求重定向到指定的URL http状态码及重定向的url
RemoveHopByHopHeadersFilter 为原始请求删除IETF组织规定的一系列Header Header名称
RemoveResponseHeader 为原始请求删除某个Header Header的名称
RewritePath 重写原始的请求路径 原始路径正则表达式以及重写后路径的正则表达式
RewriteResponseHeader 重写原始响应中的某个Header Header名称,值的正则表达式,重写后的值
SaveSession 在转发请求之前,强制执行websession::save操作
secureHeaders 为原始响应添加一系列起安全作用的响应头 无,支持修改这些安全响应头的值
SetPath 修改原始的请求路径 修改后的路径
SetResponseHeader 修改原始响应中某个Header的值 Header名称,修改后的值
SetStatus 修改原始响应的状态码 HTTP状态码,可以是数字,也可以是字符串
StripPrefix 用于截断原始请求的路径 使用数字表示要截断的路径的数量
Retry 针对不同的响应进行重试 retries、statuses、methods、 series
RequestSize 设置允许接收最大请求包的大小。如果请求包大小超过设置的值,则返413Payload Too Large 请求包大小,单位为字节,默认值为5M
ModifyRequestBody 在转发请求之前修改原始请求体内容 修改后的请求体内容
ModifyResponseBody 修改原始响应体的内容 修改后的响应体内容

全局过滤器(GlobalFilter)

全局过滤器作用于所有路由,无需配置。通过全局过滤器可以实现对权限的统一校验,安全性验证等功能。

SpringCloud Gateway内部也是通过一系列的内置全局过滤器对整个路由转发进行处理如下

Gateway过滤器详解


本文小结

本文详细介绍了gateway过滤器相关的内容和知识。介绍了相关的理论知识,后面会写一篇过滤有关的实际例子使用。

版权声明:程序员胖胖胖虎阿 发表于 2022年9月5日 下午4:00。
转载请注明:Gateway过滤器详解 | 胖虎的工具箱-编程导航

相关文章

暂无评论

暂无评论...