Использование WebClient для распространения заголовков запросов, полученных в приложениях Spring Webflux, на нисходящие сервисы

Question

У меня есть два вида приложений Webflux: на основе аннотаций и маршрутов. Эти приложения вызываются с набором заголовков, некоторые из которых мне нужно распространять в нисходящих вызовах, используя WebClient,

Если бы это были обычные приложения Spring WebMvc, я бы использовал фильтр, чтобы сохранить выбранные заголовки в ThreadLocal, доступ к нему в RestTemplate перехватчик, чтобы отправить их в последующие службы и очистить ThreadLocal,

Как правильно воспроизвести это поведение в приложениях WebFlux?

Answer 1

Я решил это с помощью контекста Project Reactor для хранения заголовков в WebFilter. Затем они попадают в функцию ExchangeFilterFunction веб-клиента. Вот и все решение:

WebFilter

class OpenTracingFilter(private val openTracingHeaders: Set<String>) : WebFilter {

    private val logger = LoggerFactory.getLogger(javaClass)

    override fun filter(exchange: ServerWebExchange, chain: WebFilterChain): Mono<Void> {

        return chain.filter(exchange)
                .subscriberContext { ctx ->
                    var updatedContext = ctx
                    exchange.request.headers.forEach {
                        if (openTracingHeaders.contains(it.key.toLowerCase())) {
                            logger.debug("Found OpenTracing Header - key {} - value {}", it.key, it.value[0])
                            updatedContext = updatedContext.put(it.key, it.value[0])
                        }
                    }
                    updatedContext
                }
    }
}

OpenTracingExchangeFilterFunction

class OpenTracingExchangeFilterFunction(private val headers: Set<String>) : ExchangeFilterFunction {

    private val logger = LoggerFactory.getLogger(javaClass)

    override fun filter(request: ClientRequest, next: ExchangeFunction): Mono<ClientResponse> {

        logger.debug("OpenTracingExchangeFilterFunction - filter()")
        return OpenTracingClientResponseMono(request, next, headers)
    }
}

OpenTracingClientResponseMono

class OpenTracingClientResponseMono(private val request: ClientRequest,
                                    private val next: ExchangeFunction,
                                    private val headersToPropagate: Set<String>) : Mono<ClientResponse>() {

    private val logger = LoggerFactory.getLogger(javaClass)

    override fun subscribe(subscriber: CoreSubscriber<in ClientResponse>) {
        val context = subscriber.currentContext()

        val requestBuilder = ClientRequest.from(request)
        requestBuilder.headers { httpHeaders ->
            headersToPropagate.forEach {
                if(context.hasKey(it)) {
                    logger.debug("Propagating header key {} - value{}", it, context.get<String>(it))
                    httpHeaders[it] = context.get<String>(it)
                }
            }
        }
        val mutatedRequest = requestBuilder.build()
        next.exchange(mutatedRequest).subscribe(subscriber)
    }


}

OpenTracingConfiguration

@Configuration
class OpenTracingConfiguration(private val openTracingConfigurationProperties: OpenTracingConfigurationProperties) {

    @Bean
    fun webClient(): WebClient {
        return WebClient.builder().filter(openTracingExchangeFilterFunction()).build()
    }

    @Bean
    fun openTracingFilter(): WebFilter {
        return OpenTracingFilter(openTracingConfigurationProperties.headers)
    }

    @Bean
    fun openTracingExchangeFilterFunction(): OpenTracingExchangeFilterFunction {
        return OpenTracingExchangeFilterFunction(openTracingConfigurationProperties.headers)
    }
}

OpenTracingConfigurationProperties

@Configuration
@ConfigurationProperties("opentracing")
class OpenTracingConfigurationProperties {

    lateinit var headers: Set<String>

}

application.yml

opentracing:
  headers:
    - x-request-id
    - x-b3-traceid
    - x-b3-spanid
    - x-b3-parentspanid
    - x-b3-sampled
    - x-b3-flags
    - x-ot-span-context

Answer 2

Мне нужно было передать заголовок x-request-id нижестоящей службе в моем приложении. Достигнуто это добавлением WebFilterкоторый записывает x-request-id в контекст реактора

      class ContextWebFilter : WebFilter {
    override fun filter(exchange: ServerWebExchange, chain: WebFilterChain): Mono<Void> {
        val headers = exchange.request.headers

        val xRequestId = headers[X_REQUEST_ID]?.firstOrNull() ?: ""
        val requestId = xRequestId.ifBlank { UUID.randomUUID().toString() }       

        return chain
            .filter(exchange)
            .contextWrite { it.put(X_REQUEST_ID, requestId) }
    }

    companion object {
        const val X_REQUEST_ID = "X-REQUEST-ID"
    }
}

и обновление WebClientс ExchangeFilterFunctionкоторый обновляет исходящий запрос

      WebClient.builder()
        .filter(
            ExchangeFilterFunction.ofRequestProcessor { request ->
                Mono.deferContextual { context ->
                    val xRId = context.getOrDefault<String>("X-REQUEST-ID", "")
                    logger.debug("Set X-REQUEST-ID={} as a header to outgoing call", xRId)
                    Mono.just(
                        ClientRequest.from(request)
                            .header("X-REQUEST-ID", xRId)
                            .build()
                    )
                }
            }
        )
        .baseUrl("http://localhost:8080")
        .build()