如何利用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
好了,以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对的支持。
下一篇:ASP.NET全栈开发教程之在MVC中使用服务端验证的方法