歡迎光臨
每天分享高質量文章

.NET Core 3.0之創建基於Consul的Configuration擴展組件

經過前面三篇關於.NET Core Configuration的文章之後,本篇文章主要討論如何擴展一個Configuration組件出來。如果前面三篇文章沒有看到,可以點擊如下地址訪問

  • .NET Core 3.0之深入原始碼理解Configuration(一)

  • .NET Core 3.0之深入原始碼理解Configuration(二)

  • .NET Core 3.0之深入原始碼理解Configuration(三)

瞭解了Configuration的原始碼後,再去擴展一個組件就會比較簡單,接下來我們將在.NET Core 3.0-preview5的基礎上創建一個基於Consul的配置組件。

相信大家對Consul已經比較瞭解了,很多專案都會使用Consul作為配置中心,此處也不做其他闡述了,主要是講一下,創建Consul配置擴展的一些思路。使用Consul配置功能時,我們可以將信息轉成JSON格式後再儲存,那麼我們在讀取的時候,在體驗上就像是從讀取JSON檔案中讀取一樣。

初始化Consul

假設你已經安裝並啟動了Consul,我們打開Key/Value功能界面,創建兩組配置選項出來,分別是commonservice和userservice,如下圖所示

配置值採用JSON格式

實現思路

我們知道在Configuration整個的設計框架里,比較重要的類ConfigurationRoot,內部又有一個IConfigurationProvider集合屬性,也就是說我們追加IConfigurationProvider實體最終也會被放到到該集合中,如下圖所示

該專案中,我使用到了一個已經封裝好的Consul(V0.7.2.6)類庫,同時基於.NET Core關於Configuration的設計風格,做如下的框架設計

考慮到我會在該組件內部創建ConsulClient實體,所以對ConsulClient建構式的一部分引數做了抽象提取,並添加到了IConsulConfigurationSource中,以增強該組件的靈活性。

之前說過,Consul中的配置信息是以JSON格式儲存的,所以此處使用到了Microsoft.Extensions.Configuration.Json.JsonConfigurationFileParser,用以將JSON格式的信息轉換為Configuration的通用格式Key/Value。

IConsulConfigurationSource

ConsulConfigurationSource

該類提供了一個建構式,用於接收ServiceKey和CancellationToken實體

其build()方法也比較簡單,主要是初始化ConsulConfigurationParser實體

ConsulConfigurationParser

該類比較複雜,主要實現Consul配置的獲取、監控以及容錯處理,公共方法原始碼如下

另外,關於Consul的監控主要利用了QueryResult.LastIndex屬性,該類快取了該屬性的值,並與實獲取的值進行比較,以判斷是否需要重新加載記憶體中的快取配置

ConsulConfigurationProvider

該類除了實現Load方法外,還會根據ReloadOnChange屬性,在建構式中註冊OnChange事件,用於重新加載配置信息,原始碼如下:

此處呼叫在Program中實現

運行結果,如下圖所示,我們已經加載到了兩個ConsulProvider實體,這與我們在Program中添加的兩個Consul配置一致,其中所加載到的值也和.NET Core Configuration的Key/Value風格相一致,所加載到的值也會Consul中所儲存的相一致

基於原始碼擴展一個配置組件出來,還是比較簡單的,另外需要說明的是,該組件關於JSON的處理主要基於.NET Core原生組件,位於命名空間內的System.Text.Json中,所以該組件無法在.NET Core 3.0之前的版本中運行,需要引入額外的JSON組件輔助處理。

原始碼已經托管於GitHub,地址:https://github.com/littlehorse8/Navyblue.Extensions.Configuration.Consul,記得點個小星星哦

已同步到看一看
赞(0)

分享創造快樂