.NET6中如何在请求完成后为后台任务记录HttpContext属性

核心原因 #

请求结束后HttpContext会被回收，后台任务异步执行时无法再通过IHttpContextAccessor获取到请求上下文，导致日志增强器拿不到UserAgent这类属性。

具体实现方案 #

1. 在请求上下文内提前捕获所需属性 #

在控制器方法中，先从HttpContext里提取需要的属性（比如UserAgent），再传递给后台任务或附加到日志上下文。

方式一：直接传递属性到后台任务

修改代码，把UserAgent作为参数传入后台任务，日志时手动带上该属性：

[HttpGet, Route("User/{id:int}")]
public async Task<IActionResult> GetUserById(int id)
{
    var user = await _repository.GetUser(id);
    // 提前捕获UserAgent
    var userAgent = HttpContext.Request.Headers.UserAgent.ToString();
    // 传入后台任务
    SomeBackgroundTask(user, userAgent);

    _logger.LogInformation("Something happened 1.");
    return Ok(user);
}

public async Task SomeBackgroundTask(User user, string userAgent)
{
    try
    {
        await Task.Delay(10000);
    }
    catch (Exception e)
    {
        // 日志时手动添加UserAgent属性
        _logger.LogError(e, "Something happened 2. {UserAgent}", userAgent);
    }
}

方式二：利用Serilog的上下文保存属性

若希望所有后台任务日志自动带上这些属性，可在请求上下文内将属性存入Serilog的LogContext，后台任务执行时继承该上下文：

// 首先在Program.cs中启用LogContext
builder.Host.UseSerilog((ctx, lc) => lc
    .ReadFrom.Configuration(ctx.Configuration)
    .Enrich.FromLogContext() // 启用LogContext增强
);

// 修改控制器和后台任务代码
[HttpGet, Route("User/{id:int}")]
public async Task<IActionResult> GetUserById(int id)
{
    var user = await _repository.GetUser(id);
    var userAgent = HttpContext.Request.Headers.UserAgent.ToString();

    // 将UserAgent存入LogContext
    using (LogContext.PushProperty("UserAgent", userAgent))
    {
        _logger.LogInformation("Something happened 1.");
        // 后台任务要在using块内启动，才能继承LogContext
        await SomeBackgroundTask(user);
    }

    return Ok(user);
}

public async Task SomeBackgroundTask(User user)
{
    try
    {
        await Task.Delay(10000);
    }
    catch (Exception e)
    {
        // 日志自动带上UserAgent属性
        _logger.LogError(e, "Something happened 2.");
    }
}

注意：后台任务必须在LogContext.PushProperty的using块内启动，因为LogContext基于异步本地存储（AsyncLocal），只有在同一个异步流内才能继承上下文。若后台任务通过IHostedService等方式延迟执行，需单独传递属性。

2. 封装上下文传递工具类 #

若需传递多个属性，可封装一个RequestContext类统一保存请求相关属性，再传递给后台任务：

public class RequestContext
{
    public string UserAgent { get; set; }
    // 可添加其他需要的属性，比如请求ID、用户ID等
}

// 控制器中捕获上下文
[HttpGet, Route("User/{id:int}")]
public async Task<IActionResult> GetUserById(int id)
{
    var user = await _repository.GetUser(id);
    var requestContext = new RequestContext
    {
        UserAgent = HttpContext.Request.Headers.UserAgent.ToString()
    };

    await SomeBackgroundTask(user, requestContext);
    _logger.LogInformation("Something happened 1.");
    return Ok(user);
}

// 后台任务中使用上下文
public async Task SomeBackgroundTask(User user, RequestContext requestContext)
{
    try
    {
        await Task.Delay(10000);
    }
    catch (Exception e)
    {
        _logger.LogError(e, "Something happened 2. {UserAgent}", requestContext.UserAgent);
    }
}

关键注意事项 #

• 禁止在后台任务中通过IHttpContextAccessor获取HttpContext，请求结束后该上下文已被释放，可能返回null或无效数据。
• 若后台任务通过Task.Run或第三方队列（如Hangfire）执行，需显式传递属性，这类场景会脱离原请求的异步上下文。

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