Asp.Net Core自定义中间件添加响应头：微服务Correlation ID与Swagger异常

我最近在给三个微服务实现Correlation ID日志追踪功能时，遇到了个棘手的问题：

• 原本的逻辑很清晰：请求带非空corrID就直接沿用，没有的话自动生成并传递到后续环节，业务日志里也能正常看到Correlation ID
• 但集成Swagger后直接炸了，抛出异常：headers are read-only response has already started

问题根源 #

后来才搞明白，这个报错是因为响应已经开始发送后，再尝试修改响应头就会触发只读限制。Swagger的请求响应流程和普通业务请求不一样，它的响应启动时机更早，导致我原来的代码里修改响应头的操作刚好赶在响应启动之后，直接撞了限制。

解决办法 #

我调整了最后一段判断逻辑，核心就是加个检查，确保只有在响应还没启动的时候才去修改响应头：

// 修改后的关键代码片段
var correlationId = context.Request.Headers["X-Correlation-ID"].FirstOrDefault() ?? Guid.NewGuid().ToString();

// 确保响应未启动时才设置响应头
if (!context.Response.HasStarted)
{
    context.Response.Headers["X-Correlation-ID"] = correlationId;
}

// 后续将correlationId注入日志上下文的逻辑不变

效果验证 #

改完之后测试了下：

• 普通业务请求依然能正常传递/生成Correlation ID，三个服务的日志里都能看到对应的值
• Swagger页面完全恢复正常，再也没抛出那个只读异常

这个调整既保留了原本的日志追踪功能，又兼容了Swagger的响应流程，完美解决了冲突~

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