微软在.NET Core里设计出了全新的配置体系，并以非常灵活、可扩展的方式实现。从其源码来看，其运行机制大致是，根据其Source，创建一个Builder实例，并会向其添加Provider，在我们使用配置信息的时候，会从内存中获取相应的Provider实例。

.NET Core采用了统一的调用方式来加载不同类型的配置信息，并通过统一的抽象接口IConfigurationSource对配置源进行管理，这也是刚刚所说的灵活。而其扩展性就是我们可以自己自定义新的Provider实例，而不会改变其原来的调用方式。接下来的文章将会基于Consul，扩展一个新的Provider实例。

在ASP.NET Core 中，我们的应用配置是基于IConfigurationProvider的键值对。 我们先看一下思维导图：

基于上图，我们可以看到主要有键值对源有多种，分别是：

 环境变量

命令行参数

各种形式的配置文件

内存对象

用户自定义扩展源 

在介绍.NET Core配置功能之前，先简要说明一下Microsoft.Extensions.Configuration.Abstractions，该组件抽象了.NET Core的配置功能，并对自定义扩展制定了新的标准。以下介绍的四个核心对象全部来自于该组件。

IConfiguration

该接口表示一组键/值应用程序配置属性，应用程序使用配置时的入口对象，.NET Core对其有多种扩展，其派生类包括位于统一类库的IConfigurationSection，以及Microsoft.Extensions.Configuration类库中的ConfigurationRoot、ConfigurationSection、IConfigurationRoot。我们可以通过DI获取IConfiguration实例。

它主要有以下三个方法：

• GetChildren()：获取直接子配置子节

• GetReloadToken()：返回一个IChangeToken，可用于确定何时重新加载配置

• GetSection(String)：获取指定键的子节点

我们来看一下源码：

通常我们要求配置文件要有足够的灵活性，尤其是我们所扩展的配置信息存放在了其他服务器，当修改的时候我们很需要一套监控功能，以及时灵活的应对配置信息的修改。现在.NET Core为我们提供了这样一个功能，我们只需要自定义少量代码即可完成配置信息的同步。这个方法就是GetReloadToken()，其返回值是IChangeToken。此处对配置信息的同步只做一个引子，后面的文章会详细说明。

由于ConfigurationRoot、ConfigurationSection聚集于IConfiguration接口，此处也对这两个类进行讨论，方便我们对.NET Core的配置功能有个更加形象的印象。这两个接口，本质上就是.NET Core关于配置信息的读取方式。

XML是使用比较广泛的一种数据结构，我们在配置XML时，一般会使用根节点、父节点、子节点之类的术语，此处也一样。

ConfigurationRoot是配置的根节点，也实现了IConfigurationRoot，此接口只有一个方法，其主要功能就是实现对配置信息的重新加载，另外还包括一个IConfigurationProvider类型的集合属性。其源码如下

通过源码我们知道，如果调用了Reload()方法，所有类型的Provider都会重新加载。

前面有ConfigurationRoot表示配置的根节点，那么ConfigurationSection则表示非跟节点，毕竟父节点、子节点都是相对，所以此处使用非根节点。ConfigurationSection继承于IConfigurationSection，该接口只有三个只读属性，分别表示配置信息的Key、Value以及路径信息，需要指出的是，此处的路径信息主要指从根节点到当前节点的路径，以表示当前节点的位置，类似于A:B:C可以表示节点C的位置，其中A、B、C都是ConfigurationSection的Key。以下是ConfigurationSection的源码

IConfigurationBuilder

该接口主要用于创建IConfigurationProvider，其派生类包括Microsoft.Extensions.Configuration.ConfigurationBuilder。其成员包括

两个只读属性：

• Properties：获取可用于在IConfigurationBuilder之间共享数据的键/值集合

• Sources：该属性用于缓存不同的配置源，以用于相对应的Provider的创建

两个方法：

• Add(IConfigurationSource source)：新增IConfigurationSource，并添加到属性中Sources中

• Build()：该方法遍历Sources属性，并调用IConfigurationSource的Build()方法，通过获取Provider集合，最终创建IConfigurationRoot对象

ConfigurationBuilder源码如下

此处令人感慨颇多，我们最终调用 ConfigurationRoot 的构造函数，究其原因是Provider提供了统一的数据访问方式，不管是基于何种类型的Provider，我们都可以调用其Load()方法加载配置项。此外，IConfigurationBuilder本身有很多的扩展方法来注册数据源，比如AddJsonFile()扩展方法。我们来看一下，我们常见的写法，

IConfigurationSource

该接口表示应用程序配置的键值对。其派生类包括Microsoft.Extensions.Configuration.ChainedConfigurationSource、Microsoft.Extensions.Configuration.Memory.MemoryConfigurationSource。另外该派生类还会在文件类配置场景下依赖Microsoft.Extensions.Configuration.FileExtensions组件。

它是所有配置源的抽象表示，包括JSON、XML、INI、环境变量等等。通过上文我们也知道了，IConfigurationBuilder会注册多个IConfigurationSource实例。它只有一个方法，就是Build()方法，并返回IConfigurationProvider，由此可见，IConfigurationProvider的创建依赖于IConfigurationSource，这也是一一对应的关系。所有不同的源最终都会转化成统一的键值对表示。

以下是MemoryConfigurationSource的源码

IConfigurationProvider

通过上文的介绍，我们可以知道IConfigurationProvider是统一的对外接口，对用户提供配置的查询、重新加载等功能。其派生类包括Microsoft.Extensions.Configuration.ConfigurationProvider、Microsoft.Extensions.Configuration.ChainedConfigurationProvider、Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider。另外该派生类还会在文件类配置场景下依赖Microsoft.Extensions.Configuration.FileExtensions组件。

以下是Microsoft.Extensions.Configuration.ConfigurationProvider的源码：

通过源码，我们可以知道ConfigurationProvider以字典类型缓存了多个Provider对象，有需要的时候，从内存中获取即可，配置的加载通过Load()方法实现，在ConfigurationRoot里我们介绍了其Reload，并且说明其方法是在循环调用ConfigurationProvider的Load方法，但是此处只提供了一个虚方法，其目的是要交给其他具体的Provider，比如环境变量、JSON、XML等，这些具体的Provider可以从相应的配置源中获取配置信息。所有的子节点KEY通过GetChildKeys方法实现，其重新加载方式通过ConfigurationReloadToken实例完成。

另外需要说明一下，在ConfigurationProvider构造函数里，对字典进行了初始化，并同时设置了字典Key不受大小写限制，这是一个需要注意的细节。

通过查看.NET配置功能的源码，所有依赖均基于Microsoft.Extensions.Configuration.Abstractions，在其上有一层实现，即Microsoft.Extensions.Configuration，其内部也多数是抽象实现，并提供了多个虚方法交给其派生组件，比如环境变量、命令行参数、各种文件型配置等，当然各种文件型配置还要依赖Microsoft.Extensions.Configuration.FileExtensions组件。

以下是.NET Core 3.0预览版里的Configuration各个组件的结构图：

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

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