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

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

原文：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時，這會帶來兩個負面問題：

效率不高，因為每連接都有自己的遠程伺服器連接池。這意味著您需要為創建的每個客戶端重新連接到該遠程伺服器支付額外開銷。
可能遇到的更大問題是，如果你在短時間內創建了大量客戶端，可能會遇到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正式發佈後，這些功能能夠應用到生產環境中去。