經過前面三篇關于.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，記得點個小星星哦

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

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

總結

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

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。