Spring WebFlux中TraceWebFilter自定义响应头加TraceId的方案咨询

嘿，刚好我之前在Spring Cloud Sleuth 2.x的响应式项目里做过类似的需求，给你分享下可行的解决方案！

你说得对，TraceWebFilter在Sleuth 2.0.0.M5版本里确实没有暴露可直接调用的构造器——它是框架内部用来处理追踪逻辑的组件，不建议直接实例化使用。我们可以自己写一个简单的WebFilter（WebFlux环境下的过滤器），借助Sleuth提供的Tracer来实现把TraceId添加到响应头的需求，而且这种方式对Kotlin函数式端点完全兼容。

实现步骤 #

1. 自定义WebFilter组件 #

创建一个@Component注解的WebFilter，注入Tracer实例，在过滤逻辑中获取当前追踪的Span，提取TraceId并设置到响应头：

import org.springframework.cloud.sleuth.Tracer
import org.springframework.stereotype.Component
import org.springframework.web.server.ServerWebExchange
import org.springframework.web.server.WebFilter
import org.springframework.web.server.WebFilterChain
import reactor.core.publisher.Mono

@Component
class TraceIdResponseHeaderFilter(private val tracer: Tracer) : WebFilter {

    // 你可以自定义响应头的名称，比如这里用X-Trace-Id
    private val TRACE_ID_HEADER = "X-Trace-Id"

    override fun filter(exchange: ServerWebExchange, chain: WebFilterChain): Mono<Void> {
        // 获取当前的追踪Span
        val currentSpan = tracer.currentSpan()
        currentSpan?.let { span ->
            // 将TraceId写入响应头
            exchange.response.headers.add(TRACE_ID_HEADER, span.context().traceId())
        }
        // 继续执行后续的请求处理链
        return chain.filter(exchange)
    }
}

2. 验证效果 #

启动应用后，不管是访问Kotlin函数式端点还是其他WebFlux端点，响应头里都会带上你定义的X-Trace-Id（或者你自定义的头名），值就是Sleuth生成的TraceId。

额外优化（可选） #

如果你只想给特定路径的端点添加TraceId，可以在Filter里增加路径判断逻辑：

override fun filter(exchange: ServerWebExchange, chain: WebFilterChain): Mono<Void> {
    val requestPath = exchange.request.path.toString()
    // 只给/api开头的端点添加TraceId
    if (requestPath.startsWith("/api/")) {
        tracer.currentSpan()?.let { span ->
            exchange.response.headers.add(TRACE_ID_HEADER, span.context().traceId())
        }
    }
    return chain.filter(exchange)
}

为什么不用TraceWebFilter？ #

在Sleuth 2.x的响应式实现中，TraceWebFilter是框架内部封装的组件，它的构造器是包私有或者受保护的，目的是让框架自己管理实例，避免开发者直接依赖内部实现导致版本升级时出现兼容性问题。我们自己实现的Filter更轻量，也更灵活可控。

内容的提问来源于stack exchange，提问作者A Kumar