在 Spring Reactor 中获取上下文的引用

Question

我正在使用Spring项目reactorreactor-core 3.1.8.RELEASE。我正在为我的微服务实现一个具有 JSON 审核日志的日志记录框架，因此使用上下文来存储某些字段，例如用户 ID、协作 ID、组件名称以及请求生命周期中常见的其他一些字段。由于

Threadlocal

无法在反应式服务中用于存储这些元素，因此我必须使用上下文。但获得上下文的参考显然是非常困难的。我可以通过

doOnEach

函数调用从 Signal 获取上下文的引用，仅此而已。如果我使用

doOnEach

，它会被所有信号类型调用，并且我无法隔离错误、成功等。此外，如果中间发生错误，则所有后续

doOnEach

无论如何都会被调用，因此日志会以多种

onError

日志类型重复。

关于如何在 Spring Reactor 中获取上下文对象的引用的文档非常有限。任何有关生成审计日志的更好方法的帮助，该日志具有跨函数调用和外部调用存储和传播的协作 ID 和其他请求特定 ID。

代码片段 - 在 WebFilter 中，我设置了几个键值对，如下 -

override fun filter(exchange: ServerWebExchange, filterChain: WebFilterChain): Mono<Void> {
        // add the context variables at the end of the chain as the context moves from
        // downstream to upstream.
        return filterChain.filter(exchange)
                .subscriberContext { context ->
                    var ctx = context.put(RestRequestInfo::class.java, restRequestInfo(exchange))
                    ctx = ctx.put(COLLABORATION_ID, UUID.randomUUID().toString())
                    ctx=ctx.put(COMPONENT_NAME, "sample-component-name")
                    ctx=ctx.put(USER_NAME, "POSTMAN")
                     ctx
                }
    }

然后我想在所有后续日志中使用上面添加的键值对，以便像 Splunk 这样的日志聚合器可以根据协作 ID 获取与此特定请求关联的所有 JSON 日志。目前，从上下文中获取值的唯一方法是通过 doOnEach 函数调用，在该函数中我们获取信号句柄，通过该句柄获取上下文句柄。但所有 doOnEach 都会在每个事件期间被调用，无论每个函数调用是成功还是失败

return Mono.just(request)
            .doOnEach(**Code to log with context data**)
            .map(RequestValidations::validateRequest)
            .doOnEach(**Code to log with context data**)
            .map(RequestValidations::buildRequest)
            .map(RequestValidations::validateQueryParameters)
            .doOnEach(**Code to log with context data**)
            .flatMap(coverageSummariesGateway::getCoverageSummaries)
            .doOnEach(**Code to log with context data**)
            .map({ coverageSummaries -> 
getCoverageSummariesResponse(coverageSummaries, serviceReferenceId) })
            .doOnEach(**Code to log with context data**)
            .flatMap(this::renderSuccess)
            .doOnEach(**Code to log with context data**)
            .doOnError { logger.info("ERROR OCCURRED") }

谢谢！

Answer 1

您可以执行以下操作：

return Mono.just(request)
            .doOnEach(**Code to log with context data**)
            .flatMap( r -> withMDC(r, RequestValidations::validateRequest))

以下方法将填充映射诊断上下文 (MDC)，以便您将其自动记录在日志中（取决于您的日志记录模式）。例如。 logback 有

%X{traceId}

，其中

traceId

是

tracingContext

映射中的键。

public static <T, R> Mono<R> withMDC(T value, Function<T, Mono<R>> f) {
    return Mono.subscriberContext()
               .flatMap( ctx -> {
                    Optional<Map> tracingContext = ctx.getOrEmpty("tracing-context-key");
                    if (tracingContext.isPresent()) {
                        try {
                            MDC.setContextMap(tracingContext.get());
                            return f.apply(value);
                        } finally {
                            MDC.clear();
                        }
                    } else{
                        return f.apply(value);
                    }
               });

}

不太好，希望最终能通过日志框架改进，并且上下文会自动注入。

Answer 2

还有其他更好的答案吗？我现在被困在类似的船上。 MDC 再次使用 threadlocal。

官方 spring 文档说像 slf4j 这样的库支持异步日志记录，但它没有给出任何如何将上下文从 serverwebexchange 传播到特定请求的日志的示例。

事实上，当 java 21+ 或 spring 开始使用虚拟线程的概念时，很快就会出现问题。

我认为如果我们知道 spring webflux 实际上如何存储正确的 serverwebexchange 对象，我们就可以找到答案。如果我们知道 - 我们可以创建类似的自定义上下文/线程本地概念。