經(jīng)過前面三篇關(guān)于.NET Core Configuration的文章之后，本篇文章主要討論如何擴(kuò)展一個(gè)Configuration組件出來。如果前面三篇文章沒有看到，可以點(diǎn)擊如下地址訪問

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

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

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

了解了Configuration的源碼后，再去擴(kuò)展一個(gè)組件就會(huì)比較簡單，接下來我們將在.NET Core 3.0-preview5的基礎(chǔ)上創(chuàng)建一個(gè)基于Consul的配置組件。

相信大家對(duì)Consul已經(jīng)比較了解了，很多項(xiàng)目都會(huì)使用Consul作為配置中心，此處也不做其他闡述了，主要是講一下，創(chuàng)建Consul配置擴(kuò)展的一些思路。使用Consul配置功能時(shí)，我們可以將信息轉(zhuǎn)成JSON格式后再存儲(chǔ)，那么我們?cè)谧x取的時(shí)候，在體驗(yàn)上就像是從讀取JSON文件中讀取一樣。

初始化Consul

假設(shè)你已經(jīng)安裝并啟動(dòng)了Consul，我們打開Key/Value功能界面，創(chuàng)建兩組配置選項(xiàng)出來，分別是commonservice和userservice，如下圖所示

配置值采用JSON格式

實(shí)現(xiàn)思路

我們知道在Configuration整個(gè)的設(shè)計(jì)框架里，比較重要的類ConfigurationRoot，內(nèi)部又有一個(gè)IConfigurationProvider集合屬性，也就是說我們追加IConfigurationProvider實(shí)例最終也會(huì)被放到到該集合中，如下圖所示

該項(xiàng)目中，我使用到了一個(gè)已經(jīng)封裝好的Consul(V0.7.2.6)類庫，同時(shí)基于.NET Core關(guān)于Configuration的設(shè)計(jì)風(fēng)格，做如下的框架設(shè)計(jì)

考慮到我會(huì)在該組件內(nèi)部創(chuàng)建ConsulClient實(shí)例，所以對(duì)ConsulClient構(gòu)造函數(shù)的一部分參數(shù)做了抽象提取，并添加到了IConsulConfigurationSource中，以增強(qiáng)該組件的靈活性。

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

IConsulConfigurationSource

ConsulConfigurationSource

該類提供了一個(gè)構(gòu)造函數(shù)，用于接收ServiceKey和CancellationToken實(shí)例

其build()方法也比較簡單，主要是初始化ConsulConfigurationParser實(shí)例

ConsulConfigurationParser

該類比較復(fù)雜，主要實(shí)現(xiàn)Consul配置的獲取、監(jiān)控以及容錯(cuò)處理，公共方法源碼如下

另外，關(guān)于Consul的監(jiān)控主要利用了QueryResult.LastIndex屬性，該類緩存了該屬性的值，并與實(shí)獲取的值進(jìn)行比較，以判斷是否需要重新加載內(nèi)存中的緩存配置

ConsulConfigurationProvider

該類除了實(shí)現(xiàn)Load方法外，還會(huì)根據(jù)ReloadOnChange屬性，在構(gòu)造函數(shù)中注冊(cè)O(shè)nChange事件，用于重新加載配置信息，源碼如下：

此處調(diào)用在Program中實(shí)現(xiàn)

運(yùn)行結(jié)果，如下圖所示，我們已經(jīng)加載到了兩個(gè)ConsulProvider實(shí)例，這與我們?cè)赑rogram中添加的兩個(gè)Consul配置一致，其中所加載到的值也和.NET Core Configuration的Key/Value風(fēng)格相一致，所加載到的值也會(huì)Consul中所存儲(chǔ)的相一致

基于源碼擴(kuò)展一個(gè)配置組件出來，還是比較簡單的，另外需要說明的是，該組件關(guān)于JSON的處理主要基于.NET Core原生組件，位于命名空間內(nèi)的System.Text.Json中，所以該組件無法在.NET Core 3.0之前的版本中運(yùn)行，需要引入額外的JSON組件輔助處理。

源碼已經(jīng)托管于GitHub，地址：https://github.com/littlehorse8/Navyblue.Extensions.Configuration.Consul，記得點(diǎn)個(gè)小星星哦

原文地址：https://www.cnblogs.com/edison0621/p/10922281.html

.NET社區(qū)新聞，深度好文，歡迎訪問公眾號(hào)文章匯總?http://www.csharpkit.com?

總結(jié)

以上是生活随笔為你收集整理的.NET Core 3.0之创建基于Consul的Configuration扩展组件的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。