asp.net core之HttpClient

本文介绍了ASP.NET Core中的HttpClient和HttpClientFactory的作用、用法以及最佳实践。通过示例代码的展示，读者可以了解如何使用HttpClient发送HTTP请求并处理响应，以及如何使用HttpClientFactory来解决HttpClient的一些问题，如资源泄漏和性能问题。同时，本文还强调了HttpClientFactory的优势，如更好的性能、资源管理和可配置性。通过深入理解和应用HttpClient和HttpClientFactory，开发人员可以更好地与外部服务进行通信。

HttpClient的基本用法

HttpClient是.NET框架中用于与Web服务进行通信的核心类之一。它提供了一组用于发送HTTP请求和处理响应的方法。使用HttpClient，我们可以轻松地发送GET、POST、PUT、DELETE等HTTP请求，并处理返回的响应。
示例代码：

using (HttpClient client = new HttpClient())
{
    HttpResponseMessage response = await client.GetAsync("https://www.baidu.com");
    response.EnsureSuccessStatusCode();
    string responseBody = await response.Content.ReadAsStringAsync();
    Console.WriteLine(responseBody);
}

在上面的示例中，我们首先创建了一个HttpClient实例，并使用GetAsync方法发送了一个GET请求。然后，我们通过EnsureSuccessStatusCode方法确保响应的状态码为成功状态。最后，我们通过ReadAsStringAsync方法读取响应的内容，并将其打印到控制台上。
需要注意的是，在使用完HttpClient后，我们使用using语句将其包裹起来。这样可以确保HttpClient在使用完毕后被正确地释放，以避免资源泄漏的问题。
然而，使用上述方式创建和使用HttpClient存在一些潜在的问题，如资源管理和性能方面的考虑。

HttpClientFactory的介绍

为了解决上述问题，ASP.NET Core引入了HttpClientFactory。HttpClientFactory是一个工厂类，用于创建和管理HttpClient实例。它提供了更好的性能、资源管理和可配置性。
HttpClientFactory的主要优势包括：

• 性能优化：HttpClientFactory通过重用和管理HttpClient实例来提高性能。它可以在多个请求之间共享HttpClient实例，减少了创建和销毁实例的开销。
• 资源管理：HttpClientFactory负责管理HttpClient实例的生命周期，并确保它们在不再使用时被正确地释放。这样可以避免资源泄漏的问题，并提高应用程序的可靠性和稳定性。
• 可配置性：HttpClientFactory可以根据需要进行配置，以满足不同的需求。它支持配置HttpClient的超时时间、缓冲区大小、重试策略等。

下面是使用HttpClientFactory发送GET请求并处理响应的示例代码：

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddHttpClient(); // HttpClientFactory
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseAuthorization();

app.MapControllers();

app.Run();

private readonly ILogger<WeatherForecastController> _logger;
private readonly IHttpClientFactory _httpClientFactory;

public WeatherForecastController(ILogger<WeatherForecastController> logger, IHttpClientFactory httpClientFactory)
{
    _logger = logger;
    _httpClientFactory = httpClientFactory;
}

[HttpGet("TestHttpClientFactory")]
public async Task TestHttpClientFactory()
{
    var httpClient = _httpClientFactory.CreateClient();
    HttpResponseMessage response = await httpClient.GetAsync("https://www.baidu.com");
    response.EnsureSuccessStatusCode();

    string responseBody = await response.Content.ReadAsStringAsync();
    Console.WriteLine(responseBody);
}

这里也可以选择直接注入HttpClient实例而不是IHttpClientFactory，效果是一样的。
需要注意的是，我们不再使用using语句来包裹HttpClient，而是通过依赖注入的方式获取HttpClient实例或IHttpClientFactory。这样HttpClient的生命周期将由HttpClientFactory管理，确保它在不再使用时被正确地释放。

HttpClientFactory的高级用法

除了基本用法之外，HttpClientFactory还提供了一些高级特性，以满足更复杂的需求。

命名HttpClient

在某些情况下，我们可能需要创建多个HttpClient实例来与不同的外部服务进行通信。为了区分它们，我们可以为每个HttpClient实例指定一个唯一的名称。
下面是使用命名HttpClient的示例代码：

builder.Services.AddHttpClient("ExampleClient", client =>
{
    client.BaseAddress = new Uri("https://www.baidu.com/");
});

[HttpGet("TestHttpClientFactory")]
public async Task TestHttpClientFactory()
{
    var httpClient = _httpClientFactory.CreateClient("ExampleClient");
    HttpResponseMessage response = await httpClient.GetAsync("");
    response.EnsureSuccessStatusCode();

    string responseBody = await response.Content.ReadAsStringAsync();
    Console.WriteLine(responseBody);
}

在上面的示例中，我们使用AddHttpClient方法的重载版本，并通过第一个参数指定HttpClient的名称。然后，我们可以在配置HttpClient的回调中进行相应的配置，如设置BaseAddress等。
这里我们通过IHttpClientFctory获取ExampleClient，直接调用Get请求，就是访问https://www.baidu.com。

Typed HttpClient

另一个常见的需求是根据不同的服务接口创建不同的HttpClient实例。为了实现这一点，ASP.NET Core提供了Typed HttpClient的支持。
下面是使用Typed HttpClient的示例代码：

public interface IExampleService
{
    Task<string> GetData();
}

public class ExampleService : IExampleService
{
    private readonly HttpClient _httpClient;

    public ExampleService(HttpClient httpClient)
    {
        _httpClient = httpClient;
    }

    public async Task<string> GetData()
    {
        HttpResponseMessage response = await _httpClient.GetAsync("");
        response.EnsureSuccessStatusCode();

        return await response.Content.ReadAsStringAsync();
    }
}

配置依赖注入：

builder.Services.AddHttpClient<IExampleService, ExampleService>(client =>
{
    client.BaseAddress = new Uri("https://www.baidu.com/");
});

在控制器中注入IExampleService：

private readonly ILogger<WeatherForecastController> _logger;
private readonly IHttpClientFactory _httpClientFactory;
private readonly IExampleService _exampleService;

public WeatherForecastController(ILogger<WeatherForecastController> logger, 
                                         IHttpClientFactory httpClientFactory, 
                                         IExampleService exampleService)
{
    _logger = logger;
    _httpClientFactory = httpClientFactory;
    _exampleService = exampleService;
}

在上面的示例中，我们首先定义了一个IExampleService接口，该接口定义了与外部服务交互的方法。然后，我们实现了ExampleService类，并在构造函数中注入了HttpClient实例。
最后，我们使用AddHttpClient方法的另一个重载版本，并通过泛型参数指定了服务接口和实现类的关联关系。在配置HttpClient的回调中，我们可以进行相应的配置，如设置BaseAddress等。

总结

本文介绍了ASP.NET Core中的HttpClient和HttpClientFactory的作用、用法以及最佳实践。通过示例代码的展示，读者可以了解如何使用HttpClient发送HTTP请求并处理响应，以及如何使用HttpClientFactory来解决HttpClient的一些问题，如资源泄漏和性能问题。同时，本文还强调了HttpClientFactory的优势，如更好的性能、资源管理和可配置性。
通过理解和应用HttpClient和HttpClientFactory，开发人员可以更好地与外部服务进行通信，并构建高性能、可靠的Web应用程序。

欢迎进群催更。