Spring Cloud Gateway Response Header 변경

Gateway 서버는 Proxied 도메인으로 부터 온 응답의 일부분을 임의로 수정하곤 한다.

ex) HSTS Header 처럼 보안과 관련된 헤더를 모든 요청에 일괄적으로 넣어줄때

 

 

 

위와 같은 역할을 수행하기 위하여 GlobalFilter 에 Response Header 를 수정하려고 시도하면 아래와 같은 예외가 발생한다.

	@Override
	public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

		return chain.filter(exchange).then(Mono.fromRunnable(() -> {
			exchange.getResponse().getHeaders().set("TEST_HEADER", "TEST_HEADER_VALUE");
		}));

	}

ERROR 2021-08-30 13:22:24 [reactor-http-nio-5] r.n.http.server.HttpServerOperations - [id: 0x20415b5d, L:/127.0.0.1:8090 - R:/127.0.0.1:61580] Error finishing response. Closing connection
java.lang.UnsupportedOperationException: null
	at org.springframework.http.ReadOnlyHttpHeaders.set(ReadOnlyHttpHeaders.java:106)
	Suppressed: reactor.core.publisher.FluxOnAssembly$OnAssemblyException: 
Error has been observed at the following site(s):
	|_ checkpoint ⇢ org.springframework.cloud.gateway.filter.WeightCalculatorWebFilter [DefaultWebFilterChain]
	|_ checkpoint ⇢ org.springframework.boot.actuate.metrics.web.reactive.server.MetricsWebFilter [DefaultWebFilterChain]
Stack trace:
		at org.springframework.http.ReadOnlyHttpHeaders.set(ReadOnlyHttpHeaders.java:106)

 

예외가 발생하는 이유는 ServerWebExchage.getResponse().getHeaders() 의 리턴 타입이 ReadOnlyHttpHeaders.java 이기 때문이다.

    public void set(String headerName, @Nullable String headerValue) {
        throw new UnsupportedOperationException();
    }
    
    public void add(String headerName, @Nullable String headerValue) {
        throw new UnsupportedOperationException();
    }

해당 클래스에서 set(), add() 를 시도하면 UnsupportedOperationException 이 던져진다.

이는 이미 Netty 에서 Commit 되어버린 Response 를 수정하려고 시도하였기 때문에 예외를 발생시킨 것이다.

 

따라서 아래와 같이 Commit 하기 전에 수행되도록 수정하면 Response 의 Header 를 수정할 수 있다.

	@Override
	public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

		ServerHttpResponse response = exchange.getResponse();
		response.beforeCommit(() -> {
			response.getHeaders().remove(HSTS_HEADER_NAME);
			response.getHeaders().set(HSTS_HEADER_NAME, HSTS_HEADER_VALUE);
			return Mono.empty();
		});

		return chain.filter(exchange);

	}