Asp.Net Core- 配置组件详解
我们之前写的配置都是放置在配置文件Web.config或者app.config中,.net core提供了全新的配置方式,可以直接写在内存中或者写在文件中。
.Net Core的配置API主要体现在3个类中Configuration、ConfigurationBuilder、ConfigurationProvider中。
配置文件其实就是一个键值对。Configuration以树形结构描述了这些键值对之间的关系。我们的配置文件比如project.json是怎么转换成Configuration树形结构的呢?
Microsoft.Extensions.Options这个命名空间下的类提供了文件向Configuration的转换。
一、配置文件分为3种结构
1. 逻辑结构:就是我们看到的结构,树形结构。
2. 原始结构:就是文件本身的结构,比如xml、json等等。
3. 物理结构:介于两者之间的结构,键值对。
配置组件的最终目的就是把原始结构转化成逻辑结构,在具体转换过程中,先找到对应的ConfigurationProvider转化为物理结构数据字典,然后再由ConfigurationBuilder转化为逻辑结构Configuration对象。
二、Configuration
Configuration对象泛指继承自接口IConfiguration的对象。这个接口如下:
namespace Microsoft.Extensions.Configuration
{
using Microsoft.Extensions.Primitives;
using System;
using System.Collections.Generic;
using System.Reflection;
public interface IConfiguration
{
IEnumerable<IConfigurationSection> GetChildren();
IChangeToken GetReloadToken();
IConfigurationSection GetSection(string key);
string this[string key] { get; set; }
}
}
这个接口GetChildren表示所有的ConfigurationSection对象;GetSection根据key值得到ConfigurationSection对象。
继承自这个接口的对象分别是ConfigurationRoot和ConfigurationSection,分别表示配置的根节点和叶子节点。

ConfigurationRoot还继承自接口IConfigurationRoot接口,代码如下:
namespace Microsoft.Extensions.Configuration
{
using System;
public interface IConfigurationRoot : IConfiguration
{
void Reload();
}
}
这个接口只有一个方法Reload重新加载,当调用这个方法的时候,在这棵树下的所有的节点都会重新加载。
ConfigurationSection还继承自IConfigurationSection,代码如下:
namespace Microsoft.Extensions.Configuration
{
using System;
public interface IConfigurationSection : IConfiguration
{
string Key { get; }
string Path { get; }
string Value { get; set; }
}
}
Key表示父节点的名称;Path表示当前节点的路径,用“:”隔开;Value只有在叶子节点才有值,非叶子节点返回Null。
三、ConfigurationProvider
ConfigurationProvider对象泛指实现了接口IConfigurationProvider的对象。
namespace Microsoft.Extensions.Configuration
{
using Microsoft.Extensions.Primitives;
using System;
using System.Collections.Generic;
using System.Runtime.InteropServices;
public interface IConfigurationProvider
{
IEnumerable<string> GetChildKeys(IEnumerable<string> earlierKeys, string parentPath);
IChangeToken GetReloadToken();
void Load();
void Set(string key, string value);
bool TryGet(string key, out string value);
}
}
而继承自这个接口的是一个抽象类ConfigurationProvider,代码如下:
public abstract class ConfigurationProvider : IConfigurationProvider
{
// Fields
private ConfigurationReloadToken _reloadToken;
// Methods
protected ConfigurationProvider();
public virtual IEnumerable<string> GetChildKeys(IEnumerable<string> earlierKeys, string parentPath);
public IChangeToken GetReloadToken();
public virtual void Load();
protected void OnReload();
private static string Segment(string key, int prefixLength);
public virtual void Set(string key, string value);
public virtual bool TryGet(string key, out string value);
// Properties
protected IDictionary<string, string> Data { get; set; }
}
因为这个类的最终目的就是转化为数据字典,所以,这个类的方法大部分都是针对数据字典,方法的参数中都有key值。
不同的数据源都是继承自这个抽象类,重写自己的方法。
Load方法从数据源加载数据,针对不同的数据源子类可以重写;TryGet根据key值获取数据值;Set方法设置数据值,因为这个类的主要功能是从数据源读取数据转化为数据字典,所以Set的值只保存在内存中。
四、ConfigurationBuilder
泛指实现了接口IConfigurationBuilder的对象。他的作用就是根据ConfigurationProvider提供的数据字典,把数据字典转化为ConfigurationRoot对象。接口如下:
namespace Microsoft.Extensions.Configuration
{
using System.Collections.Generic;
public interface IConfigurationBuilder
{
IConfigurationBuilder Add(IConfigurationSource source);
IConfigurationRoot Build();
Dictionary<string, object> Properties { get; }
IEnumerable<IConfigurationSource> Sources { get; }
}
}
主要通过Build方法实现把数据字典转化为ConfigurationRoot。
无论是ConfigurationRoot还是ConfigurationSection本身都没有封装任何形式的对配置的读取操作,所有的读取操作都是在ConfigurationProvider对象中。
在ConfigurationRoot和ConfigurationSection组成的树形结构中,并没有在代码中直接保存这种结构,而是每个ConfigurationSection中都有一个ConfigurationRoot对象,直接是对根节点的引用。而只有根节点中有对ConfigurationProvider的调用。也就是在每个叶子节点中都有一个对于根节点的引用。这样当我们想要获取某个节点的具体值时,先找到根节点,再通过根节点找到ConfigurationProvider,通过ConfigurationProvider对象获取配置值。
还有一个对象ConfigurationPath,主要封装对树层级结构的计算,代码如下:
namespace Microsoft.Extensions.Configuration
{
using System;
using System.Collections.Generic;
public static class ConfigurationPath
{
public static readonly string KeyDelimiter = ":";
public static string Combine(IEnumerable<string> pathSegments)
{
if (pathSegments == null)
{
throw new ArgumentNullException("pathSegments");
}
return string.Join(KeyDelimiter, pathSegments);
}
public static string Combine(params string[] pathSegments)
{
if (pathSegments == null)
{
throw new ArgumentNullException("pathSegments");
}
return string.Join(KeyDelimiter, pathSegments);
}
public static string GetParentPath(string path)
{
if (!string.IsNullOrEmpty(path))
{
int length = path.LastIndexOf(KeyDelimiter, (StringComparison) StringComparison.OrdinalIgnoreCase);
if (length != -)
{
return path.Substring(, length);
}
}
return null;
}
public static string GetSectionKey(string path)
{
if (!string.IsNullOrEmpty(path))
{
int num = path.LastIndexOf(KeyDelimiter, (StringComparison) StringComparison.OrdinalIgnoreCase);
if (num != -)
{
return path.Substring(num + );
}
}
return path;
}
}
}
Combine方法实现把路径连接成一个完整的路径。
以上对象之间的关系图如下:

综上,配置模块的最终目的是要把原始的配置文件比如:json、xml转换为一个ConfigurationRoot对象,这个对象是一个树形结构,下边是ConfigurationSection对象。当我们要获取某个配置时,通过ConfigurationRoot的ConfigurationProvider获取,每个ConfigurationSection都有一个对于根节点的引用。
后记:当需要读取一个配置文件的时候,调用ConfigurationBuilder的build方法把文件内容转换为ConfigurationRoot对象,在这个方法执行过程中,会调用根据配置文件的不同调用相关的ConfigurationProvider ,然后调用ConfigurationProvider的Load方法,把配置文件转换成数据字典;然后再回到ConfigurationBuilder中把数据字典转化为ConfigurationRoot。
参考链接:http://www.cnblogs.com/artech/p/asp-net-core-config-01.html
Asp.Net Core- 配置组件详解的更多相关文章
- 【转】asp.net core环境变量详解
asp.net core环境变量详解 环境变量详解 Windows操作系统的环境变量在哪设置应该都知道了. Linux(centos版本)的环境变量在/etc/profile里面进行设置.用户级的环境 ...
- ASP.NET Core真实管道详解[2]:Server是如何完成针对请求的监听、接收与响应的【上】
Server是ASP .NET Core管道的第一个节点,负责完整请求的监听和接收,最终对请求的响应同样也由它完成.Server是我们对所有实现了IServer接口的所有类型以及对应对象的统称,如下面 ...
- ASP.NET Core真实管道详解[1]:中间件是个什么东西?
ASP.NET Core管道虽然在结构组成上显得非常简单,但是在具体实现上却涉及到太多的对象,所以我们在 <ASP.NET Core管道深度剖析[共4篇]> 中围绕着一个经过极度简化的模拟 ...
- ASP.NET Core 中 HttpContext 详解与使用 | Microsoft.AspNetCore.Http 详解 (转载)
“传导体” HttpContext 要理解 HttpContext 是干嘛的,首先,看图 图一 内网访问程序 图二 反向代理访问程序 ASP.NET Core 程序中,Kestrel 是一个基于 li ...
- asp.net core环境变量详解
环境变量详解 Windows操作系统的环境变量在哪设置应该都知道了. Linux(centos版本)的环境变量在/etc/profile里面进行设置.用户级的环境变量在其它文件里面,不多说了,有兴趣的 ...
- ASP.NET Core 中 HttpContext 详解与使用 | Microsoft.AspNetCore.Http 详解
笔者没有学 ASP.NET,直接学 ASP.NET Core ,学完 ASP.NET Core MVC 基础后,开始学习 ASP.NET Core 的运行原理.发现应用程序有一个非常主要的 “传导体” ...
- ASP.NET Core真实管道详解[1]
ASP.NET Core管道虽然在结构组成上显得非常简单,但是在具体实现上却涉及到太多的对象,所以我们在 <ASP.NET Core管道深度剖析[共4篇]> 中围绕着一个经过极度简化的模拟 ...
- net core体系-web应用程序-4net core2.0大白话带你入门-5asp.net core环境变量详解
asp.net core环境变量详解 环境变量详解 Windows操作系统的环境变量在哪设置应该都知道了. Linux(centos版本)的环境变量在/etc/profile里面进行设置.用户级的 ...
- ASP.NET Core的配置(2):配置模型详解
在上面一章我们以实例演示的方式介绍了几种读取配置的几种方式,其中涉及到三个重要的对象,它们分别是承载结构化配置信息的Configuration,提供原始配置源数据的ConfigurationProvi ...
- Tomcat系列之服务器的安装与配置以及各组件详解
Tomcat系列之服务器的安装与配置以及各组件详解 大纲 一.前言 二.安装与配置Tomcat 三.Tomcat 目录的结构 四.Tomcat 配置文件 注,本文的测试的操作系统为CentOS 6.4 ...
随机推荐
- P90、面试题11:数值的整数次方
题目:实现函数double Power(double base, int exponent),求base的exponent次方.不得使用库函数,同时不需要考虑大数问题. 需要注意的地方: 1)输入的指 ...
- 在XML里的XSD和DTD以及standalone的使用
有关XML结构中的XSD和DTD以及standalone的使用 XmlDeclaration declare= document.CreateXmlDeclaration("1.0" ...
- php discuz框架接口不能正常访问的问题
本人php小白,无php编程基础,直接上php服务器部署,后果很严重.....所以务必看完请给”顶“给评论,以表示对小白的鼓励和赞赏! 关于discuz框架,独自加班,废寝忘食,然已无力吐槽..... ...
- ZJOI2008泡泡堂BNB
1034: [ZJOI2008]泡泡堂BNB Time Limit: 10 Sec Memory Limit: 162 MBSubmit: 1305 Solved: 676[Submit][Sta ...
- [2015编程之美] 第一场C
题目3 : 质数相关 时间限制:2000ms 单点时限:1000ms 内存限制:256MB 描述 两个数a和 b (a<b)被称为质数相关,是指a × p = b,这里p是一个质数.一个集合S被 ...
- Zepto picLazyLoad Plugin,图片懒加载的Zepto插件
嗯,学着国外人起名字Zepto picLazyLoad Plugin确实看起来高大上,其实js代码没几句,而且我每次写js都捉襟见肘,泪奔--- 图片懒加载有很多js插件,非常著名的属jQuery的L ...
- ubuntu常用快捷键
1.直接退出窗口 Ctrl + q 2.窗口变大变小 Alt + Q 3.最小化窗口,显示桌面Ctrl + Alt + D 4.把当前窗口移到另一个工作区 Shift+ Ctrl + Alt +方 ...
- NET下RabbitMQ实践[WCF发布篇]
在之前的两篇文章中,主要介绍了RabbitMQ环境配置,简单示例的编写.今天将会介绍如何使用WCF将RabbitMQ列队以服务的方式进行发布. 注:因为RabbitMQ的官方.net ...
- ASP.NET MVC:通过 FileResult 向 浏览器 发送文件
在 Controller 中我们可以使用 FileResult 向客户端发送文件. FileResult FileResult 是一个抽象类,继承自 ActionResult.在 System.Web ...
- Android学习系列(23)--App主界面实现
在上篇文章<Android学习系列(22)--App主界面比较>中我们浅略的分析了几个主界面布局,选了一个最大众化的经典布局.今天我们就这个经典布局,用代码具体的实现它. 1.预览图先看下 ...