单例服务中的多个上下文

Question

目前我正在设计一个记录器服务来记录由HttpClient 制作的HttpRequests。

这个记录器服务是Singleton，我想在里面有scoped 上下文。

这是我的记录器：

public Logger
{
    public LogContext Context { get; set; }    

    public void LogRequest(HttpRequestLog log)
    {  
        context.AddLog(log);
    }
}

我在DelegatingHandler 中使用记录器：

private readonly Logger logger;

public LoggingDelegatingHandler(Logger logger)
{
  this.logger = logger;
}

protected async override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
   await base.SendAsync(request, cancellationToken);
   this.logger.LogRequest(new HttpRequestog());
}

然后，当我使用HttpClient 发出一些请求时，我希望获得此特定呼叫的日志：

private void InvokeApi()
{
  var logContext = new LogContext();
  this.Logger.LogContext = logContext;
  var httpClient = httpClientFactory.CreateClient(CustomClientName);
  await httpClient.GetAsync($"http://localhost:11111");

  var httpRequestLogs = logContext.Logs;
}

问题是，它可以工作，但它不是线程安全的。如果我有InvokeApi 的并行执行，context 将不正确。

如何正确地为每次执行附加上下文？

我正在像这样注册 HttpClient：

services.AddSingleton<Logger>();
services.AddHttpClient(CentaurusHttpClient)
        .ConfigurePrimaryHttpMessageHandler((c) => new HttpClientHandler()
        {
             AutomaticDecompression = DecompressionMethods.GZip | DecompressionMethods.Deflate,
        })
        .AddHttpMessageHandler(sp => new LoggingDelegatingHandler(sp.GetRequiredService<Logger>()));

我正在使用这个测试这段代码：

public void Test_Parallel_Logging()
{
    Random random = new Random();

    Action test = async () =>
    {
        await RunScopedAsync(async scope =>
        {
            IServiceProvider sp = scope.ServiceProvider;

            var httpClientFactory = sp.GetRequiredService<IHttpClientFactory>();
            using (var context = new HttpRequestContext(sp.GetRequiredService<Logger>()))
            {
                try
                {
                    var httpClient = httpClientFactory.CreateClient();
                    await httpClient.GetAsync($"http://localhost:{random.Next(11111, 55555)}");
                }
                catch (HttpRequestException ex)
                {
                    Output.WriteLine("count: " + context?.Logs?.Count);
                }
            }
        });
    };

    Parallel.Invoke(new Action[] { test, test, test });
}

Answer 1

这个记录器服务是单例的，我想在里面有作用域的上下文。

Logger 具有单例生命周期，因此其 LogContext 属性也具有单例生命周期。

对于您想要的那种范围数据，AsyncLocal<T> 是一个合适的解决方案。我倾向于遵循类似于 React 上下文的“提供者”/“消费者”模式，尽管“消费者”在 .NET 世界中更常见的名称是“访问者”。在这种情况下，您可以将 Logger 本身设置为提供程序，但我通常会尝试将其保留为单独的类型。

IMO 这通过提供您自己的显式范围最干净地完成，并且不绑定到您的 DI 容器的“范围”生命周期。可以使用 DI 容器范围来做到这一点，但你最终会得到一些奇怪的代码，比如解析生产者，然后对它们什么都不做 - 如果未来的维护者删除（看起来是）未使用的注入类型，那么访问器就会中断。

所以我推荐你自己的范围，例如：

public Logger
{
  private readonly AsyncLocal<LogContext> _context = new();

  public void LogRequest(HttpRequestLog log)
  {
    var context = _context.Value;
    if (context == null)
      throw new InvalidOperationException("LogRequest was called without anyone calling SetContext");
    context.AddLog(log);
  }

  public IDisposable SetContext(LogContext context)
  {
    var oldValue = _context.Value;
    _context.Value = context;
    // I use Nito.Disposables; replace with whatever Action-Disposable type you have.
    return new Disposable(() => _context.Value = oldValue);
  }
}

用法（注意using 提供的明确范围）：

private void InvokeApi()
{
  var logContext = new LogContext();
  using (this.Logger.SetContext(logContext))
  {
    var httpClient = httpClientFactory.CreateClient(CustomClientName);
    await httpClient.GetAsync($"http://localhost:11111");
    var httpRequestLogs = logContext.Logs;
  }
}