为Blazor Server应用的外部API请求生成唯一关联ID的方案咨询

方案一：基于AsyncLocal的关联ID服务 #

这是最直接的方案，利用AsyncLocal<T>在异步执行上下文中传递唯一ID，无需手动传递，且不会跨用户会话混淆。

1. 创建关联ID服务 #

public class CorrelationIdService
{
    // AsyncLocal会绑定到当前异步执行上下文，每个API请求的异步链拥有独立值
    private readonly AsyncLocal<string> _currentCorrelationId = new AsyncLocal<string>();

    // 获取当前关联ID，若未设置则自动生成（可选）
    public string CurrentId => _currentCorrelationId.Value ?? Guid.NewGuid().ToString();

    // 生成并设置新的关联ID，返回该ID用于API请求头
    public string SetNewId()
    {
        var newId = Guid.NewGuid().ToString();
        _currentCorrelationId.Value = newId;
        return newId;
    }
}

2. 注册服务 #

在Program.cs中将服务注册为Scoped（与用户会话绑定）：

builder.Services.AddScoped<CorrelationIdService>();

3. 在API请求中使用 #

发起外部API请求时，生成新ID并添加到请求头：

@inject CorrelationIdService CorrelationIdService
@inject HttpClient HttpClient

<button @onclick="CallExternalApi">调用外部API</button>

@code {
    async Task CallExternalApi()
    {
        var correlationId = CorrelationIdService.SetNewId();
        var request = new HttpRequestMessage(HttpMethod.Get, "https://external-api.com/your-endpoint");
        request.Headers.Add("X-Correlation-Id", correlationId);

        var response = await HttpClient.SendAsync(request);
        // 处理响应逻辑
    }
}

4. 在组件中访问关联ID #

无需手动传递，直接注入服务获取当前上下文的ID：

@inject CorrelationIdService CorrelationIdService

<p>当前API请求关联ID：@CorrelationIdService.CurrentId</p>

@code {
    async Task LogOperation()
    {
        // 日志或业务逻辑中使用关联ID
        Console.WriteLine($"用户操作完成，关联ID：{CorrelationIdService.CurrentId}");
    }
}

方案二：利用System.Diagnostics.Activity创建独立追踪ID #

如果希望贴合.NET诊断追踪规范，可为每个API请求创建独立的Activity，其ID可直接作为关联ID使用。

1. 启用Activity支持 #

在Program.cs中注册ActivitySource：

var activitySource = new ActivitySource("YourBlazorAppName");
builder.Services.AddSingleton(activitySource);

2. 在API请求中创建Activity #

@inject ActivitySource ActivitySource
@inject HttpClient HttpClient

async Task CallExternalApi()
{
    // 创建并启动新Activity，每个请求生成唯一ID
    using var activity = ActivitySource.StartActivity("ExternalApiRequest");
    var correlationId = activity?.Id ?? Guid.NewGuid().ToString();

    var request = new HttpRequestMessage(HttpMethod.Get, "https://external-api.com/your-endpoint");
    request.Headers.Add("X-Correlation-Id", correlationId);

    var response = await HttpClient.SendAsync(request);
}

3. 在组件中获取当前Activity ID #

在同一个异步执行上下文中，直接通过Activity.Current.Id获取：

@code {
    async Task LogTrace()
    {
        if (Activity.Current != null)
        {
            Console.WriteLine($"追踪ID：{Activity.Current.Id}");
        }
    }
}

方案对比 #

• AsyncLocal方案：轻量、直接，完全围绕关联ID需求设计，无需理解复杂的诊断追踪概念。
• Activity方案：符合.NET官方诊断规范，若后续需要接入OpenTelemetry等监控工具，可无缝过渡。

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