最新の安定バージョンについては、Spring Cloud Gateway 4.3.2 を使用してください!

SetRequestHeader フィルター

SetRequestHeader フィルターは name および value パラメーターを受け取ります。次のリストは、SetRequestHeader フィルターを構成します。

application.yml
spring:
  cloud:
    gateway:
      mvc:
        routes:
        - id: setrequestheader_route
          uri: https://example.org
          predicates:
          - Path=/**
          filters:
          - SetRequestHeader=X-Request-Red, Blue
GatewaySampleApplication.java
import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.setRequestHostHeader;
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> gatewayRouterFunctionsSetRequestHeader() {
        return route("setrequestheader_route")
            .GET("/**", http())
            .before(uri("https://example.org"))
            .before(setRequestHostHeader("X-Request-Red", "Blue"))
            .build();
    }
}

このフィルターは、すべてのヘッダーを指定された名前で (追加ではなく) 置き換えます。ダウンストリームサーバーが X-Request-Red:1234 で応答した場合、ダウンストリームサービスが受け取ることになる X-Request-Red:Blue に置き換えられます。

SetRequestHeader は、パスまたはホストの照合に使用される URI 変数を認識します。URI 変数は値に使用でき、実行時に展開されます。次の例では、変数を使用する SetRequestHeader フィルターを構成します。

application.yml
spring:
  cloud:
    gateway:
      routes:
      - id: setrequestheader_route
        uri: https://example.org
        predicates:
        - Host: {segment}.myhost.org
        filters:
        - SetRequestHeader=X-Request-Red, Blue-{segment}
GatewaySampleApplication.java
import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.setRequestHostHeader;
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;
import static org.springframework.cloud.gateway.server.mvc.predicate.GatewayRequestPredicates.host;

@Configuration
class RouteConfiguration {

    @Bean
    public RouterFunction<ServerResponse> gatewayRouterFunctionsSetRequestHeader() {
        return route("setrequestheader_route")
            .route(host("{segment}.myhost.org"), http())
            .before(uri("https://example.org"))
            .before(setRequestHostHeader("X-Request-Red", "Blue-{segment}"))
            .build();
    }
}