在一个采用依赖注入框架的应用中,我们一般不太推荐利用手工创建的HttpClient
对象来进行HTTP调用,使用的HttpClient
对象最好利用注入的IHttpClientFactory
工厂来创建。前者引起的问题,以及后者带来的好处,将通过如下这几个演示程序展现出来。IHttpClientFactory
类型由“Microsoft.Extensions.Http
”这个NuGet包提供,“Microsoft.NET.Sdk.Web
”SDK具有该包的默认引用。如果采用“Microsoft.NET.Sdk
”这个SDK,需要添加该包的引用。
[S1201]频繁创建HttpClient
对象调用API
HttpClient
类型实现了IDisposable
接口,如果采用在每次调用时创建新的对象,那么按照我们理解的编程规范,调用结束之后就应该主动调用Dispose
方法及时地将其释放。如下的演示程序就采用了这种编程方式,我们启动了一个ASP.NET应用,它提供了一个返回“Hello World”的终结点。
using System.Diagnostics;
var app = WebApplication.Create(args);
app.MapGet("/", () => "Hello World!");
await app.StartAsync();
while (true)
{
using (var httpClient = new HttpClient())
{
try
{
var reply = await httpClient.GetStringAsync("http://localhost:5000");
Debug.Assert(reply == "Hello World!");
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
}
}
ASP.NET应用启动之后,我们在一个无限循环中对它发起调用。每次迭代的创建的HttpClient
对象会在完成调用之后被释放。当我们的程序运行之后,初始阶段都没有问题。当调用次数累积到一定规模之后,程序会大量地抛出HttpRequestExcetion
异常,并提示“Only one usage of each socket address (protocol/network address/port) is normally permitted
”。
图1频繁创建HttpClient
导致的异常
[S1202]以单例方式使用HttpClient
这个演示实例表明频繁创建HttpClient
对象是不可取的。如果我们需要自行创建HttpClient
对象并频繁地使用它们,应该尽可能地复用这个对象。如果将演示程序改写成如下的形式使用单例的HttpClient
对象就不会抛出上面这个异常,但是这又会带来一些额外的问题。HttpRequestExcetion
异常在前面的实例中为何会出现,后面的实例究竟又有哪些问题,我们将在后面回答这个问题。
using System.Diagnostics;
var app = WebApplication.Create(args);
app.MapGet("/", () => "Hello World!");
await app.StartAsync();
var httpClient = new HttpClient();
while (true)
{
try
{
var reply = await httpClient.GetStringAsync("http://localhost:5000");
Debug.Assert(reply == "Hello World!");
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
}
[S1203]利用IHttpClientFactory
工厂创建HttpClient
对象
引入IHttpClientFactory
工厂将会使一切变得简单,我们只需要在需要进行HTTP调用的时候利用这个工厂创建出对应的HttpClient
对象就可以了。虽然HttpClient
类型实现了IDisposable
接口,我们在完成了调用之后根本不需要去调用它的Dispose
方法。在下面的演示程序中,我们调用ServiceCollection
对象的AddHttpClient
扩展方法对IHttpClientFactory
工厂进行了注册,并利用构建出来的IServiceProvider
对象得到了这个对象。在每次进行HTTP调用的时候,我们利用这个IHttpClientFactory
工厂实时地将HttpClient
对象创建出来。
using System.Diagnostics;
var app = WebApplication.Create(args);
app.MapGet("/", () => "Hello World!");
await app.StartAsync();
var httpClientFactory = new ServiceCollection()
.AddHttpClient()
.BuildServiceProvider()
.GetRequiredService<IHttpClientFactory>();
while (true)
{
try
{
var reply = await httpClientFactory.CreateClient().GetStringAsync("http://localhost:5000");
Debug.Assert(reply == "Hello World!");
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
}
[S1204]直接注入HttpClient
对象
上面介绍的CreateClient
扩展方法还注册加针对HttpClient
类型的服务,所以HttpClient
对象可以直接作为注入的服务来使用。在如下所示的演示程序中,我们直接利用IServiceProvider
对象来创提供HttpClient
对象,它与上面演示的程序是等效的(S1204)。
using System.Diagnostics;
var app = WebApplication.Create(args);
app.MapGet("/", () => "Hello World!");
await app.StartAsync();
var serviceProvider = new ServiceCollection()
.AddHttpClient()
.BuildServiceProvider();
while (true)
{
try
{
var reply = await serviceProvider.GetRequiredService<HttpClient>().GetStringAsync("http://localhost:5000");
Debug.Assert(reply == "Hello World!");
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
}
[S1205]定制HttpClient
对象
调用IServiceCollection
接口的AddHttpClient
扩展方法进行服务注册的时候可以对HttpClient
作相应的定制,比如可以设置超时时间、默认请求报头和网络代理等。如果应用会涉及针对众多不同类型API的调用,调用不同的API可能需要采用不同的设置,比如局域网内部调用就比外部调用需要更小的超时设置。为了解决这个问题,我们对提供的设置赋予一个唯一的名称,在使用的时候针对这个标识提取对应的设置来创建HttpClient
对象,为了方便描述,我们将这个唯一标识HttpClient
设置的名称就称为HttpClient
的名称。在接下来演示的实例中,我们将设置两个HttpClient
来调用指向“www.foo.com
”和“www.bar.com
”这两个域名的API。为此我们需要在host文件中添加了如下的映射关系
127.0.0.1 www.foo.com
127.0.0.1 www.bar.com
在如下所示的演示实例中,我们为ASP.NET应用注册的终结点会返回包含请求的域名和路径。我们调用IServiceCollection
接口的AddHttpClient
方法注册了两个名称分别为“foo
”和“bar
”的HttpClient
,并对它们的基础地址进行针对性的设置(S1205)。
using System.Diagnostics;
var app = WebApplication.Create(args);
app.Urls.Add("http://0.0.0.0:80");
app.MapGet("/{path}" , (HttpRequest resquest, HttpResponse response) =>response.WriteAsync($"{resquest.Host}{resquest.Path}"));
await app.StartAsync();
var services = new ServiceCollection();
services.AddHttpClient("foo", httpClient => httpClient.BaseAddress = new Uri("http://www.foo.com"));
services.AddHttpClient("bar", httpClient => httpClient.BaseAddress = new Uri("http://www.bar.com"));
var httpClientFactory = services
.BuildServiceProvider()
.GetRequiredService<IHttpClientFactory>();
var reply = await httpClientFactory.CreateClient("foo").GetStringAsync("abc");
Debug.Assert(reply == "www.foo.com/abc");
reply = await httpClientFactory.CreateClient("bar").GetStringAsync("xyz");
Debug.Assert(reply == "www.bar.com/xyz");
我们将HttpClient
的注册名称作为参数调用IHttpClientFactory
工厂的Create
方法得到对应的HttpClient
对象。由于基础地址已经设置好了,所以在进行HTTP调用时只需要指定相对地址(“abc
”和“xyz
”)就可以了。
[S1206]强类型客户端
所谓“强类型客户端”指的针对具体场景自定义的用于调用指定API的类型,强类型客户端直接使用注入的HttpClient
进行HTTP调用。对于上一个实例的应用场景,我们就可以定义如下两个客户端类型FooClient
和BarClient
,并使用它们分别调用指向不同域名的API。如代码片段所示,我们直接在其构造函数中注入了HttpClient
对象,并在GetStringAsync
方法中使用它来完成最终的HTTP调用。
public class FooClient
{
private readonly HttpClient _httpClient;
public FooClient(HttpClient httpClient) => _httpClient = httpClient;
public Task<string> GetStringAsync(string path) => _httpClient.GetStringAsync(path);
}
public class BarClient
{
private readonly HttpClient _httpClient;
public BarClient(HttpClient httpClient) => _httpClient = httpClient;
public Task<string> GetStringAsync(string path) => _httpClient.GetStringAsync(path);
}
由于FooClient
和BarClient
对使用的HttpClient
具有不同的要求,所以我们采用如下的方式调用IServiceCollection
接口的AddHttpClient<TClient>
针对客户端类型对HttpClient
进行针对设置,具体设置的依然是基础地址。由于AddHttpClient<TClient>
扩展方法会将作为泛型参数的TClient
类型注册为服务,所以我们可以直接利用IServiceProvider
对象提取对应的客户端实例(S1206)。
using App;
using System.Diagnostics;
var app = WebApplication.Create(args);
app.Urls.Add("http://0.0.0.0:80");
app.MapGet("/{path}", (HttpRequest resquest, HttpResponse response)=> response.WriteAsync($"{resquest.Host}{resquest.Path}"));
await app.StartAsync();
var services = new ServiceCollection();
services.AddHttpClient<FooClient>("foo", httpClient=> httpClient.BaseAddress = new Uri("http://www.foo.com"));
services.AddHttpClient<BarClient>("bar", httpClient=> httpClient.BaseAddress = new Uri("http://www.bar.com"));
var serviceProvider = services.BuildServiceProvider();
var foo = serviceProvider.GetRequiredService<FooClient>();
var bar = serviceProvider.GetRequiredService<BarClient>();
var reply = await foo.GetStringAsync("abc");
Debug.Assert(reply == "www.foo.com/abc");
reply = await bar.GetStringAsync("xyz");
Debug.Assert(reply == "www.bar.com/xyz");
[S1207]基于Polly
的失败重试
在任何环境下都不可能确保次HTTP调用都能成功,所以在失败重试是很有必要的。失败重试是要讲究策略的,返回何种响应状态才需要重试?重试多少次?时间间隔多长?一提到策略化自动重试,大多数人会想到Polly
这个开源框架,“Microsoft.Extensions.Http.Polly
”这个NuGet
包提供了IHttpClientFactory
工厂和Polly
的整合。在添加了这个包引用之后,我们将演示程序做了如下的修改。如代码片段所示,我们注册的终结点接收到的每三个请求只有一个会返回状态码为200的响应,其余两个响应码均为500。如果客户端能够确保失败后至少进行两次重试,那么就能保证客户端调用100%成功(S1207)。
using Polly;
using Polly.Extensions.Http;
using System.Diagnostics;
var app = WebApplication.Create(args);
var counter = 0;
app.MapGet("/", (HttpResponse response) => response.StatusCode = counter++ % 3 == 0 ? 200 : 500);
await app.StartAsync();
var services = new ServiceCollection();
services
.AddHttpClient(string.Empty)
.AddPolicyHandler(HttpPolicyExtensions.HandleTransientHttpError().WaitAndRetryAsync(2, _ => TimeSpan.FromSeconds(1)));
var httpClientFactory = services
.BuildServiceProvider()
.GetRequiredService<IHttpClientFactory>();
while (true)
{
var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:5000");
var response = await httpClientFactory.CreateClient().SendAsync(request);
Debug.Assert(response.IsSuccessStatusCode);
}
如上面的代码片段所示,调用AddHttpClient
扩展方法注册了一个默认匿名HttpClient
(名称采用空字符串)之后,我们接着调用返回的IHttpClientBuilder
对象的AddPolicyHandler
扩展方法设置了失败重试策略。AddPolicyHandler
方法的参数类型为IAsyncPolicy<HttpResponseMessage>
的参数,我们利用HttpPolicyExtensions
类型的HandleTransientHttpError
静态方法创建一个用来处理偶发错误(比如HttpRequestException
异常和5XX/408响应)的PolicyBuilder<HttpResponseMessage>
对象。我们最终调用该对象的WaitAndRetryAsync
方法返回所需的IAsyncPolicy<HttpResponseMessage>
对象,并通过参数设置了重试次数(两次)和每次重试时间间隔(1秒)。
在利用代表依赖注入容器的IServiceProvider
对象得到IHttpClientFactory
之后,我们在一个无限循环中利用它创建的HttpClient
对本地承载的API发起调用,虽然服务端每三次调用只有一次是成功的,但是2次重试足以确保最终的调用是成功的,我们提供的调试断言证实了这一点。