如何在ASP.NET Core 2应用中为每个请求添加唯一标识用于日志记录？

嘿，你这个需求ASP.NET Core 2其实已经有现成的解决方案了，完全不用自己从零实现！我给你梳理下两种最实用的方式，优先推荐内置功能：

ASP.NET Core 2自带了HttpContext.TraceIdentifier，这就是每个请求的唯一标识——默认是框架生成的一串字符，但你可以轻松改成Guid格式。更方便的是，你可以把这个ID加入日志作用域，这样所有和当前请求相关的日志都会自动带上这个ID，不用每次写日志都手动传参数。

举个实际的配置例子，在Startup.cs的Configure方法里，加一段中间件（要放在其他中间件之前，比如UseMvc）：

app.Use(async (context, next) =>
{
    // 把默认的TraceIdentifier替换成无横线的Guid格式
    context.TraceIdentifier = Guid.NewGuid().ToString("N");
    // 开启日志作用域，让后续所有日志自动包含这个请求ID
    using (var logger = context.RequestServices.GetRequiredService<ILoggerFactory>().CreateLogger("RequestScope"))
    using (logger.BeginScope(new { RequestId = context.TraceIdentifier }))
    {
        await next();
    }
});

然后在appsettings.json里配置Console日志，开启作用域显示，这样请求ID就会出现在每条日志里：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information"
    },
    "Console": {
      "IncludeScopes": true,
      "TimestampFormat": "yyyy-MM-dd HH:mm:ss ",
      "FormatterOptions": {
        "SingleLine": true
      }
    }
  }
}

最终的日志输出会像这样：

2024-05-20 14:30:00 [RequestId: d4a7f8b9c0d1e2f3a4b5c6d7e8f9a0b1] Information: 处理首页请求

如果内置的TraceIdentifier满足不了你的需求——比如要加自定义前缀、特殊格式，或者要把请求ID放到响应头返回给客户端——那可以自己写个超简单的中间件：

首先是中间件代码：

public class CustomRequestIdMiddleware
{
    private readonly RequestDelegate _next;

    public CustomRequestIdMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task InvokeAsync(HttpContext context, ILogger<CustomRequestIdMiddleware> logger)
    {
        // 生成带前缀的自定义请求ID
        var requestId = $"REQ-{Guid.NewGuid():N}";
        
        // 把ID存到HttpContext里，业务代码随时能取到
        context.Items["CustomRequestId"] = requestId;
        
        // 把ID加到响应头，方便客户端追踪请求
        context.Response.Headers.Add("X-Request-Id", requestId);
        
        // 开启日志作用域，自动带上请求ID
        using (logger.BeginScope(new Dictionary<string, object> { ["RequestId"] = requestId }))
        {
            await _next(context);
        }
    }
}

// 写个扩展方法，注册起来更方便
public static class CustomRequestIdMiddlewareExtensions
{
    public static IApplicationBuilder UseCustomRequestId(this IApplicationBuilder app)
    {
        return app.UseMiddleware<CustomRequestIdMiddleware>();
    }
}

然后在Startup.cs的Configure方法里注册（记得放在最前面）：

app.UseCustomRequestId();
// 其他中间件比如UseMvc、UseStaticFiles等

不管用哪种方式，你在业务代码里写日志的时候都不用手动处理请求ID，日志框架会自动从作用域里获取并输出，比如：

public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;

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

    public IActionResult Index()
    {
        // 这条日志会自动带上RequestId
        _logger.LogInformation("处理首页请求");
        return View();
    }
}

最后总结 #

优先用内置的TraceIdentifier方案，因为它已经被框架的错误处理等组件使用，一致性更好；如果需要自定义格式或者额外功能（比如响应头），再用自定义中间件，实现成本极低。

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