ASP.NET Core UseRouting后注册中间件无法添加响应头问题咨询

核心问题原因 #

• 你当前的中间件注册位置错误：UseEndpoints属于终端中间件，会直接执行匹配到的控制器/ Razor Pages业务逻辑，执行完成后直接将响应返回给上游中间件，注册在UseEndpoints之后的中间件不会进入正常请求的处理链路，自然无法写入响应头。你之前观察到的「中间件可以正常执行」仅会在请求未命中任何端点时触发，正常接口请求不会走到该位置的中间件逻辑。
• 你需要获取端点元数据的需求，只要把中间件放在UseRouting之后即可满足：UseRouting执行完端点匹配逻辑后，就已经将端点信息填充到了HttpContext中，不需要放在UseEndpoints之后。

修复步骤 #

1. 调整中间件注册顺序 #

修改Startup.cs的Configure方法，将中间件移到UseRouting和UseEndpoints之间：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerFactory factory)
{
    app.UseForwardedHeaders(new ForwardedHeadersOptions
    {
         ForwardedHeaders = ForwardedHeaders.XForwardedFor | ForwardedHeaders.XForwardedProto
    });

    app.UseRouting();

    // 调整到此处注册，既能拿到端点元数据，又能正常写入响应头
    app.MyHeaderMiddleware();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
        endpoints.MapRazorPages();
    });
}

2. 修复中间件代码的未定义变量问题 #

你当前的扩展方法中直接使用了未定义的endpoint变量，需要从HttpContext中获取端点实例，并补充空判断避免空引用异常：

public static void MyHeaderMiddleware(this IApplicationBuilder app)
{
    app.MyHeaderMiddleware((context, logger) =>
    {
        // 新增：从当前HttpContext获取匹配到的端点
        var endpoint = context.GetEndpoint();
        // 补充空判断，避免未命中端点的请求抛错
        var actionDescriptor = endpoint?.Metadata.GetMetadata<ControllerActionDescriptor>();
        int status = context.Response.StatusCode;

        if (context.Request.Host != null)
        {
            logger.PutProperty("Host", context.Request.Host.Value);
        }

        if (context.Request?.HttpContext?.Connection?.RemoteIpAddress != null)
        {
            logger.PutProperty("SourceIp", context.Request.HttpContext.Connection.RemoteIpAddress.ToString());
        }

        if (context.Request.Headers.TryGetValue("X-Forwarded-For", out StringValues value) && !String.IsNullOrEmpty(value) && value.Count > 0)
        {
            logger.PutProperty("X-Forwarded-For", value.ToArray());
        }
   
        return Task.CompletedTask;
    });
}

3. 可选优化 #

在响应头添加逻辑中补充重复判断，避免部分特殊场景下重复添加头抛出异常：

context.Response.OnStarting(() =>
{
    stopWatch.Stop();
    // 先判断头是否已存在，避免重复添加报错
    if (!context.Response.Headers.ContainsKey("X-Server-Side-Latency"))
    {
        context.Response.Headers.Add("X-Server-Side-Latency", stopWatch.ElapsedMilliseconds.ToString());
    }
    return Task.CompletedTask;
});

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