向所有 HTTP 客户端添加 HTTP 消息处理程序

Question

我有一个名为 的 HTTP 消息处理程序AddHeadersHandler，它扩展了System.Net.Http.DelegatingHandler，我需要将它添加到所有当前和未来的HttpClient实例中，包括类型化、命名和非命名客户端。

我知道我可以.AddHttpMessageHandler<AddHeadersHandler>()为特定客户端添加一个处理程序，但是如何将它添加到所有客户端？

// AddHeadersHandler.cs
public class AddHeadersHandler: DelegatingHandler
{
    protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        request.Headers.TryAddWithoutValidation("X-Correlation-Id", Guid.NewGuid.ToString());

        return base.SendAsync(request, cancellationToken);
    }
}

// Startup.cs
services
    .AddHttpContextAccessor()
    .AddTransient<AddHeadersHandler>();
services
    .AddHttpClient<MyClient>()
    .AddHttpMessageHandler<AddHeadersHandler>(); // I don't want to specify this for each client.

// MyClient.cs
public class MyClient
{
    public HttpClient HttpClient { get; }

    public MyClient(HttpClient httpClient)
    {
        HttpClient = httpClient;
    }

    public async Task GetTest()
    {
        await HttpClient.GetAsync("https://localhost:5001/test"); // This should have headers attached.
    }
}

Answer 1

它可以通过配置来完成HttpClientFactoryOptions对所有命名方案。我们需要在 中提供一个委托HttpMessageHandlerBuilderActions，它会将您的处理程序包含到AdditionalHandlers属性列表中。

使用选项模式有多种方法可以做到这一点。

1. 使用 .AddSingleton() 吗？

如果您的处理程序有任何依赖项（例如IHttpContextAccessor获取当前关联 ID），我们希望使用依赖项注入来解决它。

我们可以使用OptionsBuilder API通过依赖注入来获取所需的处理程序。不幸的是，OptionsBuilder API 并没有像这样提供为所有命名实例配置选项的方法.ConfigureAll。

幸运的是，我们可以通过注册一个工厂方法来获得我们需要的东西IConfigureOptions<HttpClientFactoryOptions>：

// Startup.cs
services.AddSingleton<IConfigureOptions<HttpClientFactoryOptions>>(provider =>
{
    // When name is null, it will be used for all configurations.
    return new ConfigureNamedOptions<HttpClientFactoryOptions>(name: null, options =>
    {
        options.HttpMessageHandlerBuilderActions.Add(builder =>
        {
            // Here we have access to ServiceProvider to get an instance of the handler.
            builder.AdditionalHandlers.Add(provider.GetRequiredService<AddHeadersHandler>());
        });
    });
});

2. 使用 .ConfigureAll() ??

以下改进答案的灵感来自LostInComputer。

添加.ConfigureAll在您Startup.cs和使用IServiceProvider通过生成器对象，像这样：

services.ConfigureAll<HttpClientFactoryOptions>(options =>
{
    options.HttpMessageHandlerBuilderActions.Add(builder =>
    {
        builder.AdditionalHandlers.Add(builder.Services.GetRequiredService<AddHeadersHandler>());
    });
});