【云原生&微服务＞SCG网关篇六】Spring Cloud Gateway内置的18种Filter使用姿势

【云原生&微服务＞SCG网关篇六】Spring Cloud Gateway内置的18种Filter使用姿势

文章目录

​​一、前言​​​​二、GatewayFilter Factories​​

​​1、请求/响应新增信息相关​​

​​1）增加请求头参数（AddRequestHeaderGatewayFilterFactory）​​

​​添加动态请求头​​

​​2）添加请求参数（AddRequestParameterGatewayFilterFactory）​​

​​添加动态请求参数​​

​​3）添加请求响应的请求头参数（AddResponseHeaderGatewayFilterFactory）​​

​​2、请求/响应移除信息相关​​

​​1）移除重复响应头（DedupeResponseHeaderGatewayFilterFactory）​​​​2）移除响应头中的参数（RemoveResponseHeaderGatewayFilterFactory）​​​​3）移除请求头中的参数（RemoveRequestHeaderGatewayFilterFactory）​​​​4）移除请求中的参数（RemoveRequestParameterGatewayFilterFactory）​​

​​3、请求/响应头信息替换​​

​​1）设置请求头信息（SetRequestHeaderGatewayFilterFactory）​​​​2）设置响应头信息（SetResponseHeaderGatewayFilterFactory）​​​​3）设置响应状态码（SetStatusGatewayFilterFactory）​​

​​4、请求路径层级相关​​

​​1）移除请求层级（StripPrefixGatewayFilterFactory）​​​​2）增加请求层级（PrefixPathGatewayFilterFactory）​​

​​5、其他​​

​​1）请求Host信息传递（PreserveHostHeaderGatewayFilterFactory）​​​​2）透传session信息（SaveSessionGatewayFilterFactory）​​​​3）设置请求最大Size（RequestSizeGatewayFilterFactory）​​​​4）重写路由转发地址（RewritePathGatewayFilterFactory）​​​​5）配置300系列状态码转发地址（RedirectToGatewayFilterFactory）​​

​​6、给所有的Route设置DefaultFilter​​

​​三、总结​​

一、前言

至此微服务网关系列文章已出：

​​【云原生&微服务＞SCG网关篇一】为什么要有网关、生产环境如何选择网关​​​​云原生&微服务＞SCG网关篇二】生产上那些灰度发布方式​​​​【云原生&微服务＞SCG网关篇三】Spring Cloud Gateway是什么、详细使用案例​​​​云原生&微服务＞SCG网关篇四】Spring Cloud Gateway内置的11种PredicateFactory如何使用​​​​【云原生&微服务＞SCG网关篇五】Spring Cloud Gateway自定义PredicateFactory​​

聊了以下问题：

为什么要有网关？网关的作用是什么？网关的分类？网关的技术选型？使用网关时常用的灰度发布方式有哪些？Spring Cloud Gateway是什么？详细使用案例？Spring Cloud Gateway内置的11种PredicateFactory如何自定义PredicateFactory

本文接着聊Spring Cloud Gateway内置的Filter。

PS：SpringCloud版本信息：

2.4.2 2020.0.1 2021.1 org.springframework.boot spring-boot-dependencies ${spring-boot.version} pom import org.springframework.cloud spring-cloud-dependencies ${spring-cloud.version} pom import com.alibaba.cloud spring-cloud-alibaba-dependencies ${spring-cloud-alibaba.version} pom import

二、GatewayFilter Factories

Route filters 允许以某种方式修改传入HTTP的请求 或 传出HTTP的响应，其作用于特定的路由；Spring Cloud Gateway包括许多内置GatewayFilter工厂。

官方文档：​​ cloud: gateway: routes: - id: add_request_header_route uri: predicates: - Path=/** filters: - AddRequestHeader=entrance-header,

添加动态请求头

**此外：**添加的请求头参数可以根据Predicate的内容做动态填充，比如：

spring: cloud: gateway: routes: - id: add_request_header_route uri: predicates: - Path=/red/{segment} filters: - AddRequestHeader=entrance-header, Blue-{segment}

2）添加请求参数（AddRequestParameterGatewayFilterFactory）

对所有请求增加entrance=gateway这个查询参数；

spring: cloud: gateway: routes: - id: add_request_parameter_route uri: predicates: - Path=/** filters: - AddRequestParameter=entrance,

示例请求如下：

添加动态请求参数

此外： 添加的查询参数可以根据Predicate的内容做动态填充，比如：

spring: cloud: gateway: routes: - id: add_request_parameter_route uri: predicates: - Host: {segment}.myhost.org filters: - AddRequestParameter=foo, bar-{segment}

3）添加请求响应的请求头参数（AddResponseHeaderGatewayFilterFactory）

对所有请求的响应增加entrance-header=gateway这个请求头；

spring: cloud: gateway: routes: - id: add_response_header_route uri: predicates: - Path=/** filters: - AddResponseHeader=saint-response-header,

示例验证如下：

2、请求/响应移除信息相关

1）移除重复响应头（DedupeResponseHeaderGatewayFilterFactory）

DedupeResponseHeader GatewayFilter factory有两个入参，一个是请求头的name，一个是可选参数：去重策略；

去重策略有三种：​​RETAIN_FIRST​​​保留第一个(default)、​​RETAIN_LAST​​​保留最后一个、​​RETAIN_FIRST RETAIN_UNIQUE​​ 保留唯一。

spring: cloud: gateway: routes: - id: add_request_parameter_route uri: predicates: - Path=/** filters: - DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin

示例为：移除重复的响应头信息 ​​Access-Control-Allow-Credentials​​​ and ​​Access-Control-Allow-Origin​​ ，以防止网关CORS逻辑 和 下游逻辑都添加它们。

2）移除响应头中的参数（RemoveResponseHeaderGatewayFilterFactory）

移除响应头中的参数：X-Response-Foo；

spring: cloud: gateway: routes: - id: add_request_parameter_route uri: predicates: - Path=/** filters: - RemoveResponseHeader=X-Response-Foo

3）移除请求头中的参数（RemoveRequestHeaderGatewayFilterFactory）

移除请求头中的参数: X-Request-red

spring: cloud: gateway: routes: - id: remove_request_header_route uri: predicates: - Path=/** filters: - RemoveRequestHeader=X-Request-red

4）移除请求中的参数（RemoveRequestParameterGatewayFilterFactory）

移除请求中的查询参数：red

spring: cloud: gateway: routes: - id: remove_request_parameter_route uri: predicates: - Path=/** filters: -

3、请求/响应头信息替换

此处和请求/响应新增信息一样，也支持动态参数配置。

1）设置请求头信息（SetRequestHeaderGatewayFilterFactory）

设置请求头，没有则新增，有则修改

spring: cloud: gateway: routes: - id: simple_service_route uri: predicates: - Path=/gateway/simple-service/** filters: - SetRequestHeader=saint-request-header, saint-request

2）设置响应头信息（SetResponseHeaderGatewayFilterFactory）

设置响应头，没有则新增，有则修改

spring: cloud: gateway: routes: - id: simple_service_route uri: predicates: - Path=/gateway/** filters: - SetResponseHeader=saint-response-header, saint-response

示例验证：我们请求头中​​saint-request-header​​的值为：request，而发送请求后：

3）设置响应状态码（SetStatusGatewayFilterFactory）

修改响应的状态码为特定值：可以是org.springframework. cloud: gateway: routes: - id: simple_service_route uri: predicates: - Path=/** filters: -

示例中：无论哪种情况，响应的 HTTP 状态都会被设置为 401。

4、请求路径层级相关

1）移除请求层级（StripPrefixGatewayFilterFactory）

StripPrefix参数表示在将请求发送到下游之前从请求中剥离的路径个数。

spring: cloud: gateway: routes: - id: simple_service_route uri: predicates: - Path=/gateway/simple-service/** filters: -

示例中设置StripPrefix=2，则当通过网关向​​ cloud: gateway: routes: - id: simple_service_route uri: predicates: - Path=/gateway/** filters: -

示例中设置PrefixPath=/saint，则当通过网关向​​ cloud: gateway: routes: - id: simple_service_route uri: predicates: - Path=/gateway/** filters: -

2）透传session信息（SaveSessionGatewayFilterFactory）

SaveSession GatewayFilter factory迫使在向下游转发调用之前强制执行​​WebSession::save操作​​；当集成Spring Session时会将session放到Redis，来实现共享Session功能；

如果gateway项目集成了Spring Session中的Spring Security框架，想要将安全验证信息转发到远程应用，那么这个配置是必须的。

spring: cloud: gateway: routes: - id: simple_service_route uri: predicates: - Path=/gateway/** filters: -

3）设置请求最大Size（RequestSizeGatewayFilterFactory）

设置请求的最大Size，默认单位B，可以加 ‘KB’ 或 ‘MB’ 后缀；请求超过配置的maxSize，则会匹配路由失败

spring: cloud: gateway: routes: - id: simple_service_route uri: predicates: - Path=/gateway/** filters: - name: RequestSize args: maxSize: 5000000

4）重写路由转发地址（RewritePathGatewayFilterFactory）

RewritePath GatewayFilter factory包含两个参数：正则表达形式的路径、正则表达形式的替代路径；其使用Java正则表达式来灵活地重写请求路径；

spring: cloud: gateway: routes: - id: simple_service_route uri: predicates: - Path=/gateway/** filters: - RewritePath=/gateway(?/?.*), $\{segment}

比如一个请求打向​​/gateway/hello​​​，会被转发到​​/hello​​。

5）配置300系列状态码转发地址（RedirectToGatewayFilterFactory）

RedirectTo GatewayFilter factory包含两个参数：状态码、和对应的转发地址url；

状态码参数应该是300系列重定向HTTP代码：

301 Moved Permanently永久移动，请求的资源已被永久移动新位置，返回信息会包含URI，浏览器会自动定向到新地址，以后请求应该用新的URI代替；302 Found 临时移动，与301类似，资源临时被移动，客户端应该继续使用原URI；303 See Other查看其它地址，与301类似。使用GET和POST请求查看；304 未修改，所请求资源未修改，服务器返回此状态吗时，不会返回任何资源；305 Use proxy 使用代理，所请求资源必须通过代理；306 Unused 已经废弃的HTTP状态码；307 Temporary Redirect 临时重定向，与302类似，使用GET请求重定向；

**转发地址url：**必须是有有效的URL，其是Response Header中Location属性的值，对于相对重定向，应该使用uri:no://op作为路由定义的uri。

spring: cloud: gateway: routes: - id: simple_service_route uri: predicates: - Path=/gateway/** filters: - RedirectTo=302, Header中将增加一个属性值为​​ cloud: gateway: default-filters: - AddResponseHeader=X-Response-Default-Red, Default-Blue -

三、总结

本文一共介绍了Gateway内置的18种常用的Filter，包括：针对单个路由的请求、响应、路由路径，针对所有Route的Default-Filters。

后续文章我们聊一下Filter的高级用法，比如：限流、熔断、重试等。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。