用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