而由于配置值的读取是按照数据源加载顺序的倒序进行的,所以对于Key值相同的多个配置,只会读取后加载的数据源中的配置,那么ConfigurationRoot和ConfigurationSection就模拟出了一个树状结构,如下图5:
图5
本图是以如下配置为例:
{ "Theme": { "Name": "Blue", "Color": "#0921DC" } }
ConfigurationRoot利用它制定的读取规则,将这样的配置模拟成了如图18‑8这样的树,它有这样的特性:
A.所有节点都认为是一个ConfigurationSection,不同的是对于“Theme”这样的节点的值为空(图中用空心椭圆表示),而“Name”和“Color”这样的节点有对应的值(图中用实心椭圆表示)。
B.由于对Key值相同的多个配置只会读取后加载的数据源中的配置,所以不会出现相同路径的同名节点。例如第一节例子中多种数据源配置了“Theme”值,在这里只会体现最后加载的配置项。
四、配置的更新
由于ConfigurationRoot未实际保存数据源中加载的配置值,所以配置的更新实际还是由对应的ConfigurationProvider来完成。以JsonConfigurationProvider、IniConfigurationProvider、XmlConfigurationProvider为例,它们的数据源都是具体文件,所以对文件内容的改变的监控也是放在FileConfigurationProvider中。FileConfigurationProvider的构造方法中添加了对设置了对应文件的监控,当然这里会首先判断数据源的ReloadOnChange选项是否被设置为True了。
public abstract class FileConfigurationProvider : ConfigurationProvider { public FileConfigurationProvider(FileConfigurationSource source) { if (source == null) { throw new ArgumentNullException(nameof(source)); } Source = source; if (Source.ReloadOnChange && Source.FileProvider != null) { changeToken.OnChange( () => Source.FileProvider.Watch(Source.Path), () => { Thread.Sleep(Source.ReloadDelay); Load(reload: true); }); } } //省略其他代码 }
所以当数据源发生改变并且ReloadOnChange被设置为True的时候,对应的ConfigurationProvider就会重新加载数据。但ConfigurationProvider更新数据源也不会改变它在ConfigurationRoot的IEnumerable<IConfigurationProvider>列表中的顺序。如果在列表中存在A和B两个ConfigurationProvider并且含有相同的配置项,B排在A后面,那么对于这些相同的配置项来说,A中的是被B中的“覆盖”的。即使A的数据更新了,它依然处于“被覆盖”的位置,应用中读取相应配置项的依然是读取B中的配置项。
五、配置的绑定
在第一节的例子中讲过了两种获取配置值的方式,类似这样_configuration["Theme:Name"]和_configuration.GetValue<string>("Theme:Color","#000000")可以获取到Theme的Name和Color的值,那么就会有下面这样的疑问:
appsettings.json中存在如下这样的配置
{ "Theme": { "Name": "Blue", "Color": "#0921DC" } }
新建一个Theme类如下:
public class Theme { public string Name { get; set; } public string Color { get; set; } }
是否可以将配置值获取并赋值到这样的一个Theme的实例中呢?
当然可以,系统提供了这样的功能,可以采用如下代码实现:
Theme theme = new Theme(); _configuration.GetSection("Theme").Bind(theme);
绑定功能由ConfigurationBinder实现,逻辑不复杂,读者如果感兴趣的可自行查看其代码。