C# 中 IHttpClientFactory 的介绍和最佳实践#

在 .NET 应用程序中进行 HTTP 请求时，HttpClient 是最常用的类。然而，直接使用 HttpClient 可能会导致一些问题，如端口耗尽和 DNS 更新问题。IHttpClientFactory 是 .NET Core 2.1 引入的一个接口，旨在解决这些问题并提供更好的 HTTP 客户端管理。

1. 为什么需要 IHttpClientFactory？#

1.1 直接使用 HttpClient 的问题#

端口耗尽：每次创建新的 HttpClient 实例都会创建新的套接字连接，可能导致端口耗尽。
DNS 更新问题：HttpClient 默认会缓存 DNS 记录，即使 DNS 记录发生变化，也不会立即更新。
资源管理：需要手动管理 HttpClient 的生命周期，容易导致资源泄漏。

1.2 IHttpClientFactory 的优势#

集中管理：通过工厂模式集中管理 HttpClient 实例的创建和配置。
生命周期管理：自动管理底层 HttpMessageHandler 的生命周期，避免端口耗尽问题。
可配置性：支持命名客户端和类型化客户端，便于配置不同的 HTTP 客户端。
依赖注入友好：与 ASP.NET Core 的依赖注入系统无缝集成。
中间件支持：可以轻松添加日志、重试、熔断等中间件。

2. 配置 IHttpClientFactory#

2.1 在 ASP.NET Core 中配置#

在 Program.cs 或 Startup.cs 中添加服务：

1
// Program.cs (.NET 6+)
2
var builder = WebApplication.CreateBuilder(args);
3

4
// 添加 HttpClient 工厂服务
5
builder.Services.AddHttpClient();
6

7
var app = builder.Build();

2.2 在控制台应用中配置#

1
using Microsoft.Extensions.DependencyInjection;
2
using Microsoft.Extensions.Hosting;
3

4
var host = Host.CreateDefaultBuilder(args)
5
    .ConfigureServices((context, services) =>
6
    {
7
        services.AddHttpClient();
8
    })
9
    .Build();

3. 使用 IHttpClientFactory#

3.1 基本用法#

通过依赖注入 IHttpClientFactory 并创建客户端：

1
public class MyService
2
{
3
    private readonly IHttpClientFactory _httpClientFactory;
4

5
    public MyService(IHttpClientFactory httpClientFactory)
6
    {
7
        _httpClientFactory = httpClientFactory;
8
    }
9

10
    public async Task<string> GetDataAsync()
11
    {
12
        var client = _httpClientFactory.CreateClient();
13
        var response = await client.GetAsync("https://api.example.com/data");
14
        response.EnsureSuccessStatusCode();
15
        return await response.Content.ReadAsStringAsync();
16
    }
17
}

3.2 命名客户端#

为不同的服务配置不同的客户端：

1
// 配置服务
2
builder.Services.AddHttpClient("GitHub", client =>
3
{
4
    client.BaseAddress = new Uri("https://api.github.com/");
5
    client.DefaultRequestHeaders.Add("Accept", "application/vnd.github.v3+json");
6
    client.DefaultRequestHeaders.Add("User-Agent", "HttpClientFactory-Sample");
7
});
8

9
// 使用命名客户端
10
public class GitHubService
11
{
12
    private readonly IHttpClientFactory _httpClientFactory;
13

14
    public GitHubService(IHttpClientFactory httpClientFactory)
15
    {
16
        _httpClientFactory = httpClientFactory;
17
    }
18

19
    public async Task<string> GetRepositoriesAsync()
20
    {
21
        var client = _httpClientFactory.CreateClient("GitHub");
22
        var response = await client.GetAsync("repositories");
23
        response.EnsureSuccessStatusCode();
24
        return await response.Content.ReadAsStringAsync();
25
    }
26
}

3.3 类型化客户端#

创建强类型的客户端类，这是推荐的方式：

1
// 定义类型化客户端
2
public class GitHubClient
3
{
4
    private readonly HttpClient _httpClient;
5

6
    public GitHubClient(HttpClient httpClient)
7
    {
8
        _httpClient = httpClient;
9
    }
10

11
    public async Task<List<Repository>> GetRepositoriesAsync()
12
    {
13
        var response = await _httpClient.GetAsync("repositories");
14
        response.EnsureSuccessStatusCode();
15
        var content = await response.Content.ReadAsStringAsync();
16
        return JsonSerializer.Deserialize<List<Repository>>(content);
17
    }
18
}
19

20
// 配置类型化客户端
21
builder.Services.AddHttpClient<GitHubClient>(client =>
22
{
23
    client.BaseAddress = new Uri("https://api.github.com/");
24
    client.DefaultRequestHeaders.Add("Accept", "application/vnd.github.v3+json");
25
    client.DefaultRequestHeaders.Add("User-Agent", "HttpClientFactory-Sample");
26
});
27

28
// 使用类型化客户端
29
public class MyController : ControllerBase
30
{
31
    private readonly GitHubClient _gitHubClient;
32

33
    public MyController(GitHubClient gitHubClient)
34
    {
35
        _gitHubClient = gitHubClient;
36
    }
37

38
    public async Task<IActionResult> GetRepositories()
39
    {
40
        var repositories = await _gitHubClient.GetRepositoriesAsync();
41
        return Ok(repositories);
42
    }
43
}

4. 最佳实践#

4.1 优先使用类型化客户端#

类型化客户端提供了以下优势：

强类型支持，编译时检查
代码更清晰，易于维护
可以封装业务逻辑

4.2 正确配置 HttpClient#

1
builder.Services.AddHttpClient<GitHubClient>(client =>
2
{
3
    // 设置合理的超时时间
4
    client.Timeout = TimeSpan.FromSeconds(30);
5

6
    // 设置基础地址
7
    client.BaseAddress = new Uri("https://api.github.com/");
8

9
    // 设置默认请求头
10
    client.DefaultRequestHeaders.Add("Accept", "application/vnd.github.v3+json");
11
    client.DefaultRequestHeaders.Add("User-Agent", "YourApp-Name");
12
});

4.2 避免反模式#

不要在每次请求时创建新的 HttpClient 实例
不要在 using 块中使用 HttpClient（除非使用 IHttpClientFactory）
不要手动管理 HttpClient 的生命周期

5. 高级配置#

5.1 自定义消息处理程序#

创建自定义的 DelegatingHandler：

1
public class LoggingHandler : DelegatingHandler
2
{
3
    private readonly ILogger<LoggingHandler> _logger;
4

5
    public LoggingHandler(ILogger<LoggingHandler> logger)
6
    {
7
        _logger = logger;
8
    }
9

10
    protected override async Task<HttpResponseMessage> SendAsync(
11
        HttpRequestMessage request, CancellationToken cancellationToken)
12
    {
13
        _logger.LogInformation($"Sending request to {request.RequestUri}");
14

15
        var response = await base.SendAsync(request, cancellationToken);
16

17
        _logger.LogInformation($"Response status: {response.StatusCode}");
18

19
        return response;
20
    }
21
}
22

23
// 注册处理程序
24
builder.Services.AddTransient<LoggingHandler>();
25

26
builder.Services.AddHttpClient<GitHubClient>(client =>
27
{
28
    client.BaseAddress = new Uri("https://api.github.com/");
29
})
30
.AddHttpMessageHandler<LoggingHandler>();

5.2 多个客户端配置#

为不同的服务配置不同的客户端：

1
// GitHub 客户端
2
builder.Services.AddHttpClient<GitHubClient>(client =>
3
{
4
    client.BaseAddress = new Uri("https://api.github.com/");
5
    client.DefaultRequestHeaders.Add("Accept", "application/vnd.github.v3+json");
6
});
7

8
// 其他 API 客户端
9
builder.Services.AddHttpClient<PaymentService>(client =>
10
{
11
    client.BaseAddress = new Uri("https://api.payment.com/");
12
    client.Timeout = TimeSpan.FromSeconds(60);
13
});

6. 总结#

IHttpClientFactory 是 .NET 中管理 HttpClient 的最佳方式，它解决了直接使用 HttpClient 的各种问题，并提供了以下优势：

资源管理：自动管理 HttpMessageHandler 的生命周期，避免端口耗尽
配置灵活性：支持命名客户端和类型化客户端
依赖注入集成：与 ASP.NET Core 的 DI 系统无缝集成
中间件支持：可以轻松添加日志、重试、熔断等中间件
最佳实践：遵循 Microsoft 推荐的 HTTP 客户端使用模式

在开发新的 .NET 应用程序时，强烈建议使用 IHttpClientFactory 而不是直接创建 HttpClient 实例。这不仅提高了应用程序的可靠性，还使代码更易于维护和测试。

C# 中 IHttpClientFactory 的介绍和最佳实践#

1. 为什么需要 IHttpClientFactory？#

1.1 直接使用 HttpClient 的问题#

1.2 IHttpClientFactory 的优势#

2. 配置 IHttpClientFactory#

2.1 在 ASP.NET Core 中配置#

2.2 在控制台应用中配置#

3. 使用 IHttpClientFactory#

3.1 基本用法#

3.2 命名客户端#

3.3 类型化客户端#

4. 最佳实践#

4.1 优先使用类型化客户端#

4.2 正确配置 HttpClient#

4.2 避免反模式#

5. 高级配置#

5.1 自定义消息处理程序#

5.2 多个客户端配置#

6. 总结#

参考资料#

支持与分享

评论区

音乐

文章目录

C# IHttpClientFactory

C# 中 IHttpClientFactory 的介绍和最佳实践#

1. 为什么需要 IHttpClientFactory？#

1.1 直接使用 HttpClient 的问题#

1.2 IHttpClientFactory 的优势#

2. 配置 IHttpClientFactory#

2.1 在 ASP.NET Core 中配置#

2.2 在控制台应用中配置#

3. 使用 IHttpClientFactory#

3.1 基本用法#

3.2 命名客户端#

3.3 类型化客户端#

4. 最佳实践#

4.1 优先使用类型化客户端#

4.2 正确配置 HttpClient#

4.2 避免反模式#

5. 高级配置#

5.1 自定义消息处理程序#

5.2 多个客户端配置#

6. 总结#

参考资料#

支持与分享

评论区

音乐

文章目录