ASP.NET Core 2.1 中的 HttpClientFactory (Part 4) 整合Polly實現瞬時故障處理

原文：https://www.stevejgordon.co.uk/httpclientfactory-using-polly-for-transient-fault-handling發表於：2018年6月原文：https://www.stevejgordon.co.uk/httpclientfa ...

原文：https://www.stevejgordon.co.uk/httpclientfactory-using-polly-for-transient-fault-handling
發表於：2018年6月

在本系列的上一篇文章中，我介紹了使用命名和類型客戶端註冊的DelegatingHandlers的傳出中間件的概念。儘管可以使用該方法，但ASP.NET團隊希望在大多數情況下，我們無需手動構建自己的處理程式。在某些情況下，庫的內置功能可能會提供我們需要的功能。例如，有時將請求包裝在時序代碼中以跟蹤它們執行所需的時間有時會很有用。現在，它已作為預設日誌記錄的一部分內置到IHttpClientFactory中。在其他情況下，第三方集成可能會提供您所需的功能。例如，基於橫切麵的思想，在HTTP請求期間處理瞬態故障。在這種情況下，與其製作自己的重試邏輯，不如使用Polly之類的庫。
Polly是一個流行的瞬態故障處理庫，它提供了一種機制來定義在發生某些故障時可以應用的策略。重試策略是最常用的策略之一。您可以封裝一些代碼，如果發生故障，將重試這些代碼，有時需要多次重試。這在您的應用程式需要與外部服務進行通信的情況下非常有用。通過HTTP之類的傳輸工具與服務進行通信時，始終存在瞬態故障的風險。暫時性故障可能會阻止您的請求完成，但也可能是暫時的問題。在這種情況下，使用重試是明智的選擇。
除重試外，Polly還提供了許多其他類型的策略，您可能希望將其中許多策略與重試結合使用，以建立處理故障的複雜方法。我將在本文中介紹一些常見的示例，但是如果您想更全面地介紹，我建議您查看Polly Wiki。
ASP.NET團隊與Polly的主要維護者Dylan和Joel緊密合作，加入了一種集成模式，以使將Polly策略應用於HttpClient實例變得非常簡單。
在使用Polly集成之前，我們需要為項目添加一個包引用。 IHttpClientFactory的常規功能位於Microsoft.Extensions.Http包中，該包作為依賴項包含在Microsoft.AspNetCore.App 2.1元包中。這是ASP.NET Core 2.1中新的元數據包，其中不包含第三方依賴項。因此，為了對IHttpClientFactory使用Polly擴展，我們需要將Microsoft.Extensions.Http.Polly包添加到我們的項目中。
完成之後，csproj文件將如下所示：

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

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

  <ItemGroup>
    <PackageReference Include="Microsoft.AspNetCore.App" />
    <PackageReference Include="Microsoft.Extensions.Http.Polly" Version="2.1.0" />
  </ItemGroup>

</Project>

應用策略

Microsoft.Extensions.Http.Polly程式包在IHttpClientBuilder上包含一個名為AddPolicyHandler的擴展方法，我們可以使用該方法添加一個處理程式，該處理程式會將使用該客戶端實例的所有請求包裝在Polly策略中。當我們定義一個命名或類型的客戶端時，將返回IHttpClientBuilder。
我們可以在ConfigureServices方法中使用擴展方法…

services.AddHttpClient("github")
  .AddPolicyHandler(Policy.TimeoutAsync<HttpResponseMessage>(TimeSpan.FromSeconds(10)));

　　在此示例中，我們定義了一個名為“ github”的客戶端，並且使用了AddPolicyHandler方法來傳遞超時策略。您在此處提供的策略必須是IAsyncPolicy <HttpResponseMessage>。此政策將在10秒後使所有請求超時。

重用策略

在可能的情況下，使用Polly時，最好一次性的定義策略併在應用相同策略的情況下共用它們。這樣，要更改策略規則，這些更改僅需要在一個地方進行。此外，它確保僅分配策略一次。當然，如果多個調用者希望通過同一斷路器實例運行，則必須共用諸如斷路器之類的策略。
在此示例中，我們將從上一個示例中聲明一次超時策略，並與兩個命名的客戶端共用該策略。

var timeoutPolicy = Policy.TimeoutAsync<HttpResponseMessage>(TimeSpan.FromSeconds(10));

services.AddHttpClient("github")
  .AddPolicyHandler(timeoutPolicy);

services.AddHttpClient("google")
  .AddPolicyHandler(timeoutPolicy);

　　我們將在本文後面介紹另一種策略重用的選項，使用PolicyRegistry。

瞬時故障處理

在處理HTTP請求時，我們要處理的最常見情況是瞬時錯誤。由於這是一個常見的要求，因此Microsoft.Extensions.Http.Polly軟體包包括一個特定的擴展名，我們可以使用該擴展名快速設置處理瞬態故障的策略。
例如，要在命名客戶端的請求發生瞬時故障時添加基本重試，我們可以按以下方式註冊重試策略：

services.AddHttpClient("github")
  .AddTransientHttpErrorPolicy(p => p.RetryAsync(3));

在這種情況下，當滿足某些失敗條件時，將重試通過客戶端發出的所有請求。 AddTransientHttpErrorPolicy方法採用Func <PolicyBuilder <HttpResponseMessage>，IAsyncPolicy <HttpResponseMessage >>。這裡的PolicyBuilder將被預先配置為處理HttpRequestExceptions，任何返回5xx狀態碼的響應以及任何帶有408（請求超時）狀態碼的響應。這應該適合許多情況。如果您要求該策略在其他條件下應用，則需要使用其他重載來傳遞更具體的策略。
眾所周知，重試時我們需要考慮冪等性。重試HTTP GET是一個非常安全的操作。如果我們撥打了電話但未收到任何回覆，則可以安全地重試該電話，而不會造成任何危險。但是，請考慮如果我們重試HTTP POST請求，可能會發生什麼。我們必須格外小心，因為有可能實際上收到了您的原始請求，但是我們收到的回覆提示失敗。在這種情況下，重試可能導致數據重覆或損壞下游系統中存儲的數據。在這裡，您需要更多地瞭解如果下游服務多次收到相同的請求，下游服務將如何處理。重試操作安全嗎？當您擁有下游服務時，更容易控制它。例如，您可能使用一些唯一的標識符來防止重覆的POST。
當您無法控制游系統或知道重覆的POST可能會帶來負面影響時，您將需要更仔細地控制策略。更合適的選擇可能是定義不同的命名/類型客戶端。您可以為沒有副作用與有副作用的請求分別創建一個客戶端。然後，您可以使用正確的客戶端來執行操作。但是，這可能會變得有點難以管理。更好的選擇是使用AddPolicyHandler的重載，該重載使我們可以訪問HttpRequestMessage，以便可以有條件地應用策略。該重載如下所示：
AddPolicyHandler(Func<HttpRequestMessage, IAsyncPolicy<HttpResponseMessage>> policySelector)
您會註意到，這裡的policySelector委托可以訪問HttpRequestMessage，並且應該返回IAsyncPolicy <HttpResponseMessage>。我們無法像前面的示例那樣訪問PolicyBuilder設置來處理瞬態故障。如果要處理常見的暫時性錯誤，則需要為我們的政策定義預期條件。為了使此操作更容易，Polly項目包含一個幫助程式擴展，我們可以使用它來設置一個PolicyBuilder，以處理常見的瞬時錯誤。要使用擴展方法，我們需要從Nuget添加Polly.Extensions.Http包。
然後，我們可以調用HttpPolicyExtensions.HandleTranisentHttpError（）來獲取配置有瞬態故障條件的PolicyBuilder。我們可以使用PolicyBuilder創建合適的重試策略，然後在請求為HTTP GET時有條件地應用該策略。在此示例中，任何其他HTTP方法都使用NoOp策略。

var retryPolicy = HttpPolicyExtensions
  .HandleTransientHttpError()
  .RetryAsync(3);

var noOp = Policy.NoOpAsync().AsAsyncPolicy<HttpResponseMessage>();

services.AddHttpClient("github")
  .AddPolicyHandler(request => request.Method == HttpMethod.Get ? retryPolicy : noOp);

使用PolicyRegistry

最後一個示例是如何通過策略註冊表（policy registry）應用策略的基本演示。為了支持策略重用，Polly提供了PolicyRegistry的概念，該概念實質上是策略的容器。可以在應用程式啟動時通過將策略添加到註冊表中來定義。然後可以將註冊表傳遞出去，並通過名稱訪問策略。

IHttpClientBuilder的擴展方法支持使用註冊表（registry）將基於Polly的處理程式添加到客戶端。

var registry = services.AddPolicyRegistry();

var timeout = Policy.TimeoutAsync<HttpResponseMessage>(TimeSpan.FromSeconds(10));
var longTimeout = Policy.TimeoutAsync<HttpResponseMessage>(TimeSpan.FromSeconds(30));

registry.Add("regular", timeout);
registry.Add("long", longTimeout);

services.AddHttpClient("github")
	.AddPolicyHandlerFromRegistry("regular");

　　首先，我們必須通過DI註冊一個PolicyRegistry。 Microsoft.Extensions.Http.Polly軟體包包括一些擴展方法，可簡化此過程。在上面的示例中，我調用了AddPolicyRegistry方法，該方法是IServiceCollection的擴展。這將創建一個新的PolicyRegistry並通過DI註冊，作為IPolicyRegistry <string>和IReadOnlyPolicyRegistry <string>的實現。該方法返回策略，以便我們可以向其添加策略。

在此示例中，我們添加了兩個超時策略併為其指定了名稱。現在，在註冊客戶端時，我們可以調用IHttpClientBuilder上可用的AddPolicyHandlerFromRegistry方法，使用的是策略名稱。當工廠創建命名客戶端實例時，它會添加適當的處理程式，並調用“regular”重試策略。

總結

作為Polly的老用戶，我很高興看到IHttpClientFactory添加了這些集成。這些庫整合在一起，能夠無縫處理瞬態故障，HttpClient實例非常容易啟動和運行。我展示的示例非常基礎和籠統，但我希望它們能為如何使用和註冊策略提供一個思路。有關Polly文檔和示例的更多詳細信息，建議您查看Polly Wiki。在設計這種集成時，與ASP.NET和Polly團隊進行的一些早期討論非常令人高興，因為我能夠提出策略註冊表擴展的有用性。