解讀asp.net 5 & MVC6系列（5）：Configuration配置信息管理

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

基本用法

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

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

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

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

其中，多層級key鍵的讀取，需要在多個層級名稱之間用冒號分割即可，示例如下：

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

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

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

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

我們來一一講述一下，這些類的具體作用：

1. IConfiguration - 配置信息的實例接口，該接口上的indexer、Get、TryGet、Set以及其它一些像Reload這樣的方法一起用于獲取基于key/value的配置信息。
2. IConfigurationSource - 該接口統(tǒng)一了各個配置源使用時的接口方法，比如TryGet、Set以及最重要的讀取配置信息的load方法，以便將信息加載到配置子系統(tǒng)里。
3. IConfigurationSourceContainer - 所有配置源信息的一個容器，該容器使得可以在一個單獨的Configuration實例上加載各種配置源的配置信息。該接口只有一個Add方法用于添加基于IConfigurationSource的配置源信息。
4. Configuration - 該類實現(xiàn)了IConfiguration接口和IConfigurationSourceContainer接口，不保存基于key/value的所有類型的配置信息。
5. ConfigurationExtensions - 擴展方法，用于快速加載配置信息，如AddCommandLine、AddIniFile等。

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

1. MemoryConfigurationSource - 該配置源目前沒有內(nèi)置的add/load擴展方法（比如AddMemoryConfiguration），但你可以加載key/value類型的集合來實現(xiàn)此目的（如IEnumerable<KeyValuePair<string, string>>類型）。
2. IniFileConfigurationSource - 該配置源，可以將基于key/value格式的INI文件配置信息加載到配置系統(tǒng)中。
3. CommandLineConfigurationSource - 將程序啟動時的命令行參數(shù)信息加載到配置系統(tǒng)中。
4. EnvironmentVariablesConfigurationSource - 將操作系統(tǒng)的環(huán)境變量信息加載到配置系統(tǒng)中，在Azure Website中，環(huán)境變量可以通過web界面進行設(shè)置，管理相當(dāng)方便。
5. JsonConfigurationSource - 將json文件的信息加載配置系統(tǒng)。
6. XmlconfigurationSource - 將xml文件的信息加載到配置系統(tǒng)。

詳細用法

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

IConfiguration configuration = new Configuration();

添加MemoryConfigurationSource

由于在IConfigurationSourceContainer上沒有為MemoryConfigurationSource定義快速加載配置信息的擴展方法，所以如果想加載這種類型的配置信息，則需要按照如下形式進行添加：

((IConfigurationSourceContainer)Configuration)        .Add(new MemoryConfigurationSource(            new List<KeyValuePair<string, string>> {                new KeyValuePair<string, string>("mem-key1", "mem-value1"),                new KeyValuePair<string, string>("mem-key2", "mem-value2")            }));//取值方式var someConfiguration1 = Configuration["mem-key1"];var someConfiguration2 = Configuration.Get("mem-key2");

添加IniFileConfigurationSource

IniFileConfigurationSource類型的配置信息可以通過擴展方法進行加載，代碼如下：

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

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

[ini-sec]ini-key1=value-aini-key2=value-b[ini-sec2]ini-key1=value-cini-key2=value-d

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

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

添加CommandLineConfigurationSource

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

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

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

var mappings = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase)    {        { "key1", "tom1" },        { "key2", "tom2" },    };

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

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

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

var value1 = Configuration.Get("key1");var value2 = Configuration["tom1"]; // tom1這個key的值其實就key1的值，因為tom1是key1的映射

1. 在映射的時候，新的映射key字符串里不能包括“/”字符，否則會報異常
2. 同樣的key不能傳入兩次，否則也會報異常
3. 加載配置信息時，如果有重復(fù)key，則后一個key的值會覆蓋前一個key的值。
4. 加載CommandLine配置信息時，如果一個key字符串以-作為前綴，那么就必須利用switchMapping將一個新key映射到舊key上，否則就會出錯。

添加EnvironmentVariablesConfigurationSource

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

取值方式如下：

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

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

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

舉例來說，定義一個開發(fā)環(huán)境的key/value如下：

Key => SQLCONNSTR_devlocalValue => Server=localhost;Database=test_db;Trusted_Connection=True;

通過AddEnvironmentVariables()的形式load完信息以后，我們則可以通過如下方式來訪問這項信息：

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

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

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

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

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

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

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

添加JsonConfigurationSource

在文章的開頭，我們看到了json配置文件的加載，加載該文件只需要使用.AddJsonFile("test.json")擴展方法即可，但不要忘記，要先在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_Connecti