.NET Core 3.0Configuration源码理解(2)

作者 : 慕源网 本文共2044个字,预计阅读时间需要6分钟 发布时间: 2021-09-21 共151人阅读

上一篇文章讨论了Configuration的几个核心对象,本文继续讨论Configuration中关于文件型配置的相关内容。相比较而言,文件型配置的使用场景更加广泛,用户自定义配置扩展也可以基于文件型配置进行扩展。如果需要查看上一篇文章,可以点击移步。

 

.NET Core文件型配置中我们提供了三种主要的实现,分别是JSON、XML、INI,请查看下图

.NET Core 3.0Configuration源码理解(2)

  由图可知,这三种配置的实现方式是一样的,当然了其他的配置比如命令行配置、环境变量配置等也是大同小异,理解了改配置类型的实现方式,后面我们再扩展基于Consul或者ZK的实现,就非常简单了。

 

文件型配置的抽象扩展

 

文件型配置的抽象扩展位于Microsoft.Extensions.Configuration.FileExtensions组件中,该扩展是一个基础实现。不过其命名空间是Microsoft.Extensions.Configuration,而Micros oft.Extensions.Configuration扩建本身又是整个.NET Core Configuration的基础实现。将File扩展独立于外部,体验了.NET Core的模块化设计。

 

FileConfigurationSource

 

Configuration.FileExtensions组件中,FileConfigurationSource是继承于IConfigurationSource的一个抽象类,包含了一个IConfigurationProvider类型的抽象方法,如下所示

.NET Core 3.0Configuration源码理解(2)

  该抽象类中还包括了几个比较重要的参数,分别用于配置性行为、文件内容访问以及异常处理。

 

string Path:文件的路径

 

bool Optional:标识加载的文件是否是可选的

 

bool ReloadOnChange:如果文件发生修改,是否重新加载配置源

 

int ReloadDelay:加载延迟,单位是毫秒,默认是250毫秒

 

IFileProvider FileProvider:用于获取文件内容

 

Action<FileLoadExceptionContext> OnLoadException:文件加载异常处理

 

该类对FileProvider有特殊处理,就是如果没有提供FileProvider实例,则会基于绝对路径,在最近的现有目录中创建物理文件提供程序。源码如下,

.NET Core 3.0Configuration源码理解(2)

  FileConfigurationProvider

 

该类是继承于ConfigurationProvider的抽象类,是从文件系统加载配置的基类,同时还继承了IDisposable,其抽象方法是Load方法,用于从当前的Provider中以Stream方式加载数据

.NET Core 3.0Configuration源码理解(2)

  该类还重写了ConfigurationProvider的Load方法,并对文件加载中的异常做了处理,Data属性在前文有提到过,此处不再做其他说明。方法源码如下所示:

.NET Core 3.0Configuration源码理解(2)

  另外它还有一个特殊方法,就是参数类型为FileConfigurationSource的构造函数,其主要功能是监控文件,并在FileConfigurationSource.ReloadDelay设置的时间里重新加载文件并返回一个IDisposable类型的值,以下是该构造函数的源码:

.NET Core 3.0Configuration源码理解(2)

  FileConfigurationExtensions

 

该类是一个静态类,其提供了的多个扩展方法,主要基于

 

IConfigurationBuilder

 

IFileProvider

 

Action<FileLoadExceptionContext>

 

包括主要用于设置或获取IFileProvider对象,前文有介绍过,是存储于字典之中,需要注意的是,在Get的时候如果字典中并不存在IFileProvider对象,则会实例化一个PhysicalFileProvider对象出来,该类位于Microsoft.Extensions.FileProviders.PhysicalFileProvider

.NET Core 3.0Configuration源码理解(2)

  为指定路径的物理文件设置文件型Provider,该方法同样基于PhysicalFileProvider,并返回IConfigurationBuilder对象

.NET Core 3.0Configuration源码理解(2)

  以及异常处理,可以看到其异常处理也会存放于字典中,如果字典中找不到,就会返回空,这个地方如果直接使用,需要注意空指针问题。

.NET Core 3.0Configuration源码理解(2)

  该类还有两个静态私有变量,指定了文件Provider的Key以及文件加载异常处理Key。

.NET Core 3.0Configuration源码理解(2)

  文件型配置还依赖于.NET Core的其他组件Microsoft.Extensions.FileProviders和Microsoft.Extensions.Primitives。

 

FileProviders组件提供了文件处理的一般方法,Primitives组件提供了监控机制,同时还包括两个比较重要的结构体StringValues和StringSegment,本文暂时不做讨论,有兴趣的朋友,可以自行查看该组件源码。

 


慕源网 » .NET Core 3.0Configuration源码理解(2)

常见问题FAQ

程序仅供学习研究,请勿用于非法用途,不得违反国家法律,否则后果自负,一切法律责任与本站无关。
请仔细阅读以上条款再购买,拍下即代表同意条款并遵守约定,谢谢大家支持理解!

发表评论

开通VIP 享更多特权,建议使用QQ登录