解讀ASP.NET 5 & MVC6系列（5）：Configuration配置資訊管理
在前面的章節中，我們知道新版的MVC程式拋棄了原來的web.config檔案機制，取而代替的是config.json，今天我們就來深入研究一下配置檔案的相關內容。
基本用法
新版的配置資訊機制在Microsoft.Framework.ConfigurationModel名稱空間下進行了重寫，重寫以後不僅支援XML格式，還支援json、ini、環境變數等。在模板示例程式中Startup類的建構函式內如，有如下語句：
// Setup configuration sources. Configuration = new Configuration() .AddJsonFile("config.json") .AddEnvironmentVariables();
該語句的作用是將config.json檔案以及環境變數資訊加入到配置資訊容器裡，以便進行讀取。而讀取的時候則可以通過集合索引的形式或Get方法進行讀取，示例如下：
var path = Configuration["Path"];
var path = Configuration.Get("Path");其中，多層級key鍵的讀取，需要在多個層級名稱之間用冒號分割即可，示例如下：
var connString = Configuration.Get("Data:DefaultConnection:ConnectionString");通過上述幾段程式碼可以看出，該配置示例並不是全域性例項，所以要想在別的地方也讀取這些資訊，就需要將該例項儲存在一個全域性靜態變數上。
架構設計
新的配置資訊處理機制，在重寫以後，更加輕量級，而且是進行跨平臺使用，可以從多個數據源獲取配置資訊，而不必在拘泥於.config檔案，而且甚至可以為不同的環境（開發、測試、生產）設定不同的配置資訊。整個配置機制的各個重要實體見下圖：
我們來一一講述一下，這些類的具體作用：
IConfiguration- 配置資訊的例項介面，該介面上的indexer、Get、TryGet、Set以及其它一些像Reload這樣的方法一起用於獲取基於key/value的配置資訊。IConfigurationSource- 該介面統一了各個配置源使用時的介面方法，比如TryGet、Set以及最重要的讀取配置資訊的load方法，以便將資訊載入到配置子系統裡。IConfigurationSourceContainer- 所有配置源資訊的一個容器，該容器使得可以在一個單獨的Configuration例項上載入各種配置源的配置資訊。該介面只有一個Add方法用於新增基於IConfigurationSource的配置源資訊。Configuration- 該類實現了IConfiguration介面和IConfigurationSourceContainer介面，不儲存基於key/value的所有型別的配置資訊。ConfigurationExtensions- 擴充套件方法，用於快速載入配置資訊，如AddCommandLine、AddIniFile等。
在Microsoft.Framework.ConfigurationModel名稱空間下，目前有6種不同型別的配置源型別可以使用，分別如下：
MemoryConfigurationSource- 該配置源目前沒有內建的add/load擴充套件方法（比如AddMemoryConfiguration），但你可以載入key/value型別的集合來實現此目的（如IEnumerable<KeyValuePair<string, string>>型別）。IniFileConfigurationSource- 該配置源，可以將基於key/value格式的INI檔案配置資訊載入到配置系統中。CommandLineConfigurationSource- 將程式啟動時的命令列引數資訊載入到配置系統中。EnvironmentVariablesConfigurationSource- 將作業系統的環境變數資訊載入到配置系統中，在Azure Website中，環境變數可以通過web介面進行設定，管理相當方便。JsonConfigurationSource- 將json檔案的資訊載入配置系統。XmlconfigurationSource- 將xml檔案的資訊載入到配置系統。
詳細用法
首先，由於配置系統是多例項型的，所以每次使用之前都要先宣告一個示例，程式碼如下：
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-a
ini-key2=value-b
[ini-sec2]
ini-key1=value-c
ini-key2=value-d這裡的[ini-sec]是自定義的配置節名稱，每個配置節下面可以配置多個key/value項。取值方式和基本示例中的一樣，層級之間（本例是配置節和key之間）要用冒號分割，示例如下：
var someConfiguration1 = Configuration["ini-sec:ini-key1"];
var someConfiguration2 = Configuration.Get("ini-sec2:ini-key2");新增CommandLineConfigurationSource
在程式使用k run命名進行時傳入的引數，可以通過該配置源進行讀取，或者你也可以通過AddCommandLine擴充套件方法手工新增，示例如下：
var configuration = new Configuration().AddCommandLine(new string[] { "key1=value1", "key2=value2", "@key3=value3" });上述示例中的每個字串都要是key/value格式，可以使用少於的特殊符號比如$、/等。 針對這些key值，你也可以使用帶有switchMappings引數建構函式的CommandLineConfigurationSource類來對映某些key，switchMappings引數的資料型別和示例如下：
var mappings = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase)
{
{ "key1", "tom1" },
{ "key2", "tom2" },
};由於當前沒有針對CommandLineConfigurationSource類的擴充套件方法，所以我們還是需要自己例項化該類，並新增到配置容器中，程式碼如下：
((IConfigurationSourceContainer)Configuration).Add(new CommandLineConfigurationSource(commandLineArguments, switchMappings: mappings));執行上述程式碼以後，在獲取配置值的時候，如下兩個key的值是一樣的：
var value1 = Configuration.Get("key1");
var value2 = Configuration["tom1"]; // tom1這個key的值其實就key1的值，因為tom1是key1的對映
- 在對映的時候，新的對映key字串裡不能包括“/”字元，否則會報異常
- 同樣的key不能傳入兩次，否則也會報異常
- 載入配置資訊時，如果有重複key，則後一個key的值會覆蓋前一個key的值。
- 載入CommandLine配置資訊時，如果一個key字串以-作為字首，那麼就必須利用switchMapping將一個新key對映到舊key上，否則就會出錯。
新增EnvironmentVariablesConfigurationSource
ironmentVariablesConfigurationSource可以將作業系統的環境變數新增到配置系統中，同時你也可以對這些環境變數進行自定義，比如在VS開發除錯的時候，可以在如下介面新增一些key/value：
取值方式如下：
var someConfiguration1 = Configuration["env_var_key1"];
var someConfiguration2 = Configuration["env_var_key2"];另外，該配置源也支援Azure環境變數和連線字串，所以你也可以在Azure介面裡設定MSSQL、MYSQL、以及自定義連結字串等等，但這些連結字串需要以如下字串開頭：
- MySQL =>
MYSQLCONNSTR_ - MS SQL =>
SQLCONNSTR_ - SQL Azure DB =>
SQLAZURECONNSTR_ - Custom DB =>
CUSTOMCONNSTR_
舉例來說，定義一個開發環境的key/value如下：
Key => SQLCONNSTR_devlocal
Value => Server=localhost;Database=test_db;Trusted_Connection=True;通過AddEnvironmentVariables()的形式load完資訊以後，我們則可以通過如下方式來訪問這項資訊：
var connString = Configuration["Data:devlocal:ConnectionString"];也就是說，在Azure裡，環境變數的key會轉換成Data:自定義識別符號:ConnectionString這樣的格式。如果你的key不是自定義key（以CUSTOMCONNSTR_開頭）的話，你可以用如下方式獲取連線字串的provider名稱，示例如下：
var providerName = Configuration["Data:devlocal:ProviderName"];
/// 返回：System.Data.SqlClientEnvironmentVariablesConfigurationSource另外還提供一種字首過濾的方式載入部分資訊，比如：
((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檔案內容如下：
{
"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"
}
}
}那你就可以利用如下方式來訪問連結字串：
var conn = Configuration["Data:DefaultConnection:ConnectionString"];新增XmlconfigurationSource
XmlconfigurationSource配置源和JsonConfigurationSource配置源類似，首先引用Microsoft.Framework.ConfigurationModel.Xml程式集，然後呼叫.AddXmlFile("test.xml")。
如果你的配置檔案test.xml的內容如下：
<root>
<key1>Jsinh</key1>
<key2 subkey2="Hello world" />
</root>獲取形式，則稍有有些區別（會忽略根節點root）：
var s1 = Configuration["key1"]; // 返回Jsinh
var s2 = Configuration["key2:subkey2"]; // 返回 Hello world但是要注意，通用的key不能重複宣告，下面的檔案在讀取的時候就會出錯。
<root>
<key1>Jsinh</key1>
<key2 subkey2="Hello world" />
<key2 subkey2="Hello world again" />
</root>敏感資訊配置（RC版新增功能）
在RC版釋出以後，微軟又新增了一種敏感資訊配置實現，程式集為Microsoft.Framework.ConfigurationModel.UserSecrets，通過該程式集的管理，我們可以將敏感的配置資訊放在計算機的特殊目錄下的secrets.json檔案，其目錄定義規則如下：
Windows: %APPDATA%\microsoft\UserSecrets\<applicationId>\secrets.json
Linux: ~/.microsoft/usersecrets/<applicationId>\secrets.json
Mac: ~/.microsoft/usersecrets/<applicationId>\secrets.json我們來舉例操作一下，首先，右鍵解決方案選擇Manage User Secret，VS會自動給該程式建立一個applicationId，並保持在·project.json·檔案中，示例如下：
{
"userSecretsId": "aspnet5-WebDemo01-20150430014447",
"webroot": "wwwroot",
"version": "1.0.0-*",
}接著會自動開啟%APPDATA%\Microsoft\UserSecrets\aspnet5-WebDemo01-20150430014447\secrets.json檔案，我們輸入一個示例配置：
{
"AA": {
"BB": "CC"
}
}然後，我們在project.json檔案裡引用了上述程式集，再通過配置檔案的統一方式進行註冊，程式碼如下：
Configuration = new Configuration()
.AddJsonFile("config.json")
.AddEnvironmentVariables()
.AddUserSecrets(); // AddUserSecrets是新增敏感資訊的擴充套件方法然後就可以想普通的呼叫方法一下呼叫了，示例如下：
var data = Configuration["AA:BB"]; // 結果：CC通過這種方式，我們就可以將生產環境的配置資訊放在隱私的位置了。
自定義配置源
通過以上示例以及檢視其架構設計機制，我們可以發現，其實我們還可以自定義自己的配置源，比如我想從資料庫中讀取響應的配置資訊，那我們只要定義一個DBConfigurationSource，並繼承於ConfigurationSource即可，實現響應的Load過載即可。
public class DBConfigurationSource : BaseConfigurationSource
{
public override void Load()
{
// 讀取資料庫所有的key/value，並將其賦值給IDictionary<string, string>型別的Data資料
}
}如果你不把資料儲存在Data屬性裡，那麼你還要實現如下幾個過載，以便從自己的私有資料集合裡獲取響應的值，比如從快取中獲取，示例如下：
public class DBConfigurationSource : BaseConfigurationSource
{
public override void Load()
{
// 讀取資料庫所有的key/value，儲存在私有變數_data中
}
public override void Set(string key, string value)
{
// 更新資料庫key對應的值
// base.Set(key, value);
}
public override bool TryGet(string key, out string value)
{
// 從私有變數_data中獲取key對應的value
// return base.TryGet(key, out value);
}
public override IEnumerable<string> ProduceSubKeys(IEnumerable<string> earlierKeys, string prefix, string delimiter)
{
// 私有變數_data中，根據自己的機制返回響應的SubKeys
// return base.ProduceSubKeys(earlierKeys, prefix, delimiter);
}
}實現完上述類以後，再為自己建立一個擴充套件方法用於新增DB配置資訊，程式碼如下：
public static class CatsConfigurationExtensions
{
public static IConfigurationSourceContainer AddDBConfiguration(this IConfigurationSourceContainer configuration)
{
configuration.Add(new DBConfigurationSource());
return configuration;
}
}就可以通過.AddDBConfiguration()來新增DB配置源了。
注意，DB配置源需要使用資料庫連線字串，這一點需要注意（獲取可以先從json配置檔案獲取連線字串，然後再新增該配置源）。
配置資訊遍歷
在預設的配置源實現中，所有的類都繼承於ConfigurationSource，並且將資訊資料儲存在Data屬性中，所以如果要遍歷這些資料，則需要將其轉換為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]);
}
}配置資訊直接轉換為實體類
在IServiceCollection介面上還有一個擴充套件方法.Configure<T>可以將型別IConfiguration的資料轉換為一個實體類，該擴充套件方法的定義如下：
public static IServiceCollection Configure<TOptions>(this IServiceCollection services, IConfiguration config, int order = -1000, string optionsName = "");舉個例子，如果我們定義如下一個實體：
public class AppSettings
{
public string SiteTitle { get; set; }
}然後在config.json裡定義一個相同結構的配置資訊，示例如下：
{
"AppSettings": {
"SiteTitle": "WebDemo01"
}
}那麼通過在Startup的建構函式將配置資訊載入以後，我們就可以將該資訊賦值給AppSettings例項，程式碼如下：
services.Configure<AppSettings>(Configuration.GetSubKey("AppSettings"));用的時候，使用ApplicationServices的GetRequiredService方法即可，示例如下：
var appSettings = app.ApplicationServices.GetRequiredService<IOptions<AppSettings>>().Options;注意事項：
- 在配置資訊裡，所有的key都是不區分大小寫的，即key和KEY是一樣的。
- 如果多個配置源有重複的key，則以後最後新增的配置源中的key所對應的值為準。
IConfiguration下的GetSubKeys和GetSubKey可以獲取某個層級（或以某個層級開頭的）的所有key列表。- 由於
Configuration是多例項的，所以按照示例中的程式碼，該例項在Startup裡初始化以後，其它類就無法訪問了，所以如果要做全域性性的訪問，最好在初始化之後將其儲存到一個靜態變數中。
參考1：https://github.com/aspnet/Configuration
參考2：http://blog.jsinh.in/asp-net-5-configuration-microsoft-framework-configurationmodel/#.VSdjUpOxxzw