• 为 HttpClient 注册自定义请求标头


    前言

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

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

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

    1. 使用 HttpRequestMessage

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

    ServiceA 的实现代码如下:

    1. [HttpGet]
    2. public async Task<stringGet()
    3. {
    4.     var userId = GetUserId();//从认证信息中获取
    5.     var request = new HttpRequestMessage(HttpMethod.Get, "/ServiceB");
    6.     if (!string.IsNullOrWhiteSpace(userId))
    7.     {
    8.         request.Headers.Add("x-user-id", userId);
    9.     }
    10.     var client = _clientFactory.CreateClient("ServiceB-Client");
    11.     var response =  await client.SendAsync(request);
    12.     return await response.Content.ReadAsStringAsync();
    13. }

    但是,这种解决方案存在一个问题:

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

    2.使用 DelegatingHandler

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

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

    实现代码如下:

    1. public class UserIdDelegatingHandler : DelegatingHandler
    2. {
    3.     protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    4.     {
    5.         var userId = GetUserId();//从认证信息中获取
    6.         if (!string.IsNullOrWhiteSpace(userId) 
    7.             && !request.Headers.Contains("x-user-id"))
    8.         {
    9.             request.Headers.TryAddWithoutValidation(Headers.CorrelationId, userId);
    10.         }
    11.         return await base.SendAsync(request, cancellationToken);
    12.     }
    13. }

    然后修改 Startup.cs,注册 UserIdDelegatingHandler:

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

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

    1. [HttpGet]
    2. public async Task<stringGet()
    3. {
    4.     var client = _clientFactory.CreateClient("ServiceB-Client");
    5.     var response =  await client.GetAsync("/ServiceB");
    6.     return await response.Content.ReadAsStringAsync();
    7. }

    结论

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

  • 相关阅读:
    《人件》读书笔记
    6月PMP考试准考证问题及注意事项,考生必读
    键盘按键Home & End的妙用
    docker安装Elasticsearch
    常见的行为型设计模式
    锁机制到底是啥
    ZooKeeper 6:分布式系统及相关理论
    [Centos]Docker卸载/安装&常用命令
    类和对象!
    pyqt5 学习笔记八 (窗口、信号与槽)
  • 原文地址:https://blog.csdn.net/biyusr/article/details/125514212