用HttpClientFactory來實現簡單的熔斷降級

前言

在2.1以後，有很多新東西，其中HttpClientFactory算是一個。HttpClientFactory涉及的東西也不算少，三四種clients , 請求中間件，與Polly的結合，生命週期等。

Steeltoe的組件升級到2.1後，很多示例代碼已經使用HttpClientFactory了。固然這是個題外話。

這裏主要講的是與Polly的結合，來完成簡單的熔斷降級。在這以前，仍是先看看關於HttpClientFactory最簡單的用法。

HttpClientFactory的簡單使用

用個簡單的控制檯程序來演示

這裏就只是獲取一下狀態碼，沒有獲取實際的內容。

static async Task<string> BasicUsage()
{
    var serviceCollection = new ServiceCollection();
    serviceCollection.AddHttpClient();
    var services = serviceCollection.BuildServiceProvider();
    var clientFactory = services.GetService<IHttpClientFactory>();

    var client = clientFactory.CreateClient();
    var request = new HttpRequestMessage(HttpMethod.Get, "https://www.github.com");

    var response = await client.SendAsync(request).ConfigureAwait(false);

    return response.StatusCode.ToString();
}

其實主要的操做就是AddHttpClient，而後經過HttpClientFactory建立一個HttpClient對象，有了HttpClient對象，下面的操做應該就不用多說了。

而後在Main方法調用

Console.WriteLine($"BasicUsage, StatusCode = {BasicUsage().GetAwaiter().GetResult()}");

用法感受並無太多的差異。下面來看看與Polly的結合。

HttpClientFactory和Polly的結合

Polly的wiki頁面已經有了這二者結合使用的文檔了。

https://github.com/App-vNext/Polly/wiki/Polly-and-HttpClientFactory

其實如今對於咱們來講，要想對http請求使用Polly的一些特性已經很是的簡單了。

咱們在使用的時候要添加Microsoft.Extensions.Http.Polly的Nuget包。

先來看看使用Polly的三種擴展方法

擴展方法	說明
AddTransientHttpErrorPolicy	主要是處理Http請求的錯誤，如HTTP 5XX 的狀態碼，HTTP 408 的狀態碼 以及System.Net.Http.HttpRequestException異常。
AddPolicyHandler	自定義，和傳統定義Polly的方式保持一致
AddPolicyHandlerFromRegistry	從Policy集合(也是自定義的)裏面選擇本身想要的。

後面的操做，是用的AddPolicyHandler。

因爲咱們要實現熔斷降級，因此，咱們必不可少的要用到CircuitBreakerPolicy和FallbackPolicy，同時爲了方便演示，再加個TimeoutPolicy。

因爲涉及到多個Policy，因此咱們必需要肯定他們的執行順序！

Polly的wiki頁面有個示例，還配了一幅很詳細的時序圖。

一句話來講就是最早起做用的，仍是最後添加的那個。

下面就新建一個API項目，用來演示一下。

修改ConfigureServices方法，具體以下

public void ConfigureServices(IServiceCollection services)
{
    var fallbackResponse = new HttpResponseMessage();
    fallbackResponse.Content = new StringContent("fallback");
    fallbackResponse.StatusCode = System.Net.HttpStatusCode.TooManyRequests;

    services.AddHttpClient("cb", x =>
    {
        x.BaseAddress = new Uri("http://localhost:8000");
        x.DefaultRequestHeaders.Add("User-Agent", "HttpClientFactory-Test");
    })
    //fallback
    .AddPolicyHandler(Policy<HttpResponseMessage>.Handle<Exception>().FallbackAsync(fallbackResponse, async b =>
    {
        Logger.LogWarning($"fallback here {b.Exception.Message}");
    }))
    //circuit breaker
    .AddPolicyHandler(Policy<HttpResponseMessage>.Handle<Exception>().CircuitBreakerAsync(2, TimeSpan.FromSeconds(4), (ex, ts) =>
    {
        Logger.LogWarning($"break here {ts.TotalMilliseconds}");
    }, () =>
    {                
        Logger.LogWarning($"reset here ");
    }))
    //timeout
    .AddPolicyHandler(Policy.TimeoutAsync<HttpResponseMessage>(1));
     
    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
}

而後是在控制器去使用。

[Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
    private static int myCount = 0;

    private readonly IHttpClientFactory _clientFactory;

    public ValuesController(IHttpClientFactory clientFactory)
    {
        this._clientFactory = clientFactory;
    }

    // GET api/values/timeout
    [HttpGet("timeout")]
    public ActionResult<IEnumerable<string>> Timeout()
    {
        if (myCount < 3)//模擬超時
        {
            System.Threading.Thread.Sleep(3000);
        }
        myCount++;

        return new string[] { "value1", "value2" };
    }

    // GET api/values
    [HttpGet("")]
    public async Task<string> GetAsync()
    {
        var client = _clientFactory.CreateClient("cb");
        
        var request = new HttpRequestMessage(HttpMethod.Get, "/api/values/timeout");
        var response = await client.SendAsync(request);
        var content = await response.Content.ReadAsStringAsync();

        return content;
    }
}

效果以下

前面幾回請求，會由於超時或熔斷，從而咱們獲得的結果是fallback。

過了4秒鐘後再請求，因爲沒有超時，正常拿到告終果，因此熔斷器會被reset。

來看看日誌

比較清晰的看到了全部的操做。

總結

整體來講，HttpClientFactory仍是很不錯的。尤爲是它能夠直接使用Polly相關的特性。

部分示例代碼： HttpClientFactoryDemo