Spring Cloud Gateway路由中移除X-Forwarded-Prefix Header失败求助

问题说明 #

尝试通过多种配置移除Spring Cloud Gateway某条路由的X-Forwarded-Prefix请求头均无效，调试发现该请求头在org.springframework.cloud.gateway.filter.headers.observation.ObservedRequestHttpHeadersFilter#filter方法中仍存在。已尝试的配置包括：

spring.cloud.gateway.routes[0].filters[0]=RemoveRequestHeader=X-Forwarded-Prefix
spring.cloud.gateway.routes[0].filters[0]=RequestHeader=X-Forwarded-Prefix,
spring.cloud.gateway.x-forwarded-prefix.enabled=false
spring.cloud.gateway.routes[19].filters[0]=AddRequestHeader=X-Forwarded-Prefix,

原因分析 #

ObservedRequestHttpHeadersFilter是Spring Cloud Gateway观测（Observation）模块的过滤器，它会在请求处理链的后期重新添加或保留X-Forwarded-Prefix请求头，而常规的RemoveRequestHeader过滤器执行顺序早于它，因此移除操作会被覆盖。

解决方案 #

方案1：关闭观测功能（简单直接） #

如果不需要Gateway的观测监控能力，可以直接关闭该功能，这样ObservedRequestHttpHeadersFilter会被禁用，原有的RemoveRequestHeader配置即可生效：

spring.cloud.gateway.observation.enabled=false

方案2：自定义过滤器晚于观测过滤器执行 #

如果需要保留观测功能，可自定义一个GatewayFilter，设置其执行顺序晚于ObservedRequestHttpHeadersFilter，确保移除操作在观测过滤器之后执行：

1. 编写自定义过滤器类：

import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.core.Ordered;
import org.springframework.http.HttpHeaders;
import org.springframework.stereotype.Component;

@Component
public class LateRemoveRequestHeaderGatewayFilterFactory extends AbstractGatewayFilterFactory<LateRemoveRequestHeaderGatewayFilterFactory.Config> {

    public LateRemoveRequestHeaderGatewayFilterFactory() {
        super(Config.class);
    }

    @Override
    public GatewayFilter apply(Config config) {
        return (exchange, chain) -> {
            exchange.getRequest().mutate().headers(httpHeaders -> {
                httpHeaders.remove(config.getHeaderName());
            }).build();
            return chain.filter(exchange);
        };
    }

    @Override
    public int getOrder() {
        // 设置为比观测过滤器更低的优先级（更大的数值），确保最后执行
        return Ordered.LOWEST_PRECEDENCE - 1;
    }

    public static class Config {
        private String headerName;

        public String getHeaderName() {
            return headerName;
        }

        public void setHeaderName(String headerName) {
            this.headerName = headerName;
        }
    }
}

2. 在路由配置中使用该自定义过滤器：

spring.cloud.gateway.routes[0].filters[0]=LateRemoveRequestHeader=X-Forwarded-Prefix

方案3：修改观测过滤器的行为（不推荐） #

不建议直接修改框架类，但如果必须，可以通过自定义ObservedRequestHttpHeadersFilter的Bean，覆盖默认实现，移除对X-Forwarded-Prefix的处理逻辑。不过这种方式会依赖框架内部实现，升级版本时可能出现兼容问题。

内容的提问来源于stack exchange，提问作者spyder