.NET 6 REST API如何为请求添加唯一ID并写入日志文件？

针对你的需求，不管是用.NET内置功能还是第三方日志库，都能轻松实现为每个请求添加唯一ID（GUID/随机字符串）的效果，完全避开线程ID复用的问题，下面是具体实现方案：

一、ASP.NET Core内置方案（无需额外NuGet包） #

ASP.NET Core自带的日志系统支持日志范围（Log Scopes），配合请求中间件就能为每个请求生成唯一ID，并自动传递到整个请求链路的日志中。

实现步骤： #

1. 注册请求ID中间件
   在Program.cs中添加中间件，为每个请求生成GUID作为请求ID，同时通过日志范围将ID注入后续所有日志：

var builder = WebApplication.CreateBuilder(args);

// 配置控制台日志，确保能输出范围信息
builder.Logging.AddConsole(options =>
{
    options.FormatterName = "requestIdFormatter";
    options.Formatters.Add(new RequestIdConsoleFormatter());
});

var app = builder.Build();
var logger = app.Services.GetRequiredService<ILogger<Program>>();

// 注入请求ID中间件
app.Use(async (context, next) =>
{
    var requestId = Guid.NewGuid().ToString("N"); // 生成短格式GUID
    context.Items["RequestId"] = requestId;
    
    // 创建日志范围，后续该请求的所有日志都会自动带上这个ID
    using (logger.BeginScope("RequestId:{RequestId}", requestId))
    {
        await next();
    }
});

app.MapControllers();
app.Run();

2. 自定义日志输出格式
   如果要输出像你示例里的格式，实现一个自定义控制台日志格式化器：

public class RequestIdConsoleFormatter : ConsoleFormatter
{
    public RequestIdConsoleFormatter() : base("requestIdFormatter") { }

    public override void Write<TState>(in LogEntry<TState> logEntry, IExternalScopeProvider scopeProvider, TextWriter textWriter)
    {
        var timestamp = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.ffff");
        var logLevel = logEntry.LogLevel.ToString().ToUpper();
        var requestId = string.Empty;

        // 从日志范围中提取RequestId
        scopeProvider?.ForEachScope((scope, _) =>
        {
            if (scope is string scopeStr && scopeStr.StartsWith("RequestId:"))
            {
                requestId = scopeStr.Split(':')[1];
            }
        }, null);

        // 只取类名作为日志来源（比如FooController）
        var category = logEntry.Category.Split('.').Last();
        var message = logEntry.Formatter(logEntry.State, logEntry.Exception);

        textWriter.WriteLine($"{timestamp} {logLevel} {requestId} {category} {message}");
    }
}

3. 业务代码无需修改
   你的控制器、服务、仓储里的日志代码保持原样即可，日志范围会自动把RequestId附加到所有日志条目：

public class FooController : ControllerBase
{
    private readonly ILogger<FooController> _logger;
    private readonly IFooService _fooService;
    private readonly IMapper _mapper;

    public FooController(ILogger<FooController> logger, IFooService fooService, IMapper mapper)
    {
        _logger = logger;
        _fooService = fooService;
        _mapper = mapper;
    }

    [HttpPost]
    public Foo CreateFoo(FooDto fooDto)
    {
        _logger.LogDebug("Some logging in the controller");
        var foo = _mapper.Map<IFoo>(fooDto);
        _fooService.CreateFoo(foo);
        return foo;
    }
}

public class FooService
{
    private readonly ILogger<FooService> _logger;
    private readonly IFooRepository _fooRepository;

    public FooService(ILogger<FooService> logger, IFooRepository fooRepository)
    {
        _logger = logger;
        _fooRepository = fooRepository;
    }

    public void CreateFoo(IFoo foo)
    {
        _logger.LogDebug("Some logging in the service");
        _fooRepository.Create(foo);
    }
}

public class FooRepository
{
    private readonly ILogger<FooRepository> _logger;

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

    public void Create(IFoo foo)
    {
        _logger.LogDebug("Some logging in the repository");
    }
}

二、第三方NuGet包方案（以Serilog为例） #

Serilog是.NET生态中常用的日志库，提供了现成的扩展来处理请求关联ID，配置更简洁灵活。

实现步骤： #

1. 安装必要NuGet包

Install-Package Serilog.AspNetCore
Install-Package Serilog.Enrichers.CorrelationId

2. 配置Serilog
   在Program.cs中完成Serilog的配置，启用请求关联ID功能：

var builder = WebApplication.CreateBuilder(args);

// 配置Serilog
builder.Host.UseSerilog((context, config) =>
{
    config
        .WriteTo.Console(outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.ffff} {Level:u3} {CorrelationId} {SourceContext:l} {Message:lj}{NewLine}{Exception}")
        .Enrich.FromLogContext()
        // 支持自动生成GUID，也允许客户端通过X-Correlation-ID头传入自定义ID
        .Enrich.WithCorrelationId(headerName: "X-Correlation-ID")
        .ReadFrom.Configuration(context.Configuration);
});

var app = builder.Build();

// 启用Serilog请求日志中间件
app.UseSerilogRequestLogging();

app.MapControllers();
app.Run();

3. 业务代码无改动
   控制器、服务、仓储的日志代码保持原样，Serilog会自动为每个请求生成（或读取请求头的）唯一CorrelationId，并附加到所有日志中。

关键说明 #

• 内置方案适合轻量场景，无需额外依赖；Serilog方案更灵活，支持更多自定义格式、日志 sink（比如文件、ELK等）集成。
• 两种方案的请求ID都和请求生命周期绑定，和线程无关，完全避免了线程ID复用导致的日志混淆问题。

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