VSTO插件中HttpClient的正确使用方案咨询

一、实现跨插件实例的HttpClient复用 #

由于Outlook桌面插件每次重启都会生成新进程/实例，常规依赖注入的IHttpClientFactory无法跨实例共享，可通过以下两种方式实现复用：

1. 插件核心类静态存储HttpClient #

利用Outlook插件的ThisAddIn核心类（生命周期与插件进程一致），声明静态HttpClient变量，全局复用：

public partial class ThisAddIn
{
    public static HttpClient ApiClient { get; private set; }

    private void ThisAddIn_Startup(object sender, System.EventArgs e)
    {
        var socketHandler = new SocketsHttpHandler
        {
            PooledConnectionLifetime = TimeSpan.FromMinutes(5), // 定期回收旧连接
            PooledConnectionIdleTimeout = TimeSpan.FromMinutes(2)
        };
        ApiClient = new HttpClient(socketHandler)
        {
            BaseAddress = new Uri("https://your-api-domain.com"),
            Timeout = TimeSpan.FromSeconds(30)
        };
    }

    private void ThisAddIn_Shutdown(object sender, System.EventArgs e)
    {
        ApiClient?.CancelPendingRequests();
        ApiClient?.Dispose();
    }
}

插件其他组件中直接通过ThisAddIn.ApiClient调用，无需重复实例化。

2. 全局静态单例管理HttpClient #

通过静态类加锁机制，确保同一插件进程内仅生成一个HttpClient实例：

public static class HttpClientManager
{
    private static HttpClient _client;
    private static readonly object _lockObj = new object();

    public static HttpClient GetClient()
    {
        if (_client == null)
        {
            lock (_lockObj)
            {
                if (_client == null)
                {
                    var handler = new SocketsHttpHandler
                    {
                        PooledConnectionLifetime = TimeSpan.FromMinutes(5),
                        PooledConnectionIdleTimeout = TimeSpan.FromMinutes(2)
                    };
                    _client = new HttpClient(handler)
                    {
                        BaseAddress = new Uri("https://your-api-domain.com"),
                        Timeout = TimeSpan.FromSeconds(30)
                    };
                }
            }
        }
        return _client;
    }

    public static void DisposeClient()
    {
        _client?.CancelPendingRequests();
        _client?.Dispose();
        _client = null;
    }
}

插件关闭时调用HttpClientManager.DisposeClient()释放资源。

二、确保Socket正常关闭，避免后端超时 #

若无法实现复用，可通过以下配置优化Socket管理：

1. 显式释放响应资源 #

每次API调用用using包裹HttpResponseMessage，确保连接及时归还连接池：

using var response = await HttpClientManager.GetClient().PostAsync("/save-document", content);
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadAsStringAsync();

2. 配置SocketsHttpHandler连接策略 #

通过SocketsHttpHandler强制回收闲置连接，减少Socket占用：

var handler = new SocketsHttpHandler
{
    PooledConnectionLifetime = TimeSpan.FromMinutes(5), // 避免DNS缓存过期问题
    PooledConnectionIdleTimeout = TimeSpan.FromMinutes(2), // 闲置连接自动回收
    MaxConnectionsPerServer = 10, // 限制单服务器并发连接数
    AllowAutoRedirect = false // 禁用不必要的自动重定向
};

3. 插件关闭时主动清理 #

在插件关闭事件中，取消未完成请求并释放HttpClient：

private void Ribbon_Close(object sender, EventArgs e)
{
    HttpClientManager.DisposeClient();
}

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