跳到主要内容
版本:5.0.1

AddRequestHeadersIfNotPresent 过滤器

DeepSeek V3 中英对照 AddRequestHeadersIfNotPresent Filter AddRequestHeadersIfNotPresent Filter

AddRequestHeadersIfNotPresent 过滤器接收一组以冒号分隔的 name 和 value 键值对。以下示例配置了一个 AddRequestHeadersIfNotPresent 过滤器:

spring:
cloud:
gateway:
server:
webmvc:
routes:
- id: add_request_headers_route_inp
uri: https://example.org
predicates:
- Path=/red
filters:
- AddRequestHeadersIfNotPresent=X-Request-Color-1:blue,X-Request-Color-2:green
import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.addRequestHeadersIfNotPresent;
import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;

@Configuration
class RouteConfiguration {

@Bean
public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqHeaderInp() {
return route("add_request_headers_route_inp")
.GET("/red", http())
.before(uri("https://example.org"))
.before(addRequestHeadersIfNotPresent("X-Request-Color-1:blue","X-Request-Color-2:green"));
}
}

此配置为所有匹配的请求在下游请求头中添加两个标头 X-Request-Color-1:blue 和 X-Request-Color-2:green。这与 AddRequestHeader 的工作方式类似,但不同于 AddRequestHeader 的是,它仅在标头不存在时才会添加。否则,将发送客户端请求中的原始值。

此外,要设置多值标头,请多次使用标头名称,例如 addRequestHeadersIfNotPresent("X-Request-Color-1:blue","X-Request-Color-1:green")。

AddRequestHeadersIfNotPresent 也支持用于匹配路径或主机的 URI 变量。URI 变量可以在值中使用,并在运行时展开。以下示例配置了一个使用变量的 AddRequestHeadersIfNotPresent 过滤器:

import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.addRequestHeadersIfNotPresent;
import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;

@Configuration
class RouteConfiguration {

@Bean
public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqHeaderInp() {
return route("add_request_header_route_inp")
.GET("/red/{segment}", http())
.before(uri("https://example.org"))
.before(addRequestHeadersIfNotPresent("X-Request-red", "blue-{segment}"));
}
}
spring:
cloud:
gateway:
routes:
- id: add_request_header_route_inp
uri: https://example.org
predicates:
- Path=/red/{segment}
filters:
- AddRequestHeadersIfNotPresent=X-Request-Red:Blue-{segment}