asp.net core為ihttpclientfactory添加動(dòng)態(tài)命名配置

比如如何使用ihttpclientfactory動(dòng)態(tài)添加cer證書(shū)

有三種方法推薦方法

• 方法一: 推薦的做法是這樣子
  

services.addhttpclient("a業(yè)務(wù)").configureprimaryhttpmessagehandler(...a業(yè)務(wù)證書(shū))
services.addhttpclient("b業(yè)務(wù)").configureprimaryhttpmessagehandler(...b業(yè)務(wù)證書(shū))
serviceprovider.getservice<ihttpclientfactory>().createclient("a業(yè)務(wù)")....

• 方法二:
  

如果你要完全自定義則可以用 new system.net.http.httpclient(handler)

• 方法三:
  

在或者用騷操作, 替換配置的方式也可以 邏輯就是實(shí)現(xiàn)一個(gè)自己的httpclientfactoryoptions, 然后動(dòng)態(tài)生成它.
get_cert_handler_by_name 是你自己的方法,可以根據(jù)任何是否使用區(qū)別業(yè)務(wù)名稱(chēng)a,b,c new 一個(gè)handler.
但是要注意, 這樣子所有從serviceprovider獲取httpclient都會(huì)走到這個(gè)自定義配置類(lèi)上面, 要做好兼容性.

class myclass : ipostconfigureoptions<httpclientfactoryoptions>
      {
          public void postconfigure(string name, httpclientfactoryoptions options)
              => options.httpmessagehandlerbuilderactions.add(p => p.primaryhandler = get_cert_handler_by_name(name));
      }
//注冊(cè)這個(gè)服務(wù)
services.addsingleton<microsoft.extensions.options.ipostconfigureoptions<microsoft.extensions.http.httpclientfactoryoptions>, myclass>();

上述是一些前情概要, 那么接下來(lái)我們就來(lái)實(shí)現(xiàn)這個(gè)需求.

秒想到一個(gè)方法, 我們可以直接new httpclient(), 在每一次要使用的時(shí)候都直接來(lái)一個(gè), 簡(jiǎn)單粗暴.
秒想到第二個(gè)方法, 又或者用一個(gè)dictionary<string,httpclient>根據(jù)名字緩存client對(duì)象.
但是前者性能是個(gè)問(wèn)題,而且涉及到端口的占用釋放問(wèn)題, 在調(diào)用量稍大的情況下得涼涼, 后者則是有已知的問(wèn)題httpclient對(duì)象沒(méi)法感知dns的變更.

其他一些更不靠譜的方法還有: 使用代碼配置方式(services.addhttpclient("callback provider side").configureprimaryhttpmessagehandler())配置所有證書(shū), 還有把所有證書(shū)都安裝的本機(jī)上并設(shè)置為信任證書(shū).

那么能除了上面這些不靠譜的方式(或者說(shuō)有致命缺陷的方式), 還有靠譜的么, 那當(dāng)然是有的, 例如運(yùn)行時(shí)的動(dòng)態(tài)配置實(shí)現(xiàn)方案.

所以, 接下來(lái), 我來(lái)推薦 2 種方式式,就是我們的ihttpmessagehandlerbuilderfilter和ipostconfigureoptions.

官方有什么推薦么?

針對(duì)如何為httpclient對(duì)象添加證書(shū), 官方文檔的實(shí)現(xiàn)是:使用證書(shū)和來(lái)自 ihttpclientfactory 的命名 httpclient 實(shí)現(xiàn) httpclient 和 使用證書(shū)和 httpclienthandler 實(shí)現(xiàn) httpclient, 但是在這里顯然沒(méi)法解決我們的運(yùn)行時(shí)配置的需求, 但是它給出了一條線索, 那就是命名配置. 它可以為我們的每一個(gè)不同的provider提供自定義配置. 只要我們能為每一個(gè)不同的provider能提供運(yùn)行時(shí)配置即可, 接下來(lái)就是源碼閱讀時(shí)間了:

下文中的所有代碼都來(lái)自netcore 3.1, 并且僅copy關(guān)鍵代碼, 完整代碼可以前往github查看.

ihttpclientfactory.createclient是如何將httpclient創(chuàng)建出來(lái)的?

• 每次createclient出來(lái)的都是一個(gè)新的httpclient實(shí)例
• 在createhandler中的_activehandlers將為我們緩存我們的handler, 默認(rèn)是2分鐘(定義在httpclientfactoryoptions.handlerlifetime)
  • 這里有一個(gè)知識(shí)點(diǎn)就是如果我的請(qǐng)求剛好在過(guò)期時(shí)間前一點(diǎn)點(diǎn)獲取到這個(gè)緩存的對(duì)象,就是有可能我當(dāng)前的請(qǐng)求還在進(jìn)行中, 但是2分鐘過(guò)去后這個(gè)handler就要被回收的. 那官方是如何替我們解決這個(gè)可能的bug的呢, 請(qǐng)查看文章cleaning up expired handlers, 我就不贅述了, 關(guān)鍵點(diǎn)在于用了一個(gè)weakreference
• createhandlerentry方法則是真正的創(chuàng)建以及配置我們的handlers的地方.
  • 從iconfiguration獲得一個(gè)httpclientfactoryoptions對(duì)象
  • 應(yīng)用 ihttpmessagehandlerbuilderfilter
  • 應(yīng)用 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方法.它真實(shí)的類(lèi)型是lazy<>(createhandlerentry,lazythreadsafetymode.executionandpublication)的, 也就是并發(fā)安全的調(diào)用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; // 擴(kuò)展點(diǎn)二 httpclientfactoryoptions.httpmessagehandlerbuilderactions
	for (int num = this._filters.length - 1; num >= 0; num--)
	{
		action = this._filters[num].configure(action); //擴(kuò)展點(diǎn)一 _filters(構(gòu)造函數(shù)傳入的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);
		}
	}
}

關(guān)鍵點(diǎn)代碼就是上面代碼中標(biāo)記出來(lái)的擴(kuò)展點(diǎn)一 和 擴(kuò)展點(diǎn)二.

• 擴(kuò)展點(diǎn)一: 需要注入適當(dāng)?shù)膇httpmessagehandlerbuilderfilter對(duì)象,就可以改寫(xiě)requiredservice對(duì)象, 也就可以實(shí)現(xiàn)我們要的運(yùn)行時(shí)動(dòng)態(tài)配置了.
• 擴(kuò)展點(diǎn)二: 需要實(shí)現(xiàn)自定義的iconfiguration配置, 只要this._optionsmonitor.get(name)拿到的對(duì)象的httpmessagehandlerbuilderactions屬性包含我們相應(yīng)的改寫(xiě)代碼即可.
  

擴(kuò)展點(diǎn)一的實(shí)現(xiàn)

為httpclient的handler增加一個(gè)配置的filter, 針對(duì)符合的handlerbuilder增加一些自己的改寫(xiě)邏輯.
我們?cè)谟胔ttpclient對(duì)象的時(shí)候產(chǎn)生的日志("sending http request......","received http response headers after......")就是由這個(gè)filter特性注入的. 官方參考代碼:logginghttpmessagehandlerbuilderfilter

個(gè)人見(jiàn)解: 覺(jué)得在這個(gè)擴(kuò)展點(diǎn)加這個(gè)業(yè)務(wù)不是特別的符合應(yīng)用場(chǎng)景, 所以我建議在擴(kuò)展點(diǎn)二做這個(gè)事情.

class myhttpclienthandlerfilter : ihttpmessagehandlerbuilderfilter
{
  public action<httpmessagehandlerbuilder> configure(action<httpmessagehandlerbuilder> next)
  {
      void configure(httpmessagehandlerbuilder builder)
      {
          next(builder); //一開(kāi)始就調(diào)用next, 這樣我們的整個(gè)handlerbuilder的執(zhí)行順序就是依次call _filters, 最后call options.httpmessagehandlerbuilderactions(擴(kuò)展點(diǎn)二).

          if (builder.name.startswith("callbackproviderside-")) //我們可以為這類(lèi)業(yè)務(wù)統(tǒng)一加一個(gè)前綴做區(qū)別, 這樣就不會(huì)影響其他的httpclient對(duì)象了.
          {
              //builder.primaryhandler= your custom handler. 參考官方文檔的實(shí)現(xiàn).
          }
      }
      return configure;
  }
}
//然后在di容器中注入我們的filter.
servicecollection.addsingleton<ihttpmessagehandlerbuilderfilter,myhttpclienthandlerfilter>();

擴(kuò)展點(diǎn)二的實(shí)現(xiàn)

class myhttpclientcustomconfigure : ipostconfigureoptions<httpclientfactoryoptions>
{
  public void postconfigure(string name, httpclientfactoryoptions options)
  {
      if (name.startswith("callbackproviderside-")) //我們可以為這類(lèi)業(yè)務(wù)統(tǒng)一加一個(gè)前綴做區(qū)別, 這樣就不會(huì)影響其他的httpclient對(duì)象了.
      {
          options.httpmessagehandlerbuilderactions.add(p =>
          {
              //p.primaryhandler= your custom handler. 參考官方文檔的實(shí)現(xiàn).
          });
      }
  }
}

//然后在di容器中注入我們的這個(gè)配置擴(kuò)展類(lèi).
servicecollection.addsingleton<microsoft.extensions.options.ipostconfigureoptions<microsoft.extensions.http.httpclientfactoryoptions>, myhttpclientcustomconfigure>();

為什么這里注入的類(lèi)型是microsoft.extensions.options.ipostconfigureoptions<microsoft.extensions.http.httpclientfactoryoptions>, 是因?yàn)?code>optionsfactory它的構(gòu)造函數(shù)需要的就是這個(gè). 至于有關(guān)configuration系統(tǒng)的擴(kuò)展和源代碼在這里就不在這里展開(kāi)了.

使用

至于用它就簡(jiǎn)單了

var factory = serviceprovider.getservice<ihttpclientfactory>();
var httpclientforbaidu = factory.createclient("callbackproviderside-baidu");
var httpclientforcnblogs = factory.createclient("callbackproviderside-cnblogs");

總結(jié)一下

這樣子, 我們的這個(gè)運(yùn)行時(shí)動(dòng)態(tài)配置httpclient就算完成了, 我也輕輕松松又水了一篇文章.
另外,有關(guān)ihttpclientfactory背后的故事可以查看文章exploring the code behind ihttpclientfactory in depth, 很完整的流程圖在配上代碼, 把它講解的清清楚楚.

以上就是asp.net core為ihttpclientfactory添加動(dòng)態(tài)命名配置的詳細(xì)內(nèi)容，更多關(guān)于asp.net core 添加動(dòng)態(tài)命名配置的資料請(qǐng)關(guān)注碩編程其它相關(guān)文章！