ASP.NET Core 2.1 中的 HttpClientFactory (Part 1) - HttpClientFactory介紹

原文：https://www.stevejgordon.co.uk/introduction-to-httpclientfactory-aspnetcore  
發表於：2018年1月

ASP.NET Core 2.1中將出現一個新的HttpClientFactory功能，它有助於解決開發人員在使用HttpClient實例時可能遇到的一些問題。

介紹

我從2017年11月中旬開始準備寫這篇文章，當時我第一次注意到有一個新的 HttpClientFactory 版本庫 出如今GitHub上。我對它的出現感到好奇，而且想知道 ASP.NET 團隊在作什麼，因此我深刻研究了當時存儲庫中的代碼。從那之後我一直留意這個問題，關注代碼更新、問題反饋和社區討論，看着開發團隊不斷完善其功能。

最近，該功能開始被更多的討論，而且由Damian Edwards和David Fowler在NDC倫敦舉行的一次演講中說起。事實上，在撰寫此介紹的那一天，它已經在Jeff Fritz的直播節目和ASP.NET Community Standup上展現。Ryan Nowak是該功能的主要開發人員之一，他認爲功能已足夠穩定，能夠向你們展現了。

注意：這篇文章是在.NET Core 2.1的官方預覽版以前使用ASP.NET Core 2.1和.NET Core SDK的每晚構建版本編寫的。所以，根據從這些預覽中收到的反饋，在公開預覽以前和期間（但願咱們將在下個月內得到這些內容）以及2.1的最終發佈以前，可能會發生變化。

什麼是 HttpClientFactory?

用ASP.NET團隊的話說，它是「一個用於建立HttpClient實例的自覺得是的工廠」，而且是ASP.NET Core 2.1發佈的新功能。根據您過去使用HttpClient的經驗，您可能遇到過一些陷阱，或者可能沒有意識到存在問題。

第一個問題是當你在代碼中建立太多的HttpClients時，這會帶來兩個負面問題：

1. 效率不高，由於每鏈接都有本身的遠程服務器鏈接池。這意味着您須要爲建立的每一個客戶端從新鏈接到該遠程服務器支付額外開銷。
2. 可能遇到的更大問題是，若是你在短期內建立了大量客戶端，可能會遇到Socket耗盡問題。在必定時間內可使用的Socket是有限制的。當你使用HttpClient打開鏈接以後，它會保持最長240秒的TIME_WAIT狀態（這期間來自遠程服務器的任何數據包仍然經過）。

HttpClient實現了IDisposable，一般開發人員在使用IDisposable對象時會在using塊中建立它，這樣能夠確保對象在使用完後被釋放掉。若是你想閱讀更多這方面的信息，ASP.NET Monsters在他們的文章「你正在錯誤的使用HttpClient，它使你的軟件失去穩定性」中有很好的敘述。

一般，首選方法是重用HttpClient實例，以即可以重用鏈接。 HttpClient是一個可變對象（mutable object），但只要你沒有改變它，它其實是線程安全的而且能夠共享。所以，常見的方法是經過DI框架註冊爲單例，或者爲其建立一個容器成爲靜態實例。

可是，這會產生新問題。這種方式並不遵照DNS生存時間（TTL）設置，鏈接將永遠不會得到DNS更新，您與之通訊的服務器永遠不會更新地址。

在某些狀況下，有可能使用多個主機（Hosts）作負載均，隨着時間的推移，一些主機會消失，一些主機新加入進來。若是主機消失，您的單例HttpClient鏈接的IP地址則不會響應您的請求。您能夠在「單例HttpClient?必須當心使用以及如何解決」和「單例HttpClient不聽從DNS更新」閱讀更多此類問題的信息。

HttpClientFactory被設計用來解決這些問題，並提供一種新的後臺機制，來管理和建立HttpClient實例。它會爲咱們作「該作的事情」，以便咱們能夠專一於其它事情。雖然，上面問題都指向HttpClient，但實際上問題的根源是在HttpClient使用的HttpClientHandler上。HttpClientFactory 用來管理Handlers的生命週期，以便咱們能夠重用池（pool），同時保證DNS不會過時。

使用HttpClient消耗最大的部分其實是建立HttpClientHandler和鏈接（Connection）。把它們放到池（pool）中是爲了在系統中更加高效的使用他們。當咱們是使用HttpClientFactory請求一個HttpClient時，實際上每次都會獲得一個新的實例，這意味這咱們不用擔憂會改變（mutating）它的狀態。HttpClient可能使用（也可能不使用）池（pool）中已有的HttpClientHandler來保持鏈接。

默認狀況下，每一個新的HttpClientHandler（派生自HttpMessageHandler）將以2分鐘的生命週期建立。在建立它的處理程序鏈（handler chain）時，能夠在每一個命名的客戶端上控制它。達到生命週期後，處理程序（handler）將不會當即被釋放，而是放入過時的池中。任何基於原始處理程序鏈（original handler chain）的客戶端均可以繼續使用它。有一個後臺做業檢查過時的池，以查看處理程序的全部引用是否已超出範圍，而後能夠將其處理掉。處理程序鏈（handler chain）過時後對新客戶端的任何新請求都將得到新的處理程序鏈。

這種方法可以很好的工做，但.NET Core還會更進一步。.NET Core團隊正在開發一個新的ManagedHandler，它能夠更好地管理DNS，原則上能夠保持更長時間，這意味着能夠更有效地共享鏈接。這個新的處理程序（handler）也被設計爲在不一樣的操做系統中更一致地運行。在該工做完成以前（可能在2.1時間範圍內），上面的處理程序池是一個合理的解決方法。

如何使用HttpClientFactory

重要說明：下面的功能和代碼示例須要SDK每晚構建版本以及.NET Core和ASP.NET Core庫，我不會介紹如何設置和使用它們。僅爲展現該功能如何工做，以便您能夠在2.1正式發佈時考慮是否使用它們。除非您今天迫切須要嘗試這一點，不然我建議您等到2.1預覽發佈，但願在下個月左右。

本節中，我將主要介紹HttpClientFactory的最基本用法。咱們將建立一個簡單的WebAPI項目，而後編輯csproj文件以將其升級爲使用新的.NET Core和ASP.NET Core 2.1。首先，咱們須要將其設置爲基於netcoreapp2.1（還沒有在官方預覽中），而後包含咱們須要的兩個包，咱們的項目文件以下所示：

<Project Sdk="Microsoft.NET.Sdk.Web">

  <PropertyGroup>
    <TargetFramework>netcoreapp2.1</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.AspNetCore.All" Version="2.1.0-preview1-28124" />
    <PackageReference Include="Microsoft.Extensions.Http" Version="2.1.0-preview1-28124" />
  </ItemGroup>
  
</Project>

接下來，咱們須要在Startup.cs註冊服務。 HttpClientFactory有多種ServiceCollection擴展方式。咱們使用其中的一種：

services.AddHttpClient();

這會註冊一些必需的服務，其中一個將是IHttpClientFactory的實現。接下來，咱們更新ValuesController以使用此功能：

[Route("api/[controller]")]
public class ValuesController : Controller
{
    private readonly IHttpClientFactory _httpClientFactory;

    public ValuesController(IHttpClientFactory httpClientFactory)
    {
        _httpClientFactory = httpClientFactory;
    }

    [HttpGet]
    public async Task<ActionResult> Get()
    {
        var client = _httpClientFactory.CreateClient();
        var result = await client.GetStringAsync("http://www.google.com");
        return Ok(result);
    }
}

這裏咱們首先添加對IHttpClientFactory的依賴，它將由DI系統注入咱們的控制器。 IHttpClientFactory容許咱們請求和接收HttpClient實例。

在咱們的Get操做中，咱們使用HttpClientFactory建立客戶端。在其內部，HttpClientFactory將爲咱們建立一個新的HttpClient。可是，以前我不是說過爲每一個請求建立新的HttpClient是很糟糕的嗎？但實際上這有點誤導。HttpClient自己並非真正的問題，而是用於實現HTTP調用的HttpClientHandler，這纔是實際問題。HttpClientHandler用來打開與外部服務的鏈接，這些鏈接將保持打開並阻止sockets，即便主HttpClient被釋放以後也是如此。

HttpClientFactory聚集這些HttpClientHandler實例並管理它們的生命週期，以解決我以前提到的一些問題。每次咱們請求HttpClient時，咱們都會獲得一個新實例，它可能（或可能不）使用現有的HttpClientHandler。HttpClient自己並不過重，因此這不要緊。

一旦建立，HttpClientHandlers就會被放置到池（pool）中，默認狀況下會保持約2分鐘。這意味着任何一個新的CreateClient請求均可以共享一個處理程序，所以也能夠共享鏈接。當HttpClient存在時，它的處理程序將保持可用，而且共享鏈接。

兩分鐘後，每一個HttpClientHandler都標記爲已過時。過時狀態只是標記，以便在建立任何新的HttpClient實例時再也不使用它們。可是，它們不會當即處理，由於其餘HttpClient實例可能正在使用它們。 HttpClientFactory使用後臺服務來監視過時的處理程序，一旦它們再也不被引用，就能夠正確處理它們，也容許它們關閉鏈接。

池（pooling）功能有助於下降socket耗盡的風險，其刷新機制能夠處理過長生命週期的HttpClientHandlers實例和掛起的鏈接，從而解決DNS更新問題。這是一個合理的折衷方案。

總結

本文就介紹到這裏。在之後的文章中，我將深刻探討一些HttpClientFactory的高級方法，由於有一些很好的功能值得展現。看看如何經過配置建立命名的HttpClient實例，以及建立本身的類型化客戶端。這是該功能真正的亮點。但願您已經瞭解在這個基本示例中，它是如何以最正確和有效的方式處理HTTP調用來知足咱們的用例。咱們不須要考慮如何管理客戶端的生命週期或擔憂遇到DNS問題。我但願在ASP.NET Core 2.1正式發佈後，這些功能可以應用到生產環境中去。