SpringCloud:SpringCloudGateway对Forwarded和X-Forwarded-*处理分析

一、SpringCloudGateway作为服务器端

1、在接收到包含Forwarded或X-Forwarded-*的HTTP请求头时,会根据部署环境决定是否进行解析

根据部署环境决定是否进行解析的代码可以如下类中找到:

org.springframework.boot.autoconfigure.web.embedded.NettyWebServerFactoryCustomizer

若部署在容器云环境,则默认是要进行解析的,支持的容器云环境对应的环境参数可以在如下类中找到

org.springframework.boot.cloud.CloudPlatform

如果想让它不解析,则配置参数:

server.forwardHeadersStrategy=none

若不部署在容器云,则默认是不进行解析的

如果想让它解析,则配置参数:

server.forwardHeadersStrategy=native

2、Forwarded或X-Forwarded-*的HTTP请求头如何解析定义在如下类中:

reactor.netty.http.server.DefaultHttpForwardedHeaderHandler

它会优先解析Forwarded,若Forwarded不存在才解析X-Forwarded-*,

Forwarded例子如下:

Forwarded:proto=http;host="15.62.25.113:8099";for="15.62.25.117:41668"

X-Forwarded-*例子如下:

X-Forwarded-For解析成远程IP,若有多个取第一个
X-Forwarded-Host解析成本地IP,若有多个取第一个
X-Forwarded-Port解析成本地port,若有多个取第一个
X-Forwarded-Proto解析成scheme,若有多个取第一个

此时如下API就能拿到这两个地址,原始的地址会被替换

ServerHttpRequest.getLocalAddress()
ServerHttpRequest.getRemoteAddress()

二、SpringCloudGateway作为客户端

默认情况下,向外发送HTTP请求会生成Forwarded和X-Forwarded-*的HTTP请求头

生成Forwarded请求头的类如下:

org.springframework.cloud.gateway.filter.headers.ForwardedHeadersFilter

生成X-Forwarded-*请求头的类如下:

org.springframework.cloud.gateway.filter.headers.XForwardedHeadersFilter

若不想生成这些HTTP请求头,可分别配置如下参数进行关闭:

spring.cloud.gateway.forwarded.enabled=false
spring.cloud.gateway.x-forwarded.enabled=false

版权声明:本文为netyeaxi原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。