为 HttpClient 注册自定义请求标头

前言

上次，我们介绍了《在 ASP.NET Core 中使用 HTTP 标头传播》。

但是有时候，当服务间需要互相调用时，也需要将创建一些自定义标头传播到目标服务。

比如， ServiceA 已经进行了身份验证，那么当它调用 ServiceB 时，不需要传播 HTTP 标头 Authorization，可以自定义 x-user-id 标头， 直接告诉 ServiceB 当前用户 ID。

1. 使用 HttpRequestMessage

最简单的方法，创建 HttpRequestMessage 实例直接添加标头。

ServiceA 的实现代码如下：

[HttpGet]
public async Task<string> Get()
{
    var userId = GetUserId();//从认证信息中获取
    var request = new HttpRequestMessage(HttpMethod.Get, "/ServiceB");
    if (!string.IsNullOrWhiteSpace(userId))
    {
        request.Headers.Add("x-user-id", userId);
    }

    var client = _clientFactory.CreateClient("ServiceB-Client");

    var response =  await client.SendAsync(request);
    return await response.Content.ReadAsStringAsync();
}

但是，这种解决方案存在一个问题：

• 如果有多个调用其他服务的方法，我们需要重复相同的逻辑；

2.使用 DelegatingHandler

在 ASP.NET Core 中，我们经常会使用 Middleware, 它使用管道模式，可以对服务收到的请求进行处理：

而 DelegatingHandler 提供了几乎相同的概念，但却是在 HttpClient 发出传出请求时。

实现代码如下：

public class UserIdDelegatingHandler : DelegatingHandler
{
    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        var userId = GetUserId();//从认证信息中获取
        if (!string.IsNullOrWhiteSpace(userId) 
            && !request.Headers.Contains("x-user-id"))
        {
            request.Headers.TryAddWithoutValidation(Headers.CorrelationId, userId);
        }

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

然后修改 Startup.cs，注册 UserIdDelegatingHandler：

public void ConfigureServices(IServiceCollection services)
{
    services.AddHttpClient("ServiceB-Client", options => options.BaseAddress = new Uri("http://localhost:57516"))
         .AddHttpMessageHandler<UserIdDelegatingHandler>()
    
    ......
}

现在，我们可以从调用服务的代码中删除有关注册自定义标头的所有代码：

[HttpGet]
public async Task<string> Get()
{
    var client = _clientFactory.CreateClient("ServiceB-Client");

    var response =  await client.GetAsync("/ServiceB");
    return await response.Content.ReadAsStringAsync();
}

结论

如果我们想向 HttpClient 添加任何标头，无需修改业务代码，只需调用 .AddHttpMessageHandler 注册新的 DelegatingHandler 即可。