它是要删除的标头的名称

发布时间：2025-06-24 17:53:04  作者：北方职教升学中心  阅读量：302

它是要删除的标头的名称。spring:cloud:gateway:routes:-id:removeresponseheader_route uri:https://example.org filters:-RemoveResponseHeader=X-Response-Foo

删除响应头网关过滤器工厂

RemoveResponseHeader GatewayFilter Factory 采用一个name参数。spring:cloud:gateway:routes:-id:rewriteresponseheader_route uri:https://example.org filters:-RewriteResponseHeader=X-Response-Foo,,password=[^&]+,password=***

保存会话网关过滤器工厂

SaveSession GatewayFilter Factory在将调用转发到下游之前WebSession::save强制执行操作。Hystrix GatewayFilter 允许您在网关路由中引入断路器，保护您的服务免受级联故障的影响，并允许您在出现下游故障时提供回退响应。
要在项目中启用 Hystrix GatewayFilters，请添加spring-cloud-starter-netflix-hystrix来自Spring Cloud Netflix 的依赖项。

例子：这会将X-Request-Foo:Bar标头添加到所有匹配请求的下游请求标头中。
由于 Spring Cloud Gateway 区分过滤器逻辑执行的“前”和“后”阶段（请参阅：它是如何工作的），具有最高优先级的过滤器将是“前”阶段中的第一个和“后”阶段中的最后一个。hostValue和protocolsRegex参数。

将交换标记为已路由

网关路由后，ServerWebExchange它将通过添加gatewayAlreadyRouted 交换属性来将该交换标记为“已路由”。

AddRequestHeader网关过滤器工厂

AddRequestHeader GatewayFilter Factory 采用名称和值参数。

例子：对于标头值，它将在发出下游请求后/42?user=ford&password=omg!what&flag=true设置为。此过滤器添加一个名为“gateway.requests”的计时器指标，并带有以下标签：
routeId: 路线编号
routeUri：API 将路由到的 URI
outcome：按HttpStatus.Series分类的结果
status：请求返回给客户端的Http Status
httpStatusCode：请求返回给客户端的Http Status
httpMethod: 请求使用的Http方法
然后可以从中获取这些指标/actuator/metrics/gateway.requests，并可以轻松地与 Prometheus 集成以创建Grafana 仪表板。spring:cloud:gateway:routes:-id:hystrix_route        uri:lb://backing-service:8088predicates:-Path=/consumingserviceendpoint        filters:-name:Hystrix          args:name:fallbackcmd            fallbackUri:forward:/incaseoffailureusethis        -RewritePath=/consumingserviceendpoint,/backingserviceendpoint/incaseoffailureusethis当 Hystrix 回退被调用时，这将转发到URI。
例子：这会将X-Request-Foo:Bar标头添加到所有匹配请求的下游请求标头中。
ServerWebExchangeUtils.isAlreadyRouted获取一个ServerWebExchange对象并检查它是否已被“路由”
ServerWebExchangeUtils.setAlreadyRouted获取一个ServerWebExchange对象并将其标记为“已路由”
自定义局部Filter
Spring Cloud Gateway 提供了一种强大的机制，允许开发者自定义过滤器以满足特定的路由和请求处理需求。spring:cloud:gateway:routes:-id:map_request_header_route        uri:https://example.org        filters:-MapRequestHeader=Bar,X-Request-Foo
PrefixPath 网关过滤器工厂
PrefixPath GatewayFilter Factory 采用单个prefix参数。主要场景是使用fallbackUri网关应用程序内的内部控制器或处理程序。Hystrix 过滤器还可以接受可选fallbackUri参数。Hystrix 设置（例如超时）可以使用全局默认值进行配置，也可以使用应用程序属性按路由进行配置，如Hystrix wiki中所述。RETAIN_LAST和RETAIN_UNIQUE。如果 url 有一个lb方案（即lb://myservice），它将使用 Spring CloudLoadBalancerClient将名称（myservice在前面的示例中）解析为实际的主机和端口，并替换相同属性中的 URI。这使用 Java 正则表达式来灵活地重写请求路径。参数protocolsRegex必须是有效的正则表达式String，协议名称将与其匹配。状态应该是 300 系列重定向 http 代码，例如 301。要为上面的示例路由设置 5 秒超时，将使用以下配置：应用程序.yml。这将是标头的值Location。spring:cloud:gateway:routes:-id:add_response_header_route        uri:https://example.org        predicates:-Host:{segment}.myhost.org        filters:-AddResponseHeader=foo,bar-{segment}

DedupeResponseHeader 网关过滤器工厂

DedupeResponseHeader GatewayFilter Factory 采用一个name参数和一个可选strategy参数。spring:cloud:gateway:routes:-id:prefixpath_route uri:https://example.org filters:-RedirectTo=302,https://acme.org

RemoveHopByHopHeadersFilter网关过滤器工厂

RemoveHopByHopHeadersFilter GatewayFilter Factory 从转发的请求中删除标头。lb请注意，此示例还通过目标 URI 上的前缀演示（可选）Spring Cloud Netflix Ribbon 负载平衡。它使用 Java 正则表达式以灵活的方式重写响应标头值。

例子：X-Request-Foo这将在向下游发送之前删除标头。AddRequestHeader 知道用于匹配路径或主机的 URI 变量。Host如果未提供，则将使用请求标头的值。

例子：例如，对于请求，响应标头值将被重写为。响应被放入ServerWebExchangeUtils.CLIENT_RESPONSE_ATTR交换属性中以供稍后的过滤器使用。#{@myKeyResolver}是引用名为 的 bean 的 SpEL 表达式myKeyResolver。
该过滤器采用可选keyResolver参数和特定于速率限制器的参数（见下文）。
@BeanpublicGlobalFiltercustomFilter(){returnCustomGlobalFilter();}publicclassCustomGlobalFilterimplementsGlobalFilter,Ordered{@OverridepublicMono<Void>filter(ServerWebExchangeexchange,GatewayFilterChainchain){log.info("custom global filter");returnchain.filter(exchange);}@OverridepublicintgetOrder(){return-1;}}
前向路由过滤器
在交换属性中查找ForwardRoutingFilterURI ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR。它被添加到ServerWebExchange作为 ServerWebExchangeUtils.HYSTRIX_EXECUTION_EXCEPTION_ATTR在网关应用程序中处理回退时可以使用的属性。
Websocket路由过滤器
ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR如果交换属性中的 url具有ws或wss方案，则 Websocket 路由过滤器将运行。Access-Control-Allow-OriginDedupeResponseHeader 过滤器还接受可选strategy参数。当使用带有惰性数据存储的Spring Session之类的东西时，这特别有用，并且需要确保在进行转发调用之前已保存会话状态。spring:cloud:gateway:routes:-id:removerequestheader_route        uri:https://example.org        filters:-RemoveRequestHeader=X-Request-Foo

删除请求头网关过滤器工厂

RemoveRequestHeader GatewayFilter Factory 采用一个name参数。spring:cloud:gateway:routes:-id:add_response_header_route uri:https://example.org filters:-AddResponseHeader=X-Response-Foo,BarAddResponseHeader 知道用于匹配路径或主机的 URI 变量。删除的默认标头列表来自IETF。未修改的原始 url 将附加到属性中的列表中ServerWebExchangeUtils.GATEWAY_ORIGINAL_REQUEST_URL_ATTR。它使用 NettyHttpClient发出下游代理请求。通过设置下面列出的参数值及其默认值，可以在配置中覆盖标头的名称：executionExceptionTypeHeaderName( "Execution-Exception-Type")executionExceptionMessageHeaderName( "Execution-Exception-Message")rootCauseExceptionTypeHeaderName( "Root-Cause-Exception-Type")rootCauseExceptionMessageHeaderName( "Root-Cause-Exception-Message")

MapRequestHeader网关过滤器工厂

MapRequestHeader GatewayFilter Factory 采用“fromHeader”和“toHeader”参数。如果 url 有一个lb方案（即lb://myservice），它将使用 Spring CloudReactorLoadBalancer将名称（myservice在前面的示例中）解析为实际的主机和端口，并替换相同属性中的 URI。

spring:cloud:gateway:routes:-id:myRoute        uri:lb://service        predicates:-Path=/service/**

Netty路由过滤器

如果交换属性中的 urlServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR具有httporhttps方案，则 Netty 路由过滤器将运行。URI 变量可以在值中使用，并将在运行时扩展。regexp和replacement参数。spring:cloud:gateway:routes:-id:add_request_header_route uri:https://example.org predicates:-Path=/foo/{segment}filters:-AddRequestHeader=X-Request-Foo,Bar-{segment}

添加请求参数网关过滤器工厂

AddRequestHeader GatewayFilter Factory 采用名称和值参数。（有一个实验WebClientHttpRoutingFilter可以实现同样的功能，但是不需要netty）

Netty写响应过滤器

如果交换属性中NettyWriteResponseFilter有 Netty，则运行。您可以使用一些方便的方法将交换标记为已路由或检查交换是否已被路由。

例子：这会将X-Request-Foo:<values>标头添加到下游请求，其中包含来自传入 http 请求Bar标头的更新值。它是要删除的标头的名称。AddRequestHeader 知道用于匹配路径或主机的 URI 变量。您可以在FallbackHeaders GatewayFilter Factory 部分找到更多信息。spring:cloud:gateway:routes:-id:requestratelimiter_route        uri:https://example.org        filters:-name:RequestRateLimiter          args:redis-rate-limiter.replenishRate:10redis-rate-limiter.burstCapacity:20

重定向到网关过滤器工厂

RedirectTo GatewayFilter Factory 采用status和url参数。AS_IN_REQUEST（默认）、但是，也可以将请求重新路由到外部应用程序中的控制器或处理程序，如下所示：spring:cloud:gateway:routes:-id:ingredients uri:lb://ingredients predicates:-Path=//ingredients/**filters:-name:Hystrix args:name:fetchIngredients fallbackUri:forward:/fallback -id:ingredients-fallback uri:http://localhost:9994predicates:-Path=/fallback在此示例中，网关应用程序中没有fallback端点或处理程序，但是，另一个应用程序中有一个端点或处理程序，在http://localhost:9994.如果请求被转发到回退，Hystrix Gateway 过滤器还会提供Throwable导致该请求的原因。

例子：工厂FallbackHeaders允许您在转发到外部应用程序的请求的标头中添加 Hystrix 执行异常详细信息fallbackUrispring:cloud:gateway:routes:-id:ingredients        uri:lb://ingredients        predicates:-Path=//ingredients/**filters:-name:Hystrix          args:name:fetchIngredients            fallbackUri:forward:/fallback      -id:ingredients-fallback        uri:http://localhost:9994predicates:-Path=/fallback        filters:-name:FallbackHeaders          args:executionExceptionTypeHeaderName:Test-Header在此示例中，在运行 时发生执行异常后HystrixCommand，请求将被转发到fallback在 上运行的应用程序中的端点或处理程序localhost:9994。URI 变量可以在值中使用，并将在运行时扩展。spring:cloud:gateway:routes:-id:rewriteresponseheader_route        uri:https://example.org        filters:-RewriteResponseHeader=X-Response-Foo,,password=[^&]+,password=***

RewriteLocationResponseHeader 网关过滤器工厂

RewriteLocationResponseHeader GatewayFilter Factory 修改响应标头的值Location，通常是为了删除后端特定的详细信息。URI 变量可以在值中使用，并将在运行时扩展。AddRequestHeader 知道用于匹配路径或主机的 URI 变量。它创建一个新的命名标头 (toHeader)，并从传入的 http 请求中的现有命名标头 (fromHeader) 中提取该值。消息以及（如果可用）根本原因异常类型和消息的标头将由过滤器添加到该请求中FallbackHeaders。接受的值为RETAIN_FIRST（默认）、URI 变量可以在值中使用，并将在运行时扩展。此外，您可以在使用后配置此过滤器spring.cloud.gateway.default-filters 并将其应用于所有路由。
路由过滤器的范围仅限于特定路由。过滤器还将查看ServerWebExchangeUtils.GATEWAY_SCHEME_PREFIX_ATTR属性以查看它是否相等 lb，然后应用相同的规则。它在所有其他过滤器完成后运行，并将代理响应写回网关客户端响应。未修改的原始 url 将附加到属性中的列表中ServerWebExchangeUtils.GATEWAY_ORIGINAL_REQUEST_URL_ATTR。

SpringCloudGateway-核心之Filter-自定义全局Filter-自定义局部Filter介绍

核心之Filter

路由过滤器允许以某种方式修改传入的 HTTP 请求或传出的 HTTP 响应。

importorg.reactivestreams.Publisher;importorg.springframework.cloud.gateway.filter.GatewayFilter;importorg.springframework.cloud.gateway.filter.GatewayFilterChain;importorg.springframework.core.Ordered;importorg.springframework.web.server.ServerWebExchange;publicclassCustomGatewayFilterimplementsGatewayFilter,Ordered{privateintorder;// 用于指定过滤器执行顺序// 构造函数中可以设置order值publicCustomGatewayFilter(intorder){this.order =order;}@OverridepublicMono<Void>filter(ServerWebExchangeexchange,GatewayFilterChainchain){// 在这里添加你的前置逻辑，比如修改请求头、该过滤器设置一个请求属性，路由过滤器将检查该属性以确定是否应发送原始主机标头，而不是由 http 客户端确定的主机标头。

Hystrix GatewayFilter Factory 需要一个name参数，即HystrixCommand.spring:cloud:gateway:routes:-id:hystrix_route        uri:https://example.org        filters:-Hystrix=myCommandName这将剩余的过滤器包装在HystrixCommandwith command name中myCommandName。参数等// ...returnchain.filter(exchange).then(Mono.fromRunnable(()->{// 在这里添加你的后置逻辑，如响应后处理}));}@OverridepublicintgetOrder(){returnthis.order;}}

注册并应用到路由上 在Spring Boot应用中通过配置或者编程方式将自定义的局部过滤器应用到指定的路由上。

LoadBalancer客户端过滤器

在交换属性中查找LoadBalancerClientFilterURI ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR。请求 URL 的路径部分将被转发 URL 中的路径覆盖。

例子：这将添加foo=bar到所有匹配请求的下游请求的查询字符串中。带有异常类型、
Spring Cloud Gateway 包含许多内置的 GatewayFilter Factory。这个组合的过滤器链是通过org.springframework.core.Ordered接口排序的，可以通过实现getOrder()方法来设置。

例子：这将/mypath作为所有匹配请求的路径的前缀。
配置方式： 在application.yml或application.properties中进行配置

spring:cloud:gateway:routes:-id:my_route           uri:http://localhost:8081predicates:-Path=/my-service/**filters:-name:CustomGatewayFilter # 过滤器名称，可以根据Bean名称自动注入args:order:1# 如果过滤器实现了Ordered接口，可传递order值

通过实现RouteLocator接口或者使用RouteLocatorBuilder来自定义路由时加入过滤器

importorg.springframework.cloud.gateway.route.RouteLocator;importorg.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;@ConfigurationpublicclassGatewayConfig{@BeanpublicRouteLocatorcustomRouteLocator(RouteLocatorBuilderbuilder){returnbuilder.routes().route("custom_route",r ->r.path("/my-service/**").filters(f ->f.filter(newCustomGatewayFilter(1))).uri("http://localhost:8081")).build();}}

这样，当请求匹配到/my-service/**这个路径模式的路由时，将会触发我们自定义的CustomGatewayFilter进行处理。locationHeaderName、如果新的命名标头已经存在，那么它的值将使用新值进行扩充。如果不是，HTTP 429 - Too Many Requests则返回状态（默认情况下）。/42?user=ford&password=***&flag=true请使用$\表示$因为YAML 规范。AddRequestHeader 知道用于匹配路径或主机的 URI 变量。它需要stripVersionMode、新的 URI 被放置在交换属性中。然后，默认情况下，只要该属性spring.cloud.gateway.metrics.enabled未设置为 ，网关指标筛选器就会运行false。

例子：当网关 CORS 逻辑和下游都添加重复值Access-Control-Allow-Credentials和响应标头时，这将删除它们。因此，请求/hello,将被发送至/mypath/hello。目前，仅forward:支持方案 URI。局部过滤器（GatewayFilter）是作用在特定路由上的过滤器，可以通过配置文件或代码方式实现绑定。
spring:cloud:gateway:routes:# SockJS route-id:websocket_sockjs_route        uri:http://localhost:3001predicates:-Path=/websocket/info/**# Normwal Websocket route-id:websocket_route        uri:ws://localhost:3001predicates:-Path=/websocket/**
网关指标过滤器
要启用 Gateway Metrics，请添加 spring-boot-starter-actuator 作为项目依赖项。这些是有条件地应用于所有路由的特殊过滤器。POST https://api.example.com/some/object/nameLocationhttps://object-service.prod.example.net/v2/some/object/idhttps://api.example.com/some/object/id参数stripVersionMode有以下可能值：NEVER_STRIP、spring:cloud:gateway:routes:-id:add_request_parameter_route        uri:https://example.org        predicates:-Host:{segment}.myhost.org        filters:-AddRequestParameter=foo,bar-{segment}

添加响应头网关过滤器工厂

AddResponseHeader GatewayFilter Factory 采用名称和值参数。如果不匹配，过滤器将不执行任何操作。spring:cloud:gateway:routes:-id:save_session uri:https://example.org predicates:-Path=/foo/**filters:-SaveSession

自定义全局Filter

该GlobalFilter接口具有与 相同的签名GatewayFilter。

例子：这会将X-Request-Foo:Bar标头添加到所有匹配请求的下游请求标头中。要删除任何类型的敏感标头，您应该为您可能想要执行此操作的任何路由配置此过滤器。ALWAYS_STRIP。RouteServerWebExchangeUtils.GATEWAY_ROUTE_ATTRRouteServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR
如果 URI 具有方案前缀，例如lb:ws://serviceid，则该lb方案将从 URI 中剥离并放置在 中，ServerWebExchangeUtils.GATEWAY_SCHEME_PREFIX_ATTR以便稍后在过滤器链中使用。一旦请求被标记为已路由，其他路由过滤器将不会再次路由该请求，实质上会跳过该过滤器。

例子：如果您正在将Spring Security与 Spring Session 集成，并且希望确保安全详细信息已转发到远程进程，那么这一点至关重要。它使用 Spring Web Socket 基础设施向下游转发 Websocket 请求。 “-阶段。
例子：这会将X-Request-Foo:Bar标头添加到所有匹配请求的下游请求标头中。过滤器还将查看ServerWebExchangeUtils.GATEWAY_SCHEME_PREFIX_ATTR属性以查看它是否相等lb，然后应用相同的规则。如果输入标头不存在，则过滤器没有影响。
例子：这会将X-Response-Foo:Bar标头添加到所有匹配请求的下游响应标头中。
例子：这会将X-Request-Foo:Bar标头添加到所有匹配请求的下游请求标头中。对于外部控制器/处理程序场景，可以添加包含异常详细信息的标头。它基于请求 URI 创建一个新的 URI，但使用对象的 URI 属性进行更新。在配置中，使用 SpEL 按名称引用 bean。spring:cloud:gateway:routes:-id:add_request_header_route        uri:https://example.org        filters:-AddRequestHeader=X-Request-Foo,BarAddRequestHeader 知道用于匹配路径或主机的 URI 变量。如果调用后备，请求将转发到与 URI 匹配的控制器。（有一个实验可以实现同样的功能，但是不需要netty）HttpClientResponseServerWebExchangeUtils.CLIENT_RESPONSE_ATTRWebClientWriteResponseFilter
RouteToRequestUrl过滤器
如果交换属性中RouteToRequestUrlFilter有对象，则运行。默认为http|https|ftp|ftps.spring:cloud:gateway:routes:-id:rewriteresponseheader_route        uri:https://example.org        filters:-RewriteResponseHeader=X-Response-Foo,,password=[^&]+,password=***
RewriteResponseHeader 网关过滤器工厂
RewriteResponseHeader GatewayFilter Factory 采用name、
keyResolver是一个实现该接口的bean KeyResolver。URI 变量可以在值中使用，并将在运行时扩展。spring:cloud:gateway:routes:-id:add_request_parameter_route        uri:https://example.org        filters:-AddRequestParameter=foo,barAddRequestParameter 知道用于匹配路径或主机的 URI 变量。 url 应该是有效的 url。URI 变量可以在值中使用，并将在运行时扩展。
默认删除的标头是：
联系
活着
代理认证
代理授权
TE
预告片
传输编码
升级
要更改此设置，请将该spring.cloud.gateway.filter.remove-non-proxy-headers.headers属性设置为要删除的标头名称列表。
例子：X-Response-Foo这将在响应返回到网关客户端之前从响应中删除标头。spring:cloud:gateway:routes:-id:prefixpath_route        uri:https://example.org        filters:-PrefixPath=/mypath
PreserveHostHeader 网关过滤器工厂
PreserveHostHeader GatewayFilter Factory 没有参数。NEVER_STRIP-版本不会被剥离，即使原始请求路径不包含版本AS_IN_REQUEST-仅当原始请求路径不包含版本时才会删除版本ALWAYS_STRIP-版本将被剥离，即使原始请求路径包含版本参数hostValue（如果提供）将用于替换host:port响应Location标头的部分。
例子：这会将X-Request-Foo:Bar标头添加到所有匹配请求的下游请求标头中。如果url有forwardscheme（即forward:///localendpoint），它将使用SpringDispatcherHandler来处理请求。