.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，记得点个小星星哦

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

.NET社区新闻，深度好文，欢迎访问公众号文章汇总 http://www.csharpkit.com