.NET Core 3.0之深入源码理解HttpClientFactory(一)

写在前面

创建HttpClient实例的时候,在内部会创建HttpMessageHandler链,我们知道HttpMessageHandler是负责建立连接的抽象处理程序,所以HttpClient的维护实际上就是维护HttpMessageHandler的使用,释放HttpClient并不会及时释放连接,而通常情况下一般是创建全局使用的HttpClient实例,以减少重复连接的次数。当然这种方式所带来的的弊端也是显而易见的,因为当前的HttpClient实例所指向的服务器发生问题或者DNS发生变更,那么该实例是无法做到自动更新指向的。

以下为运行其流程图:

128b3ce864895d7d13c28d382c876b7

HttpClientFactory自.NET Core 2.1引入,可以认为它是一个配置和创建HttpClient的中心化,.NET Core通过引入HttpClientFactory用于自动化维护HttpMessageHandler池及其生命周期,避免在手动管理 HttpClient生存期时出现的常见 DNS 问题。在默认情况下MessageHandler的活跃状态是两分钟,也就是说,在两分钟后,就可以为HttpClient实例重新定位到正确的主机上。

本文的讨论思路将从我们能看到的代码开始一步步深入。

详细介绍

HttpClientFactory的功能主要位于Microsoft.Extensions.Http包中,它已经默认包含在Microsoft.AspNetCore.App元包中。针对HttpClientFactory的处理涉及到IHttpClientBuilder、IHttpClientFactory、IHttpMessageHandlerFactory、ITypedHttpClientFactory这几大接口,以下将分别做讨论。

services.AddHttpClient()

我们在创建或者配置HttpClient对象的时候,会在ConfigureServices方法中增加services.AddHttpClient(),即可注册IHttpClientFactory。

这段代码位于Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions中,它会初始化相关信息并注册到IServiceCollection中,这些信息包括日志、选项、核心抽象功能、类型客户端以及其他基础设施功能。

需要注意的是,在核心抽象功能中,DefaultHttpClientFactory是单例模式的,其所继承的接口对象的获取也是单例的,而HttpMessageHandlerBuilder注册方式确是每一次GetService的时候都会创建一个新的HttpMessageHandlerBuilder实例。

以下为services.AddHttpClient()的源代码,其中标红部分为核心抽象功能的注册:

   1:  public static IServiceCollection AddHttpClient(this IServiceCollection services)
   2:  {
   3:      if (services == null)
   4:      {
   5:          throw new ArgumentNullException(nameof(services));
   6:      }
   7:   
   8:      services.AddLogging();
   9:      services.AddOptions();
  10:     
11: services.TryAddTransient<HttpMessageHandlerBuilder, DefaultHttpMessageHandlerBuilder>(); 12: services.AddSingleton<DefaultHttpClientFactory>(); 13: services.TryAddSingleton<IHttpClientFactory>(serviceProvider => serviceProvider.GetRequiredService<DefaultHttpClientFactory>()); 14: services.TryAddSingleton<IHttpMessageHandlerFactory>(serviceProvider => serviceProvider.GetRequiredService<DefaultHttpClientFactory>());
  15:      
  16:      services.TryAdd(ServiceDescriptor.Transient(typeof(ITypedHttpClientFactory<>), typeof(DefaultTypedHttpClientFactory<>)));
  17:      services.TryAdd(ServiceDescriptor.Transient(typeof(DefaultTypedHttpClientFactory<>.Cache), typeof(DefaultTypedHttpClientFactory<>.Cache)));
  18:      
  19:      services.TryAddEnumerable(ServiceDescriptor.Singleton<IHttpMessageHandlerBuilderFilter, LoggingHttpMessageHandlerBuilderFilter>());
  20:   
  21:      return services;
  22:  }

DefaultHttpClientFactory

DefaultHttpClientFactory是一个用internal修饰的类,意味着该类只能在在其内部使用。它继承了IHttpClientFactory、IHttpMessageHandlerFactory这两个接口。由此可见,DefaultHttpClientFactory实例的创建被拆成了两种行为。

IHttpClientFactory的定位是一个抽象工厂,可以为指定名称的HttpClient实例创建自定义配置,它只有一个方法,HttpClient CreateClient(string name)。

IHttpMessageHandlerFactory的定位也是一个抽象工厂,它为指定名称的HttpMessageHandler实例创建自定义配置,它只有一个方法,HttpMessageHandler CreateHandler(string name)。

我们先看一下这两个方法的实现,会觉得很有意思

   1:  public HttpClient CreateClient(string name)
   2:  {
   3:      if (name == null)
   4:      {
   5:          throw new ArgumentNullException(nameof(name));
   6:      }
   7:   
   8:      var handler = CreateHandler(name);
   9:      var client = new HttpClient(handler, disposeHandler: false);
  10:   
  11:      var options = _optionsMonitor.Get(name);
  12:      for (var i = 0; i < options.HttpClientActions.Count; i++)
  13:      {
  14:          options.HttpClientActions[i](client);
  15:      }
  16:   
  17:      return client;
  18:  }
  19:   
  20:  public HttpMessageHandler CreateHandler(string name)
  21:  {
  22:      if (name == null)
  23:      {
  24:          throw new ArgumentNullException(nameof(name));
  25:      }
  26:   
  27:      var entry = _activeHandlers.GetOrAdd(name, _entryFactory).Value;
  28:   
  29:      StartHandlerEntryTimer(entry);
  30:   
  31:      return entry.Handler;
  32:  }

可以看到,我们通过名称查找HttpClient对象的时候,也会依照该名称以GetOrAdd方式去查找相应的HttpMessageHandler对象,也就说HttpClient对象和HttpMessageHandler对象可以通过名称关联起来。

需要注意的时候在调用CreateHandler方法的时候会调用StartHandlerEntryTimer方法,这个方法是干嘛的呢,他维护着定时器。该方法位于Microsoft.Extensions.Http.ActiveHandlerTrackingEntry中,我们将此类视为是一个不可变的(当然,其内部的定时器是变化的),为“到期”池创建一个可以显著简化线程需求的新对象。

除了这两个方法外,我们要需要注意DefaultHttpClientFactory对HttpMessageHandler的管理功能。DefaultHttpClientFactory内部维护者一个定时器和两个HttpMessageHandler对象集合,这两个集合分别是ActiveHandler和ExpiredHandler。内部定时器会定期从ExpiredHandler集合中扫描并清理无效的 HttpMessageHandler对象。

ActiveHandler集合的增加是在调用CreateHandler方法时增加的,其移除是在回调的时候移除,这个移除入口也只有这一处。

ExpiredHandler集合的增加也是在调用CreateHandler方法时,通过内部的一个回调机制增加的,其移除通过定时器定期扫描来实现的。这处需要注意的是,ExpiredHandlerTrackingEntry这个类中有一个属性,代码如下:

   1:  private readonly WeakReference _livenessTracker;
   1:  public bool CanDispose => !_livenessTracker.IsAlive;

通过WeakReference 类型的变量来标识该HttpMessageHandler对象是否应该被从集合中移除。

定时器一般是个比较消耗资源,而且一旦用不好,就会引发线程问题,DefaultHttpClientFactory在处理定时器的时候,首先通过停止所有挂起的计时器,在清除后如果还需要继续处理无效HttpMessageHandler对象,将会重新启动计时器,虽然看似多余了点,但是比通过锁定整个清理机制来确定是否阻塞清理任何并启动定时器要好多了。

   1:  internal void CleanupTimer_Tick()
   2:  {
   3:      StopCleanupTimer();
   4:   
   5:      if (!Monitor.TryEnter(_cleanupActiveLock))
   6:      {
   7:          StartCleanupTimer();
   8:          return;
   9:      }
  10:   
  11:      try
  12:      {
  13:          var initialCount = _expiredHandlers.Count;
  14:          Log.CleanupCycleStart(_logger, initialCount);
  17:   
  18:          var disposedCount = 0;
  19:          //开始清理
  20:   
  21:          Log.CleanupCycleEnd(_logger, stopwatch.GetElapsedTime(), disposedCount, _expiredHandlers.Count);
  22:      }
  23:      finally
  24:      {
  25:          Monitor.Exit(_cleanupActiveLock);
  26:      }
  27:   
  28:      if (_expiredHandlers.Count > 0)
  29:      {
  30:          StartCleanupTimer();
  31:      }
  32:  }

  以下为这两个队列的处理示意图:

timer

posted @ 2019-07-22 16:04 艾心❤ 阅读(...) 评论(...) 编辑 收藏