为IHttpClientFactory添加动态命名配置

某些时候365bet体育在线们需要为HttpClient动态配置一些东西, 例如证书等, 参考博问 如何使用IHttpClientFactory动态添加cer证书. 例如服务是一个回调服务, 而被回调方采用了自定义的https(即自定义证书).

上述是一些前情概要, 那么接下来365bet体育在线们就来实现这个需求.

秒想到一个方法, 365bet体育在线们可以直接new HttpClient(), 在每一365bet体育在线褂玫氖焙蚨贾苯永匆桓, 简单粗暴.
秒想到第二个方法, 又或者用一个Dictionary<string,HttpClient>根据名字缓存client对象.
但是前者性能是个问题,而且涉及到端口的占用释放问题, 在调用量稍大的情况下得凉凉, 后者则是有已知的问题HttpClient对象没法感知dns的变更.

其他一些更不靠谱的方法还有: 使用代码配置方式(services.AddHttpClient("callback provider side").ConfigurePrimaryHttpMessageHandler())配置所有证书, 还有把所有证书都安装的本机上并设置为信任证书.

那么能除了上面这些不靠谱的方式(或者说有致命缺陷的方式), 还有靠谱的么, 那当然是有的, 例如运行时的动态配置实现方案.

365bet体育在线, 接下来, 365bet体育在线来推荐 2 种方式式,就是365bet体育在线们的IHttpMessageHandlerBuilderFilterIPostConfigureOptions.

官方有什么推荐么?

针对如何为HttpClient对象添加证书, 官方文档的实现是:使用证书和来自 IHttpClientFactory 的命名 HttpClient 实现 HttpClient使用证书和 HttpClientHandler 实现 HttpClient, 但是在这里显然没法解决365bet体育在线们的运行时配置的需求, 但是它给出了一条线索, 那就是命名配置. 它可以为365bet体育在线们的每一个不同的provider提供自定义配置. 只要365bet体育在线们能为每一个不同的provider能提供运行时配置即可, 接下来就是源码阅读时间了:

下文中的所有代码都来自netcore 3.1, 并且仅copy关键代码, 完整代码可以前往github查看.

IHttpClientFactory.CreateClient是如何将HttpClient创建出来的?

  • 每次CreateClient出来的都是一个新的HttpClient实例
  • CreateHandler中的_activeHandlers将为365bet体育在线们缓存365bet体育在线们的handler, 默认是2分钟(定义在HttpClientFactoryOptions.HandlerLifetime)
    • 这里有一个知识点就是如果365bet体育在线的请求刚好在过期时间前一点点获取到这个缓存的对象,就是有可能365bet体育在线当前的请求还在进行中, 但是2分钟过去后这个handler就要被回收的. 那官方是如何替365bet体育在线们解决这个可能的bug的呢, 请查看文章Cleaning up expired handlers, 365bet体育在线就不赘述了, 关键点在于用了一个WeakReference
  • CreateHandlerEntry方法则是真正的创建以及配置365bet体育在线们的handlers的地方.
    • IConfiguration获得一个HttpClientFactoryOptions对象
    • 应用 IHttpMessageHandlerBuilderFilter
    • 应用 HttpMessageHandlerBuilderActions
//Microsoft.Extensions.Http.DefaultHttpClientFactory
public HttpClient CreateClient(string name)
{
	HttpClient httpClient = new HttpClient(this.CreateHandler(name), disposeHandler: false);
	return httpClient;
}
public HttpMessageHandler CreateHandler(string name)
{
	ActiveHandlerTrackingEntry value = this._activeHandlers.GetOrAdd(name, this._entryFactory).Value; 
        //_entryFactory可以直接理解为是CreateHandlerEntry方法.它真实的类型是Lazy<>(CreateHandlerEntry,LazyThreadSafetyMode.ExecutionAndPublication)的, 也就是并发安全的调用CreateHandlerEntry.
	return value.Handler;
}
internal ActiveHandlerTrackingEntry CreateHandlerEntry(string name)
{
        HttpClientFactoryOptions options = this._optionsMonitor.Get(name);
	HttpMessageHandlerBuilder requiredService = provider.GetRequiredService<HttpMessageHandlerBuilder>();
	requiredService.Name = name;
	Action<HttpMessageHandlerBuilder> action = Configure; // 扩展点二 HttpClientFactoryOptions.HttpMessageHandlerBuilderActions
	for (int num = this._filters.Length - 1; num >= 0; num--)
	{
		action = this._filters[num].Configure(action); //扩展点一 _filters(构造函数传入的IEnumerable<IHttpMessageHandlerBuilderFilter> filters).
	}
	action(requiredService);
	LifetimeTrackingHttpMessageHandler handler = new LifetimeTrackingHttpMessageHandler(requiredService.Build());
	return new ActiveHandlerTrackingEntry(name, handler, serviceScope, options.HandlerLifetime);

	void Configure(HttpMessageHandlerBuilder b)
	{
		for (int i = 0; i < options.HttpMessageHandlerBuilderActions.Count; i++)
		{
			options.HttpMessageHandlerBuilderActions[i](b);
		}
	}
}

关键点代码就是上面代码中标记出来的扩展点一扩展点二.

  • 扩展点一: 需要注入适当的IHttpMessageHandlerBuilderFilter对象,就可以改写requiredService对象, 也就可以实现365bet体育在线们要的运行时动态配置了.
  • 扩展点二: 需要实现自定义的IConfiguration配置, 只要this._optionsMonitor.Get(name)拿到的对象的HttpMessageHandlerBuilderActions属性包含365bet体育在线们相应的改写代码即可.

扩展点一的实现

为HttpClient的handler增加一个配置的filter, 针对符合的handlerBuilder增加一些自己的改写逻辑.
365bet体育在线们在用HttpClient对象的时候产生的日志("Sending HTTP request......","Received HTTP response headers after......")就是由这个Filter特性注入的. 官方参考代码:LoggingHttpMessageHandlerBuilderFilter

个人见解: 觉得在这个扩展点加这个业务不是特别的符合应用场景, 365bet体育在线365bet体育在线建议在扩展点二做这个事情.

class MyHttpClientHandlerFilter : IHttpMessageHandlerBuilderFilter
{
    public Action<HttpMessageHandlerBuilder> Configure(Action<HttpMessageHandlerBuilder> next)
    {
        void Configure(HttpMessageHandlerBuilder builder)
        {
            next(builder); //一开始就调用next, 这样365bet体育在线们的整个HandlerBuilder的执行顺序就是依次call _filters, 最后call options.HttpMessageHandlerBuilderActions(扩展点二).

            if (builder.Name.StartsWith("CallbackProviderSide-")) //365bet体育在线们可以为这类业务统一加一个前缀做区别, 这样就不会影响其他的HttpClient对象了.
            {
                //builder.PrimaryHandler= your custom handler. 参考官方文档的实现.
            }
        }
        return Configure;
    }
}
//然后在DI容器中注入365bet体育在线们的filter.
ServiceCollection.AddSingleton<IHttpMessageHandlerBuilderFilter,MyHttpClientHandlerFilter>();

扩展点二的实现

class MyHttpClientCustomConfigure : IPostConfigureOptions<HttpClientFactoryOptions>
{
    public void PostConfigure(string name, HttpClientFactoryOptions options)
    {
        if (name.StartsWith("CallbackProviderSide-")) //365bet体育在线们可以为这类业务统一加一个前缀做区别, 这样就不会影响其他的HttpClient对象了.
        {
            options.HttpMessageHandlerBuilderActions.Add(p =>
            {
                //p.PrimaryHandler= your custom handler. 参考官方文档的实现.
            });
        }
    }
}

//然后在DI容器中注入365bet体育在线们的这个配置扩展类.
ServiceCollection.AddSingleton<Microsoft.Extensions.Options.IPostConfigureOptions<Microsoft.Extensions.Http.HttpClientFactoryOptions>, MyHttpClientCustomConfigure>();

为什么这里注入的类型是Microsoft.Extensions.Options.IPostConfigureOptions<Microsoft.Extensions.Http.HttpClientFactoryOptions>, 是因为OptionsFactory它的构造函数需要的就是这个. 至于有关Configuration系统的扩展和源代码在这里就不在这里展开了.

使用

至于用它就简单了

var factory = ServiceProvider.GetService<IHttpClientFactory>();
var httpClientForBaidu = factory.CreateClient("CallbackProviderSide-baidu");
var httpClientForCnblogs = factory.CreateClient("CallbackProviderSide-Cnblogs");

总结一下

这样子, 365bet体育在线们的这个运行时动态配置HttpClient就算完成了, 365bet体育在线也轻轻松松又水了一篇文章.
另外,有关IHttpClientFactory背后的故事可以查看文章Exploring the code behind IHttpClientFactory in depth, 很完整的流程图在配上代码, 把它讲解的清清楚楚.

posted @ 2021-06-15 18:46  czd890  阅读(261)  评论(3编辑  收藏  举报