解讀ASP.NET 5 & MVC6系列（5）：Configuration配置信息管理
2015-05-18 07:44 湯姆大叔 閱讀(19333) 評論(19) 收藏 舉報在前面的章節中，我們知道新版的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.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文件內容如下：
{
"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
同步與推薦
本文已同步至目錄索引：解讀ASP.NET 5 & MVC6系列
浙公網安備 33010602011771號