在前面的章節(jié)中，我們知道新版的MVC程序拋棄了原來(lái)的web.config文件機(jī)制，取而代替的是config.json，今天我們就來(lái)深入研究一下配置文件的相關(guān)內(nèi)容。

基本用法

新版的配置信息機(jī)制在Microsoft.Framework.ConfigurationModel命名空間下進(jìn)行了重寫(xiě)，重寫(xiě)以后不僅支持XML格式，還支持json、ini、環(huán)境變量等。在模板示例程序中Startup類的構(gòu)造函數(shù)內(nèi)如，有如下語(yǔ)句：

// Setup configuration sources. 
Configuration = new Configuration() 
    .AddJsonFile("config.json") 
    .AddEnvironmentVariables(); 

該語(yǔ)句的作用是將config.json文件以及環(huán)境變量信息加入到配置信息容器里，以便進(jìn)行讀取。而讀取的時(shí)候則可以通過(guò)集合索引的形式或Get方法進(jìn)行讀取，示例如下：

var path = Configuration["Path"]; 
var path = Configuration.Get("Path"); 

其中，多層級(jí)key鍵的讀取，需要在多個(gè)層級(jí)名稱之間用冒號(hào)分割即可，示例如下：

var connString = Configuration.Get("Data:DefaultConnection:ConnectionString"); 

通過(guò)上述幾段代碼可以看出，該配置示例并不是全局實(shí)例，所以要想在別的地方也讀取這些信息，就需要將該實(shí)例保存在一個(gè)全局靜態(tài)變量上。

架構(gòu)設(shè)計(jì)

新的配置信息處理機(jī)制，在重寫(xiě)以后，更加輕量級(jí)，而且是進(jìn)行跨平臺(tái)使用，可以從多個(gè)數(shù)據(jù)源獲取配置信息，而不必在拘泥于.config文件，而且甚至可以為不同的環(huán)境(開(kāi)發(fā)、測(cè)試、生產(chǎn))設(shè)置不同的配置信息。整個(gè)配置機(jī)制的各個(gè)重要實(shí)體見(jiàn)下圖：

 

我們來(lái)一一講述一下，這些類的具體作用：

1.IConfiguration - 配置信息的實(shí)例接口，該接口上的indexer、Get、TryGet、Set以及其它一些像Reload這樣的方法一起用于獲取基于key/value的配置信息。

2.IConfigurationSource - 該接口統(tǒng)一了各個(gè)配置源使用時(shí)的接口方法，比如TryGet、Set以及最重要的讀取配置信息的load方法，以便將信息加載到配置子系統(tǒng)里。

3.IConfigurationSourceContainer - 所有配置源信息的一個(gè)容器，該容器使得可以在一個(gè)單獨(dú)的Configuration實(shí)例上加載各種配置源的配置信息。該接口只有一個(gè)Add方法用于添加基于IConfigurationSource的配置源信息。

4.Configuration - 該類實(shí)現(xiàn)了IConfiguration接口和IConfigurationSourceContainer接口，不保存基于key/value的所有類型的配置信息。

5.ConfigurationExtensions - 擴(kuò)展方法，用于快速加載配置信息，如AddCommandLine、AddIniFile等。

在Microsoft.Framework.ConfigurationModel命名空間下，目前有6種不同類型的配置源類型可以使用，分別如下：

1.MemoryConfigurationSource - 該配置源目前沒(méi)有內(nèi)置的add/load擴(kuò)展方法(比如AddMemoryConfiguration)，但你可以加載key/value類型的集合來(lái)實(shí)現(xiàn)此目的(如IEnumerable

2.IniFileConfigurationSource - 該配置源，可以將基于key/value格式的INI文件配置信息加載到配置系統(tǒng)中。

3.CommandLineConfigurationSource - 將程序啟動(dòng)時(shí)的命令行參數(shù)信息加載到配置系統(tǒng)中。

4.EnvironmentVariablesConfigurationSource - 將操作系統(tǒng)的環(huán)境變量信息加載到配置系統(tǒng)中，在Azure Website中，環(huán)境變量可以通過(guò)web界面進(jìn)行設(shè)置，管理相當(dāng)方便。

5.JsonConfigurationSource - 將json文件的信息加載配置系統(tǒng)。

6.XmlconfigurationSource - 將xml文件的信息加載到配置系統(tǒng)。

詳細(xì)用法

首先，由于配置系統(tǒng)是多實(shí)例型的，所以每次使用之前都要先聲明一個(gè)示例，代碼如下：

IConfiguration configuration = new Configuration(); 
 
添加MemoryConfigurationSource 
 
由于在IConfigurationSourceContainer上沒(méi)有為MemoryConfigurationSource定義快速加載配置信息的擴(kuò)展方法，所以如果想加載這種類型的配置信息，則需要按照如下形式進(jìn)行添加： 
 
((IConfigurationSourceContainer)Configuration) 
        .Add(new MemoryConfigurationSource( 
            new List 

添加IniFileConfigurationSource

IniFileConfigurationSource類型的配置信息可以通過(guò)擴(kuò)展方法進(jìn)行加載，代碼如下：

var configuration = new Configuration().AddIniFile("path\\to\\your\\configuration-ini-file.ini"); 

其中ini文件的格式模板如下：

[ini-sec] 
ini-key1=value-a 
ini-key2=value-b 
[ini-sec2] 
ini-key1=value-c 
ini-key2=value-d 

這里的[ini-sec]是自定義的配置節(jié)名稱，每個(gè)配置節(jié)下面可以配置多個(gè)key/value項(xiàng)。取值方式和基本示例中的一樣，層級(jí)之間(本例是配置節(jié)和key之間)要用冒號(hào)分割，示例如下：

var someConfiguration1 = Configuration["ini-sec:ini-key1"]; 
var someConfiguration2 = Configuration.Get("ini-sec2:ini-key2"); 

添加CommandLineConfigurationSource

在程序使用k run命名進(jìn)行時(shí)傳入的參數(shù)，可以通過(guò)該配置源進(jìn)行讀取，或者你也可以通過(guò)AddCommandLine擴(kuò)展方法手工添加，示例如下：

var configuration = new Configuration().AddCommandLine(new string[] { "key1=value1", "key2=value2", "@key3=value3" }); 

上述示例中的每個(gè)字符串都要是key/value格式，可以使用少于的特殊符號(hào)比如$、/等。 針對(duì)這些key值，你也可以使用帶有switchMappings參數(shù)構(gòu)造函數(shù)的CommandLineConfigurationSource類來(lái)映射某些key，switchMappings參數(shù)的數(shù)據(jù)類型和示例如下：

var mappings = new Dictionary 

由于當(dāng)前沒(méi)有針對(duì)CommandLineConfigurationSource類的擴(kuò)展方法，所以我們還是需要自己實(shí)例化該類，并添加到配置容器中，代碼如下：

((IConfigurationSourceContainer)Configuration).Add(new CommandLineConfigurationSource(commandLineArguments, switchMappings: mappings)); 

執(zhí)行上述代碼以后，在獲取配置值的時(shí)候，如下兩個(gè)key的值是一樣的：

var value1 = Configuration.Get("key1"); 
var value2 = Configuration["tom1"]; // tom1這個(gè)key的值其實(shí)就key1的值，因?yàn)閠om1是key1的映射 

在映射的時(shí)候，新的映射key字符串里不能包括“/”字符，否則會(huì)報(bào)異常

同樣的key不能傳入兩次，否則也會(huì)報(bào)異常

加載配置信息時(shí)，如果有重復(fù)key，則后一個(gè)key的值會(huì)覆蓋前一個(gè)key的值。

加載CommandLine配置信息時(shí)，如果一個(gè)key字符串以-作為前綴，那么就必須利用switchMapping將一個(gè)新key映射到舊key上，否則就會(huì)出錯(cuò)。

添加EnvironmentVariablesConfigurationSource

ironmentVariablesConfigurationSource可以將操作系統(tǒng)的環(huán)境變量添加到配置系統(tǒng)中，同時(shí)你也可以對(duì)這些環(huán)境變量進(jìn)行自定義，比如在VS開(kāi)發(fā)調(diào)試的時(shí)候，可以在如下界面添加一些key/value：

 

取值方式如下：

var someConfiguration1 = Configuration["env_var_key1"]; 
var someConfiguration2 = Configuration["env_var_key2"]; 

另外，該配置源也支持Azure環(huán)境變量和連接字符串，所以你也可以在Azure界面里設(shè)置MSSQL、MYSQL、以及自定義鏈接字符串等等，但這些鏈接字符串需要以如下字符串開(kāi)頭：

 

1.MySQL => MYSQLCONNSTR_ 
 
2.MS SQL => SQLCONNSTR_ 
 
3.SQL Azure DB => SQLAZURECONNSTR_ 
 
4.Custom DB => CUSTOMCONNSTR_ 

 

舉例來(lái)說(shuō)，定義一個(gè)開(kāi)發(fā)環(huán)境的key/value如下：

Key => SQLCONNSTR_devlocal 
Value => Server=localhost;Database=test_db;Trusted_Connection=True; 

通過(guò)AddEnvirnmentVariables()的形式load完信息以后，我們則可以通過(guò)如下方式來(lái)訪問(wèn)這項(xiàng)信息：

var connString = Configuration["Data:devlocal:ConnectionString"]; 

也就是說(shuō)，在Azure里，環(huán)境變量的key會(huì)轉(zhuǎn)換成Data:自定義標(biāo)識(shí)符:ConnectionString這樣的格式。如果你的key不是自定義key(以CUSTOMCONNSTR_開(kāi)頭)的話，你可以用如下方式獲取連接字符串的provider名稱，示例如下：

var providerName = Configuration["Data:devlocal:ProviderName"]; 
/// 返回：System.Data.SqlClient 
 
EnvironmentVariablesConfigurationSource 

另外還提供一種前綴過(guò)濾的方式加載部分信息，比如：

((IConfigurationSourceContainer)Configuration).Add(new EnvironmentVariablesConfigurationSource("Data:")); 

這樣，再獲取信息的時(shí)候，key值里的Data：就可以省略了，示例如下：

var conn1 = Configuration["devlocal:ConnectionString"]; 
var conn2 = Configuration["devlocal:ProviderName"]; 

添加JsonConfigurationSource

在文章的開(kāi)頭，我們看到了json配置文件的加載，加載該文件只需要使用.AddJsonFile("test.json")擴(kuò)展方法即可，但不要忘記，要先在project.json的dependencies里引用Microsoft.Framework.ConfigurationModel.Json程序集才行。

比如，如果你的config.json文件內(nèi)容如下：

{
    "Data": {
        "DefaultConnection": {
            "ConnectionString": "Server=(localdb)\\mssqllocaldb;Database=aspnet5-WebApplication1-64357659-de50-4b1e-b005-30310e7ee1ef;Trusted_Connection=True;MultipleActiveResultSets=true"
        }
    },
    "EntityFramework": {
        "ApplicationDbContext": {
            "ConnectionString": "Data:DefaultConnection:ConnectionString"
        }
    }
}

那你就可以利用如下方式來(lái)訪問(wèn)鏈接字符串：

var conn = Configuration["Data:DefaultConnection:ConnectionString"]; 

添加X(jué)mlconfigurationSource

XmlconfigurationSource配置源和JsonConfigurationSource配置源類似，首先引用Microsoft.Framework.ConfigurationModel.Xml程序集，然后調(diào)用.AddXmlFile("test.xml")。

如果你的配置文件test.xml的內(nèi)容如下：

<root> 
  <key1>Jsinh</key1> 
  <key2 subkey2="Hello world" /> 
</root> 

獲取形式，則稍有有些區(qū)別(會(huì)忽略根節(jié)點(diǎn)root)：

var s1 = Configuration["key1"]; // 返回Jsinh 
var s2 = Configuration["key2:subkey2"]; // 返回 Hello world 

但是要注意，通用的key不能重復(fù)聲明，下面的文件在讀取的時(shí)候就會(huì)出錯(cuò)。

<root> 
  <key1>Jsinh</key1> 
  <key2 subkey2="Hello world" /> 
  <key2 subkey2="Hello world again" /> 
</root> 

敏感信息配置(RC版新增功能)

在RC版發(fā)布以后，微軟又新增了一種敏感信息配置實(shí)現(xiàn)，程序集為Microsoft.Framework.ConfigurationModel.UserSecrets，通過(guò)該程序集的管理，我們可以將敏感的配置信息放在計(jì)算機(jī)的特殊目錄下的secrets.json文件，其目錄定義規(guī)則如下：

Windows: %APPDATA%\microsoft\UserSecrets\\secrets.json Linux: ~/.microsoft/usersecrets/\secrets.json Mac: ~/.microsoft/usersecrets/\secrets.json

我們來(lái)舉例操作一下，首先，右鍵解決方案選擇Manage User Secret，VS會(huì)自動(dòng)給該程序創(chuàng)建一個(gè)applicationId，并保持在·project.json·文件中，示例如下：

{ 
    "userSecretsId": "aspnet5-WebDemo01-20150430014447", 
    "webroot": "wwwroot", 
    "version": "1.0.0-*", 
} 
 
  

 

接著會(huì)自動(dòng)打開(kāi)%APPDATA%\Microsoft\UserSecrets\aspnet5-WebDemo01-20150430014447\secrets.json文件，我們輸入一個(gè)示例配置：

{ 
    "AA": { 
        "BB": "CC" 
    } 
} 

 

然后，我們?cè)趐roject.json文件里引用了上述程序集，再通過(guò)配置文件的統(tǒng)一方式進(jìn)行注冊(cè)，代碼如下：

Configuration = new Configuration() 
                .AddJsonFile("config.json") 
                .AddEnvironmentVariables() 
                .AddUserSecrets();  // AddUserSecrets是添加敏感信息的擴(kuò)展方法 

然后就可以想普通的調(diào)用方法一下調(diào)用了，示例如下：

var data = Configuration["AA:BB"]; // 結(jié)果：CC 

通過(guò)這種方式，我們就可以將生產(chǎn)環(huán)境的配置信息放在隱私的位置了。

自定義配置源

通過(guò)以上示例以及查看其架構(gòu)設(shè)計(jì)機(jī)制，我們可以發(fā)現(xiàn)，其實(shí)我們還可以自定義自己的配置源，比如我想從數(shù)據(jù)庫(kù)中讀取響應(yīng)的配置信息，那我們只要定義一個(gè)DBConfigurationSource，并繼承于ConfigurationSource即可，實(shí)現(xiàn)響應(yīng)的Load重載即可。

 

 

    public class DBConfigurationSource : BaseConfigurationSource  
      
    public class DBConfigurationSource : BaseConfigurationSource  
    {  
        public override void Load()  
        {  
            // 讀取數(shù)據(jù)庫(kù)所有的key/value，并將其賦值給IDictionary  
 
如果你不把數(shù)據(jù)保存在Data屬性里，那么你還要實(shí)現(xiàn)如下幾個(gè)重載，以便從自己的私有數(shù)據(jù)集合里獲取響應(yīng)的值，比如從緩存中獲取，示例如下： 
 
    public class DBConfigurationSource : BaseConfigurationSource  
    {  
        public override void Load()  
        {  
            // 讀取數(shù)據(jù)庫(kù)所有的key/value，保存在私有變量_data中  
        }  
      
        public override void Set(string key, string value)  
        {  
            // 更新數(shù)據(jù)庫(kù)key對(duì)應(yīng)的值  
            // base.Set(key, value);  
        }  
      
        public override bool TryGet(string key, out string value)  
        {  
            // 從私有變量_data中獲取key對(duì)應(yīng)的value  
            // return base.TryGet(key, out value);  
        }  
      
        public override IEnumerable ProduceSubKeys(IEnumerable earlierKeys, string prefix, string delimiter)     {         // 私有變量_data中，根據(jù)自己的機(jī)制返回響應(yīng)的SubKeys    
 
       // return base.ProduceSubKeys(earlierKeys, prefix, delimiter);     } } 

實(shí)現(xiàn)完上述類以后，再為自己創(chuàng)建一個(gè)擴(kuò)展方法用于添加DB配置信息，代碼如下

public static class CatsConfigurationExtensions 
{ 
    public static IConfigurationSourceContainer AddDBConfiguration(this IConfigurationSourceContainer configuration) 
    { 
        configuration.Add(new DBConfigurationSource()); 
        return configuration; 
    } 
} 

就可以通過(guò).AddDBConfiguration()來(lái)添加DB配置源了。

注意，DB配置源需要使用數(shù)據(jù)庫(kù)連接字符串，這一點(diǎn)需要注意(獲取可以先從json配置文件獲取連接字符串，然后再添加該配置源)。

配置信息遍歷

在默認(rèn)的配置源實(shí)現(xiàn)中，所有的類都繼承于ConfigurationSource，并且將信息數(shù)據(jù)保存在Data屬性中，所以如果要遍歷這些數(shù)據(jù)，則需要將其轉(zhuǎn)換為ConfigurationSource類型才能使用，示例代碼如下：

foreach (var o in Configuration as Configuration) 
{ 
    var source = o as ConfigurationSource; 
    foreach (var key in source.Data.Keys) 
    { 
        Console.WriteLine(key + ":" + source.Data[key]); 
    } 
} 

配置信息直接轉(zhuǎn)換為實(shí)體類

在IServiceCollection接口上還有一個(gè)擴(kuò)展方法.Configure可以將類型IConfiguration的數(shù)據(jù)轉(zhuǎn)換為一個(gè)實(shí)體類，該擴(kuò)展方法的定義如下：

public static IServiceCollection Configure(this IServiceCollection services, IConfiguration config, int order = -1000, string optionsName = "");

舉個(gè)例子，如果我們定義如下一個(gè)實(shí)體：

public class AppSettings 
{ 
    public string SiteTitle { get; set; } 
} 
 
  
 
然后在config.json里定義一個(gè)相同結(jié)構(gòu)的配置信息，示例如下： 
 
{ 
    "AppSettings": { 
        "SiteTitle": "WebDemo01" 
    } 
} 

那么通過(guò)在Startup的構(gòu)造函數(shù)將配置信息加載以后，我們就可以將該信息賦值給AppSettings實(shí)例，代碼如下：

services.Configure(Configuration.GetSubKey("AppSettings")); 

用的時(shí)候，使用ApplicationServices的GetRequiredService方法即可，示例如下：

var appSettings = app.ApplicationServices.GetRequiredService 

注意事項(xiàng)：

在配置信息里，所有的key都是不區(qū)分大小寫(xiě)的，即key和KEY是一樣的。

如果多個(gè)配置源有重復(fù)的key，則以后***添加的配置源中的key所對(duì)應(yīng)的值為準(zhǔn)。

IConfiguration下的GetSubKeys和GetSubKey可以獲取某個(gè)層級(jí)(或以某個(gè)層級(jí)開(kāi)頭的)的所有key列表。

由于Configuration是多實(shí)例的，所以按照示例中的代碼，該實(shí)例在Startup里初始化以后，其它類就無(wú)法訪問(wèn)了，所以如果要做全局性的訪問(wèn)，***在初始化之后將其保存到一個(gè)靜態(tài)變量中。

參考1：https://github.com/aspnet/Configuration

參考2：http://blog.jsinh.in/asp-net-5-configuration-microsoft-framework-configurationmodel/#.VSdjUpOxxzw