设置API响应Header时触发NullReferenceException的问题排查

问题原因 #

控制器的Response属性并非在实例创建后立即赋值，只有当ASP.NET Core请求上下文管道完成初始化后，该属性才会被注入有效对象。出现空引用异常的常见场景：

• 在控制器构造函数中调用PopulateRequestIdHeader，此时请求上下文尚未绑定
• 单元测试中直接实例化控制器，未模拟HttpContext和Response对象
• 在Action方法的finally块中调用，部分场景下响应上下文还未完成初始化

解决方案 #

1. 给Response添加空值检查 #

修改PopulateRequestIdHeader方法，避免空引用崩溃：

protected void PopulateRequestIdHeader(string functionName)
{
    string requestId = Guid.NewGuid().ToString();
    messageLogger.LogDebug(context, $"Populating request-id header for {functionName} function with {requestId}");
    
    if (this.Response != null)
    {
        // 使用Append避免重复添加响应头
        this.Response.Headers.Append("request-id", requestId);
    }
    else
    {
        messageLogger.LogWarning(context, "Response对象为空，无法添加request-id响应头");
    }
}

2. 调整调用时机 #

确保在请求上下文初始化完成后调用方法，比如在try块内部、返回结果之前：

public async Task<ActionResult> CreatePolicy<T>(T input) where T : PolicyBase
{
    Stopwatch stopwatch = Stopwatch.StartNew();
    ProtectionPolicyBase resultPolicy = null;
    try
    {
        // 在业务逻辑执行前调用，确保Response已初始化
        PopulateRequestIdHeader(nameof(CreatePolicy));
        resultPolicy = await policyManager.CreatePolicy<PolicyBase>(input);
        return Created(resultPolicy); 
    }
    catch (Exception e)
    {
          // 异常场景也设置响应头
          PopulateRequestIdHeader(nameof(CreatePolicy));
          return new ObjectResult()
          {
               StatusCode = StatusCodes.Status500InternalServerError
          };
    }
    finally
    {
        stopwatch.Stop();
        messageLogger.LogDebug(enhancedRestoreContext, $"Time taken to finish creating policy :{stopwatch.ElapsedMilliseconds} ms");
    }
}

3. 使用ActionFilter统一处理（推荐） #

ASP.NET Core的过滤器机制更适合统一处理响应头，避免在控制器方法中直接操作Response，同时确保上下文已初始化：

public class RequestIdHeaderFilter : IActionFilter
{
    private readonly ILogger<RequestIdHeaderFilter> _logger;

    public RequestIdHeaderFilter(ILogger<RequestIdHeaderFilter> logger)
    {
        _logger = logger;
    }

    public void OnActionExecuting(ActionExecutingContext context)
    {
        string requestId = Guid.NewGuid().ToString();
        _logger.LogDebug($"Populating request-id header with {requestId}");
        context.HttpContext.Response.Headers.Append("request-id", requestId);
    }

    public void OnActionExecuted(ActionExecutedContext context)
    {
        // 可选：Action执行后的额外处理
    }
}

在Program.cs（或Startup.cs）中注册过滤器，全局生效：

// .NET 6+ 写法
builder.Services.AddControllers(options =>
{
    options.Filters.Add<RequestIdHeaderFilter>();
});

这样所有控制器的Action都会自动添加request-id响应头，无需手动在每个方法中调用，也从根源避免了Response为空的问题。

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