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

`AddRequestHeadersIfNotPresent` フィルター

AddRequestHeadersIfNotPresent フィルターは、コロンで区切られた name と value のペアのコレクションを受け取ります。次の例では、AddRequestHeadersIfNotPresent フィルターを構成します。

application.yml

spring:
  cloud:
    gateway:
      mvc:
        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

GatewaySampleApplication.java

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 の 2 つのヘッダーを追加します。これは AddRequestHeader の動作と似ていますが、AddRequestHeader とは異なり、ヘッダーがまだ存在しない場合にのみ実行されます。それ以外の場合は、クライアントリクエストの元の値が送信されます。

さらに、多値ヘッダーを設定するには、addRequestHeadersIfNotPresent("X-Request-Color-1:blue","X-Request-Color-1:green") のようにヘッダー名を複数回使用します。

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

GatewaySampleApplication.java

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}"));
    }
}

application.yml

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}

AddRequestHeadersIfNotPresent フィルター

`AddRequestHeadersIfNotPresent` フィルター