.NET 6.0中SDK内HttpClient实例化的最佳实践及简化集成

核心原则 #

绝对不要在SDK里直接用HttpClient client = new HttpClient();，这种写法会导致socket资源耗尽，违反官方最佳实践。正确的做法是依赖DI容器管理HttpClient的生命周期，但可以通过封装逻辑简化消费者的集成步骤。

简化集成的实现方案 #

在SDK内部封装HttpClient和SDK服务的注册逻辑，让消费者只需要调用一个扩展方法就能完成全部配置，无需分两步操作：

1. 在SDK中创建服务扩展类
   把HttpClient注册、SDK服务注册整合到同一个扩展方法里，同时开放自定义配置入口：

public static class ServiceCollectionExtensions
{
    public static IServiceCollection AddPublicApiSdk(this IServiceCollection services, Action<HttpClient> configureClient = null)
    {
        // 注册HttpClient并绑定SDK的客户端类
        var httpClientBuilder = services.AddHttpClient<IPublicApiClient, PublicApiClient>();

        // 允许消费者自定义HttpClient配置，无自定义时使用默认配置
        if (configureClient != null)
        {
            httpClientBuilder.ConfigureHttpClient(configureClient);
        }
        else
        {
            httpClientBuilder.ConfigureHttpClient(client =>
            {
                client.BaseAddress = new Uri("https://api.example.com/");
                client.Timeout = TimeSpan.FromSeconds(30);
            });
        }

        // 注册SDK的其他核心服务（按需添加）
        services.AddScoped<IPublicApiService, PublicApiService>();

        return services;
    }
}

2. SDK客户端类依赖注入HttpClient
   SDK的核心调用类通过构造函数接收DI容器提供的HttpClient：

public class PublicApiClient : IPublicApiClient
{
    private readonly HttpClient _httpClient;

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

    // 示例API调用方法
    public async Task<T> GetResourceAsync<T>(string endpoint)
    {
        return await _httpClient.GetFromJsonAsync<T>(endpoint);
    }
}

3. 消费者项目一键集成
   消费者只需在Program.cs中调用这个扩展方法，可选自定义配置：

builder.Services.AddPublicApiSdk(configureClient =>
{
    // 可选：覆盖默认的API地址、超时等配置
    configureClient.BaseAddress = new Uri("https://custom-api.example.com/");
});

扩展场景 #

如果SDK需要对接多个不同的API端点，可以在扩展方法中注册多个命名HttpClient，同样封装在同一方法内，让消费者无需手动处理多个注册步骤。

内容的提问来源于stack exchange，提问作者Roman