ASP.NET Core配置教程之讀取配置信息

提到“配置”二字，我想絕大部分.NET開(kāi)發(fā)人員腦海中會(huì)立馬浮現(xiàn)出兩個(gè)特殊文件的身影，那就是我們?cè)偈煜げ贿^(guò)的app.config和web.config，多年以來(lái)我們已經(jīng)習(xí)慣了將結(jié)構(gòu)化的配置信息定義在這兩個(gè)文件之中。到了.NET Core的時(shí)候，很多我們習(xí)以為常的東西都發(fā)生了改變，其中也包括定義配置的方式?？偟膩?lái)說(shuō)，新的配置系統(tǒng)顯得更加輕量級(jí)，并且具有更好的擴(kuò)展性，其最大的特點(diǎn)就是支持多樣化的數(shù)據(jù)源。我們可以采用內(nèi)存的變量作為配置的數(shù)據(jù)源，也可以直接配置定義在持久化的文件甚至數(shù)據(jù)庫(kù)中。

由于很多人都不曾接觸過(guò)這個(gè)采用全新設(shè)計(jì)的配置系統(tǒng)，為了讓大家對(duì)此有一個(gè)感官的認(rèn)識(shí)，我們先從編程的角度對(duì)它作一個(gè)初體驗(yàn)。針對(duì)配置的API涉及三個(gè)對(duì)象，它們分別是Configuration、ConfigurationBuilder和ConfigurationProvider，配置模型中具有相應(yīng)的接口來(lái)表示它們。這三個(gè)對(duì)象之間的關(guān)系很清晰，Configuration對(duì)象承載著在編程過(guò)程中使用的配置信息，ConfigurationProvider則是配置信息原始數(shù)據(jù)源的提供者，兩者之間溝通由ConfigurationBuilder來(lái)完成，它利用ConfigurationProvider提取源數(shù)據(jù)將其轉(zhuǎn)換為Configuration對(duì)象。

一、以鍵-值對(duì)的形式讀取配置
雖然在大部分情況下的配置信息從整體來(lái)說(shuō)都具有一個(gè)結(jié)構(gòu)化的層次關(guān)系，但是“原子”配置項(xiàng)都以最簡(jiǎn)單的“鍵-值對(duì)”的形式來(lái)體現(xiàn)，并且鍵和值都是字符串，接下來(lái)我們會(huì)通過(guò)一個(gè)簡(jiǎn)單的實(shí)例來(lái)演示如何以鍵值對(duì)的形式來(lái)讀取配置。我們創(chuàng)建一個(gè)針對(duì)ASP.NET Core的控制臺(tái)應(yīng)用，并在project.json中按照如下的方式添加針對(duì)“Microsoft.Extensions.Configuration”這個(gè)NuGet包的依賴，配置模型就實(shí)現(xiàn)在這個(gè)包中。

{
 ...
 "dependencies": {
 "Microsoft.Extensions.Configuration": "1.0.0-rc1-final"
 },
 }

假設(shè)我們的應(yīng)用需要通過(guò)配置來(lái)設(shè)定日期/時(shí)間的顯示格式，為此我們定義了如下一個(gè)DateTimeFormatSettings類，它的四個(gè)屬性體現(xiàn)了DateTime對(duì)象的四種顯示格式（分別為長(zhǎng)日期/時(shí)間和短日期/時(shí)間）。

public class DateTimeFormatSettings
 {
 public string LongDatePattern { get; set; }
 public string LongTimePattern { get; set; }
 public string ShortDatePattern { get; set; }
 public string ShortTimePattern { get; set; }
 //其他成員
 }

我們希望通過(guò)配置的形式來(lái)控制由DateTimeFormatSettings的四個(gè)屬性體現(xiàn)的日期/時(shí)間顯示格式，所以我們?yōu)樗x了一個(gè)構(gòu)造函數(shù)。如下面的代碼片段所示，該構(gòu)造函數(shù)具有一個(gè)IConfiguration接口類型的參數(shù)，它正式承載相關(guān)配置信息的Configuration對(duì)象。我們調(diào)用Configuration對(duì)象的索引并指定相應(yīng)配置項(xiàng)的Key來(lái)得到其Value。

public class DateTimeFormatSettings
 {
 //其他成員
 public DateTimeFormatSettings (IConfiguration configuration)
 {
 this.LongDatePattern = configuration["LongDatePattern"];
 this.LongTimePattern = configuration["LongTimePattern"];
 this.ShortDatePattern = configuration["ShortDatePattern"];
 this.ShortTimePattern = configuration["ShortTimePattern"];
 }
 }

要?jiǎng)?chuàng)建一個(gè)體現(xiàn)當(dāng)前配置的DateTimeFormatSettings對(duì)象，我們必須向得到這個(gè)承載相關(guān)配置信息的Configuration對(duì)象。正如我們上面所說(shuō)，Configuration對(duì)象是由ConfigurationBuilder創(chuàng)建的，而原始的配置信息則是通過(guò)相應(yīng)的ConfigurationProvider來(lái)讀取的，所以創(chuàng)建一個(gè)Configuration對(duì)象的正確編程方式是先創(chuàng)建一個(gè)ConfigurationBuilder對(duì)象，然后為之添加一個(gè)或者多個(gè)ConfigurationProvider對(duì)象，最后利用ConfigurationBuilder來(lái)創(chuàng)建我們需要的Configuration對(duì)象。

按照上述的編程模式，我們?cè)谝粋€(gè)控制臺(tái)應(yīng)用中編寫(xiě)了如下的程序。我們創(chuàng)建了一個(gè)類型為ConfigurationBuilder的對(duì)象，調(diào)用其Add方法添加的ConfigurationProvider是一個(gè)類型為MemoryConfigurationProvider的對(duì)象。顧名思義，MemoryConfigurationProvider利用內(nèi)存中的對(duì)象來(lái)提供原始的配置信息，具體來(lái)說(shuō)這些原始的配置信息保存在一個(gè)元素類型為KeyValuePair<string, string>的集合之中。我們最終調(diào)用ConfigurationBuilder的Build方法獲取用于創(chuàng)建DateTimeFormatSettings對(duì)象所需的Configuration。

public class Program
 {
 public static void Main(string[] args)
 {
 Dictionary<string, string> source = new Dictionary<string, string>
 {
 ["LongDatePattern"] = "dddd, MMMM d, yyyy",
 ["LongTimePattern"] = "h:mm:ss tt",
 ["ShortDatePattern"] = "M/d/yyyy",
 ["ShortTimePattern"] = "h:mm tt"
 };
 IConfiguration configuration = new ConfigurationBuilder()
 .Add(new MemoryConfigurationProvider(source))
 .Build();
 
 DateTimeFormatSettings settings = new DateTimeFormatSettings(configuration);
 Console.WriteLine("{0,-16}: {1}", "LongDatePattern", settings.LongDatePattern);
 Console.WriteLine("{0,-16}: {1}", "LongTimePattern", settings.LongTimePattern);
 Console.WriteLine("{0,-16}: {1}", "ShortDatePattern", settings.ShortDatePattern);
 Console.WriteLine("{0,-16}: {1}", "ShortTimePattern", settings.ShortTimePattern);
 }
 }

為了驗(yàn)證根據(jù)配置創(chuàng)建的DateTimeFormatSettings對(duì)象與配置原始數(shù)據(jù)之間的關(guān)系，我們將它的四個(gè)屬性輸出于控制臺(tái)上。當(dāng)這個(gè)程序執(zhí)行之后將在控制臺(tái)上產(chǎn)生如下所示的輸出，可以看出它正是我們提供的配置的真實(shí)反映。
 LongDatePattern : dddd, MMMM d, yyyy
 LongTimePattern : h:mm:ss tt
 ShortDatePattern: M/d/yyyy
 ShortTimePattern: h:mm tt

二、 讀取結(jié)構(gòu)化的配置
真實(shí)項(xiàng)目中涉及的配置大都具有一個(gè)結(jié)構(gòu)化的層次結(jié)構(gòu)，所以在配置模型中的Configuration對(duì)象同樣具有這樣的結(jié)構(gòu)。結(jié)構(gòu)化的配置具有一個(gè)樹(shù)形層次結(jié)構(gòu)，而一個(gè)Configuration對(duì)象表示的是組成這棵配置樹(shù)的某個(gè)節(jié)點(diǎn)，這棵配置樹(shù)則可以通過(guò)作為根節(jié)點(diǎn)的Configuration對(duì)象來(lái)體現(xiàn)。體現(xiàn)為鍵值對(duì)的原子配置項(xiàng)一般至存在于作為葉子節(jié)點(diǎn)的Configuration對(duì)象中，非葉子節(jié)點(diǎn)的Configuration包含一組子節(jié)點(diǎn)，而每個(gè)子節(jié)點(diǎn)同樣是一個(gè)Configuration對(duì)象。

接下來(lái)我們同樣以實(shí)例的方式來(lái)演示如何定義并讀取具有層次化結(jié)構(gòu)的配置。我們依然沿用上一節(jié)的應(yīng)用場(chǎng)景，現(xiàn)在我們不僅僅需要設(shè)置日期/時(shí)間的格式，還需要設(shè)置其他數(shù)據(jù)類型的格式，比如表示貨幣的Decimal類型。為此我們定義了如下一個(gè)CurrencyDecimalFormatSettings類，它的屬性Digits和Symbol分別表示小數(shù)位數(shù)和貨幣符號(hào)，一個(gè)CurrencyDecimalFormatSettings對(duì)象依然是利用一個(gè)表示配置的Configuration對(duì)象來(lái)創(chuàng)建的。

 {
 public int Digits { get; set; }
 public string Symbol { get; set; }
 
 public CurrencyDecimalFormatSettings(IConfiguration configuration)
 {
 this.Digits = int.Parse(configuration["Digits"]);
 this.Symbol = configuration["Symbol"];
 }
 }

我們定義了另一個(gè)名為FormatSettings的類型來(lái)表示針對(duì)不同數(shù)據(jù)類型的格式設(shè)置。如下面的代碼片段所示，它的兩個(gè)屬性DateTime和CurrencyDecimal分別表示針對(duì)日期/時(shí)間和貨幣數(shù)字的格式設(shè)置。FormatSettings依然具有一個(gè)參數(shù)類型為IConfiguration接口的構(gòu)造函數(shù)，它的兩個(gè)屬性均在此構(gòu)造函數(shù)中被初始化。值得注意的是初始化這兩個(gè)屬性采用的是當(dāng)前Configuration的“子配置節(jié)”，通過(guò)指定配置節(jié)名稱調(diào)用GetSection方法獲得。

public class FormatSettings
{
 public DateTimeFormatSettings DateTime { get; set; }
 public CurrencyDecimalFormatSettings CurrencyDecimal { get; set; }
 
 public FormatSettings(IConfiguration configuration)
 {
 this.DateTime = new DateTimeFormatSettings(configuration.GetSection("DateTime"));
 this.CurrencyDecimal = new CurrencyDecimalFormatSettings(configuration.GetSection("CurrencyDecimal"));
 }
}

在我們上面演示的實(shí)例中，我們通過(guò)以一個(gè)MemoryConfigurationProvider對(duì)象來(lái)提供原始的配置信息。由于承載原始配置信息的是一個(gè)元素類型為KeyValuePair<string, string>的集合，所以原始配置在物理存儲(chǔ)上并不具有樹(shù)形化的層次結(jié)構(gòu)，那么它如何能夠最終提供一個(gè)結(jié)構(gòu)化的Configuration對(duì)象呢？其實(shí)很簡(jiǎn)單，雖然MemoryConfigurationProvider對(duì)象只能將配置信息存儲(chǔ)為簡(jiǎn)單的“數(shù)據(jù)字典”，但是如果將Configuration對(duì)象在配置樹(shù)中體現(xiàn)的路徑作為Key，這個(gè)數(shù)據(jù)字典在邏輯上實(shí)際上就具有了一棵樹(shù)的結(jié)構(gòu)。實(shí)際上MemoryConfigurationProvider就是這么做的，這體現(xiàn)在我們?nèi)缦滤镜某绦蛑小?br />

class Program
 {
 static void Main(string[] args)
 {
 Dictionary<string, string> source = new Dictionary<string, string>
 {
 ["Format:DateTime:LongDatePattern"] = "dddd, MMMM d, yyyy",
 ["Format:DateTime:LongTimePattern"] = "h:mm:ss tt",
 ["Format:DateTime:ShortDatePattern"] = "M/d/yyyy",
 ["Format:DateTime:ShortTimePattern"] = "h:mm tt",
 
 ["Format:CurrencyDecimal:Digits"] = "2",
 ["Format:CurrencyDecimal:Symbol"] = "$",
 };
 IConfiguration configuration = new ConfigurationBuilder()
 .Add(new MemoryConfigurationProvider(source))
 .Build();
 
 FormatSettings settings = new FormatSettings(configuration.GetSection("Format"));
 Console.WriteLine("DateTime:");
 Console.WriteLine("\t{0,-16}: {1}", "LongDatePattern", settings.DateTime.LongDatePattern);
 Console.WriteLine("\t{0,-16}: {1}", "LongTimePattern", settings.DateTime.LongTimePattern);
 Console.WriteLine("\t{0,-16}: {1}", "ShortDatePattern", settings.DateTime.ShortDatePattern);
 Console.WriteLine("\t{0,-16}: {1}\n", "ShortTimePattern", settings.DateTime.ShortTimePattern);
 
 Console.WriteLine("CurrencyDecimal:");
 Console.WriteLine("\t{0,-16}: {1}", "Digits", settings.CurrencyDecimal.Digits);
 Console.WriteLine("\t{0,-16}: {1}", "Symbol", settings.CurrencyDecimal.Symbol);
 }
}

如上面的代碼片段所示，創(chuàng)建MemoryConfigurationProvider對(duì)象采用的字典對(duì)象包含6個(gè)基本的配置項(xiàng)，為了讓它們?cè)谶壿嬌暇哂幸粋€(gè)樹(shù)形化層次結(jié)構(gòu)，所以的Key實(shí)際上體現(xiàn)了每個(gè)配置項(xiàng)所在配置節(jié)在配置樹(shù)中的路徑，路徑采用冒號(hào)（“：”）進(jìn)行分割。改程序執(zhí)行之后會(huì)在控制臺(tái)上呈現(xiàn)如下所示的輸出結(jié)果。

DateTime:
 LongDatePattern : dddd, MMMM d, yyyy
 LongTimePattern : h:mm:ss tt
 ShortDatePattern: M/d/yyyy
 ShortTimePattern: h:mm tt
 
 CurrencyDecimal:
 Digits : 2
 Symbol : $

三、將結(jié)構(gòu)化配置直接綁定為對(duì)象
在真正的項(xiàng)目開(kāi)發(fā)過(guò)程中，我們都不會(huì)直接使用直接讀取的配置，而都傾向于像我們演示的兩個(gè)實(shí)例一樣通過(guò)創(chuàng)建相應(yīng)的類型（比如DateTimeFormatSettings、CurrencyDecimalSettings和FormatSettings）來(lái)定義一組相關(guān)的配置選項(xiàng)（Option），我們將定義配置選項(xiàng)（Option）的這些類型稱為Option類型。在上面演示的實(shí)例中，為了創(chuàng)建這些封裝配置的對(duì)象，我們都是采用手工讀取配置的形式，如果定義的配置項(xiàng)太多的話，逐條讀取配置項(xiàng)其實(shí)是一項(xiàng)非常繁瑣的工作。

對(duì)于一個(gè)對(duì)象來(lái)說(shuō)，如果我們將它的屬性視為它的子節(jié)點(diǎn)，一個(gè)對(duì)象同樣具有類似于Configuration對(duì)象的樹(shù)形層次化結(jié)構(gòu)。如果我們根據(jù)某個(gè)Option類型的結(jié)構(gòu)來(lái)定義配置，或者反過(guò)來(lái)根據(jù)配置的結(jié)構(gòu)來(lái)定義這個(gè)Option類型，那么Option類型的屬性成員將與某個(gè)配置節(jié)具有一一對(duì)應(yīng)的關(guān)系，那么原則上我們可以自動(dòng)將配置信息綁定為一個(gè)具體的Option對(duì)象。

ASP.NET Core針對(duì)配置的Option模型（OptionModel）幫助我們實(shí)現(xiàn)了從配置到Option對(duì)象之間的綁定，接下來(lái)我們就對(duì)此做一個(gè)簡(jiǎn)單的演示。Option模型實(shí)現(xiàn)在“Microsoft.Extensions.OptionModel”這個(gè)NuGet包中，除此之外，我們需要采用依賴注入的方式來(lái)使用Option模型，所以我們需要按照如下的方式為應(yīng)用添加針對(duì)相應(yīng)的依賴。

 {
 ...
 "dependencies": {
 "Microsoft.Extensions.OptionsModel" : "1.0.0-rc1-final",
 "Microsoft.Extensions.DependencyInjection" : "1.0.0-rc1-final"
 },
 }

借助于Option模型的自動(dòng)綁定機(jī)制，我們無(wú)需再手工地讀取配置信息，所以我們將FormatSettings、DateTimeFormatSettings和CurrencyDecimalSettings的構(gòu)造函數(shù)刪除，只保留其屬性成員。在作為程序入口的Main方法中，我們采用如下的方式創(chuàng)建這個(gè)表示格式設(shè)置的FormatSettings對(duì)象。

 class Program
{
 static void Main(string[] args)
 {
 Dictionary<string, string> source = new Dictionary<string, string>
 {
 ["Format:DateTime:LongDatePattern"] = "dddd, MMMM d, yyyy",
 ["Format:DateTime:LongTimePattern"] = "h:mm:ss tt",
 ["Format:DateTime:ShortDatePattern"] = "M/d/yyyy",
 ["Format:DateTime:ShortTimePattern"] = "h:mm tt",
 
 ["Format:CurrencyDecimal:Digits"] = "2",
 ["Format:CurrencyDecimal:Symbol"] = "$",
 };
 IConfiguration configuration = new ConfigurationBuilder()
 .Add(new MemoryConfigurationProvider(source))
 .Build()
 .GetSection("Format"));
 
 IOptions<FormatSettings> optionsAccessor = new ServiceCollection()
 .AddOptions()
 .Configure<FormatSettings>(configuration)
 .BuildServiceProvider()
 .GetService<IOptions<FormatSettings>>();
 
 FormatSettings settings = optionsAccessor.Value;
 
 Console.WriteLine("DateTime:");
 Console.WriteLine("\t{0,-16}: {1}", "LongDatePattern",settings.DateTime.LongDatePattern);
 Console.WriteLine("\t{0,-16}: {1}", "LongTimePattern",settings.DateTime.LongTimePattern);
 Console.WriteLine("\t{0,-16}: {1}", "ShortDatePattern",settings.DateTime.ShortDatePattern);
 Console.WriteLine("\t{0,-16}: {1}\n", "ShortTimePattern",settings.DateTime.ShortTimePattern);
 
 Console.WriteLine("CurrencyDecimal:");
 Console.WriteLine("\t{0,-16}: {1}", "Digits",settings.CurrencyDecimal.Digits);
 Console.WriteLine("\t{0,-16}: {1}", "Symbol",settings.CurrencyDecimal.Symbol);
 }
 }

如上面的代碼片段所示，我們創(chuàng)建一個(gè)ServiceCollection對(duì)象并調(diào)用擴(kuò)展方法AddOptions注冊(cè)于針對(duì)Option模型的服務(wù)。接下來(lái)我們調(diào)用Configure方法將FormatSettings這個(gè)Option類型與對(duì)應(yīng)的Configuration對(duì)象進(jìn)行映射。我們最后利用這個(gè)ServiceCollection對(duì)象生成一個(gè)ServiceProvider，并調(diào)用其GetService方法得到一個(gè)類型為IOptions<FormatSettings>的對(duì)象，后者的Value屬性返回的就是綁定了相關(guān)配置的FormatSettings對(duì)象。

聲明：本網(wǎng)頁(yè)內(nèi)容旨在傳播知識(shí)，若有侵權(quán)等問(wèn)題請(qǐng)及時(shí)與本網(wǎng)聯(lián)系，我們將在第一時(shí)間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com