解讀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文件，並且甚至能夠爲不一樣的環境（開發、測試、生產）設置不一樣的配置信息。整個配置機制的各個重要實體見下圖：

咱們來一一講述一下，這些類的具體做用：

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

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

1. MemoryConfigurationSource - 該配置源目前沒有內置的add/load擴展方法（好比AddMemoryConfiguration），但你能夠加載key/value類型的集合來實現此目的（如IEnumerable<KeyValuePair<string, string>>類型）。
2. IniFileConfigurationSource - 該配置源，能夠將基於key/value格式的INI文件配置信息加載到配置系統中。
3. CommandLineConfigurationSource - 將程序啓動時的命令行參數信息加載到配置系統中。
4. EnvironmentVariablesConfigurationSource - 將操做系統的環境變量信息加載到配置系統中，在Azure Website中，環境變量能夠經過web界面進行設置，管理至關方便。
5. JsonConfigurationSource - 將json文件的信息加載配置系統。
6. 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的映射

1. 在映射的時候，新的映射key字符串裏不能包括「/」字符，不然會報異常
2. 一樣的key不能傳入兩次，不然也會報異常
3. 加載配置信息時，若是有重複key，則後一個key的值會覆蓋前一個key的值。
4. 加載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、以及自定義連接字符串等等，但這些連接字符串須要以以下字符串開頭：

1. MySQL => MYSQLCONNSTR_
2. MS SQL => SQLCONNSTR_
3. SQL Azure DB => SQLAZURECONNSTR_
4. 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;

注意事項：

1. 在配置信息裏，全部的key都是不區分大小寫的，即key和KEY是同樣的。
2. 若是多個配置源有重複的key，則之後最後添加的配置源中的key所對應的值爲準。
3. IConfiguration下的GetSubKeys和GetSubKey能夠獲取某個層級（或以某個層級開頭的）的全部key列表。
4. 因爲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系列