.NET Core開發(fā)之配置詳解
熟悉ASP.NET的開發(fā)者一定對(duì)web.config文件不陌生。在ASP.NET環(huán)境中,要想添加配置參數(shù),一般也都會(huì)在此文件中操作。其中最常用的莫過于AppSettings與ConnectionStrings兩項(xiàng)。而要在代碼中獲得文件中的配置信息,ConfigurationManager則是必不可少需要引入的程序集。
然而到了ASP.NET Core時(shí)代,存儲(chǔ)與讀取配置的方式都發(fā)生了改變。
如果對(duì)ASP.NET Core項(xiàng)目有所了解的話,應(yīng)該會(huì)看到過appsettings.json這個(gè)文件。這里就從JSON文件配置方式開始解釋ASP.NET Core中是如何讀取配置信息的。
假設(shè)有預(yù)先設(shè)置的appsettings.json文件:
{
"option1": "value1_from_json",
"option2": 2,
"subsection": {
"suboption1": "subvalue1_from_json"
},
"wizards": [
{
"Name": "Gandalf",
"Age": "1000"
},
{
"Name": "Harry",
"Age": "17"
}
]
}
在代碼中讀取可以按下面的方式操作:
public class Program
{
public static IConfiguration Configuration { get; set; }
public static void Main(string[] args = null)
{
var builder = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("appsettings.json");
Configuration = builder.Build();
Console.WriteLine($"option1 = {Configuration["Option1"]}");
Console.WriteLine($"option2 = {Configuration["option2"]}");
Console.WriteLine(
$"suboption1 = {Configuration["subsection:suboption1"]}");
Console.WriteLine();
Console.WriteLine("Wizards:");
Console.Write($"{Configuration["wizards:0:Name"]}, ");
Console.WriteLine($"age {Configuration["wizards:0:Age"]}");
Console.Write($"{Configuration["wizards:1:Name"]}, ");
Console.WriteLine($"age {Configuration["wizards:1:Age"]}");
Console.WriteLine();
Console.WriteLine("Press a key...");
Console.ReadKey();
}
}
首先,實(shí)例化一個(gè)ConfigurationBuilder對(duì)象,接著設(shè)置基礎(chǔ)路徑。
SetBasePath的操作其實(shí)是在ConfigurationBuilder的屬性字典里設(shè)置FileProvider的值。
public static IConfigurationBuilder SetBasePath(this IConfigurationBuilder builder, string basePath)
{
...
return builder.SetFileProvider(new PhysicalFileProvider(basePath));
}
public static IConfigurationBuilder SetFileProvider(this IConfigurationBuilder builder, IFileProvider fileProvider)
{
...
builder.Properties[FileProviderKey] = fileProvider ?? throw new ArgumentNullException(nameof(fileProvider));
return builder;
}
然后是添加JSON文件。
public static IConfigurationBuilder AddJsonFile(this IConfigurationBuilder builder, IFileProvider provider, string path, bool optional, bool reloadOnChange)
{
...
return builder.AddJsonFile(s =>
{
s.FileProvider = provider;
s.Path = path;
s.Optional = optional;
s.ReloadOnChange = reloadOnChange;
s.ResolveFileProvider();
});
}
public static IConfigurationBuilder AddJsonFile(this IConfigurationBuilder builder, Action<JsonConfigurationSource> configureSource)
=> builder.Add(configureSource);
ConfigurationBuilder里添加了一個(gè)JsonConfigurationSource對(duì)象。
最后,執(zhí)行ConfigurationBuilder的Build方法,就可以得到保存配置信息的Configuration對(duì)象。
總結(jié)例子中的代碼,獲取配置信息的操作其實(shí)就分為兩步:
- 生成Configuration對(duì)象
- 按鍵值從Configuration對(duì)象中獲取信息
生成Configuration對(duì)象的步驟至少要有三個(gè)基礎(chǔ)環(huán)節(jié)。
- 生成ConfigurationBuilder對(duì)象
- 添加ConfigurationSource對(duì)象
創(chuàng)建Configuration對(duì)象
查看創(chuàng)建Configuration對(duì)象的代碼,會(huì)發(fā)現(xiàn)內(nèi)部利用的其實(shí)是ConfigurationSource中創(chuàng)建的ConfigurationProvider對(duì)象。
public IConfigurationRoot Build()
{
var providers = new List<IConfigurationProvider>();
foreach (var source in Sources)
{
var provider = source.Build(this);
providers.Add(provider);
}
return new ConfigurationRoot(providers);
}
再看IConfiguratonSource接口,也只有一個(gè)Build方法。
public interface IConfigurationSource
{
IConfigurationProvider Build(IConfigurationBuilder builder);
}
最終創(chuàng)建的Configuration對(duì)象,即ConfigurationRoot中包含了所有的ConfigurationProvider,說明配置信息都由這些ConfigurationProvider所提供。
跟蹤至ConfigurationRoot類型的構(gòu)造方法,果然在其生成對(duì)象時(shí),對(duì)所有ConfigurationProvider進(jìn)行了加載操作。
public ConfigurationRoot(IList<IConfigurationProvider> providers)
{
...
_providers = providers;
foreach (var p in providers)
{
p.Load();
ChangeToken.OnChange(() => p.GetReloadToken(), () => RaiseChanged());
}
}
比如JsonConfigurationProvider中:
public override void Load(Stream stream)
{
try
{
Data = JsonConfigurationFileParser.Parse(stream);
}
...
}
通過JSON解析器,將JSON文件的配置信息讀取至ConfigurationProvider的Data屬性中。這個(gè)屬性即是用于保存所有配置信息。
/// <summary>
/// The configuration key value pairs for this provider.
/// </summary>
protected IDictionary<string, string> Data { get; set; }
有了ConfigurationRoot對(duì)象后,獲取配置信息的操作就很簡(jiǎn)單了。遍歷各個(gè)ConfigurationProvider,從中獲取第一個(gè)匹配鍵值的數(shù)據(jù)。
public string this[string key]
{
get
{
foreach (var provider in _providers.Reverse())
{
string value;
if (provider.TryGet(key, out value))
{
return value;
}
}
return null;
}
...
}
ConfigurationProvider對(duì)象從Data屬性獲取配置的值。
public virtual bool TryGet(string key, out string value) => Data.TryGetValue(key, out value);
在最初的例子中可以看Configuration["wizards:0:Name"]這樣的寫法,這是因?yàn)樵贚oad文件時(shí),存儲(chǔ)的方式就是用:為分隔符,以作為嵌套對(duì)象的鍵值。
也可以用另一種方法來寫,將配置信息綁定為對(duì)象。
先定義對(duì)象類型:
public class AppSettings
{
public string Option1 { get; set; }
public int Option2 { get; set; }
public Subsection Subsection { get; set; }
public IList<Wizards> Wizards { get; set; }
}
public class Subsection
{
public string Suboption1 { get; set; }
}
public class Wizards
{
public string Name { get; set; }
public string Age { get; set; }
}
再綁定對(duì)象:
static void Main(string[] args)
{
var builder = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("appsettings.json");
Configuration = builder.Build();
var appConfig = new AppSettings();
Configuration.Bind(appConfig);
Console.WriteLine($"option1 = {appConfig.Option1}");
Console.WriteLine($"option2 = {appConfig.Option2}");
Console.WriteLine(
$"suboption1 = {appConfig.Subsection.Suboption1}");
Console.WriteLine();
Console.WriteLine("Wizards:");
Console.Write($"{appConfig.Wizards[0].Name}, ");
Console.WriteLine($"age {appConfig.Wizards[0].Age}");
Console.Write($"{appConfig.Wizards[1].Name}, ");
Console.WriteLine($"age {appConfig.Wizards[1].Age}");
Console.WriteLine();
Console.WriteLine("Press a key...");
Console.ReadKey();
}
寫法變成了常見的對(duì)象調(diào)用屬性方式,但結(jié)果是一樣的。
除了可以用JSON文件存儲(chǔ)配置信息外,ASP.NET Core同時(shí)也支持INI與XML文件。當(dāng)然有其它類型文件時(shí),也可以通過實(shí)現(xiàn)IConfigurationSource接口并繼承ConfigurationProvider類建立自定義的ConfigrationProvider對(duì)象來加載配置文件。
至于文件以外的方式,ASP.NET Core也提供了不少。
- 命令行,AddCommandLine
- 環(huán)境變量,AddEnvironmentVariables
- 內(nèi)存, AddInMemoryCollection
- 用戶機(jī)密,AddUserSecrets
- Azure Key Vault,AddAzureKeyVault
選擇何種存儲(chǔ)與讀取配置的方法取決于實(shí)際場(chǎng)景,ASP.NET Core已經(jīng)開放了配置方面的入口,任何接入方式理論上都是可行的。實(shí)踐方面,則需要開發(fā)者們不斷去嘗試與探索。
相關(guān)文章
C#調(diào)用dos窗口獲取相關(guān)信息的方法
這篇文章主要介紹了C#調(diào)用dos窗口獲取相關(guān)信息的方法,涉及C#調(diào)用dos窗口及進(jìn)程操作的相關(guān)技巧,具有一定參考借鑒價(jià)值,需要的朋友可以參考下2015-08-08
C#利用System.Threading.Thread.Sleep即時(shí)輸出信息的詳解
本篇文章是對(duì)C#利用System.Threading.Thread.Sleep即時(shí)輸出信息進(jìn)行了詳細(xì)的分析介紹,需要的朋友參考下2013-06-06
C#中比較常用的DateTime結(jié)構(gòu)的使用方法
這篇文章主要介紹了C#中比較常用的DateTime結(jié)構(gòu)的使用方法,需要的朋友可以參考下2015-11-11
WPF開發(fā)之實(shí)現(xiàn)一種三軸機(jī)械手控件
這篇文章主要為大家詳細(xì)介紹了如何利用WPF實(shí)現(xiàn)簡(jiǎn)單一種三軸機(jī)械手控件,文中的示例代碼講解詳細(xì),對(duì)我們學(xué)習(xí)或工作有一定幫助,感興趣的小伙伴可以了解一下2023-01-01
C# 設(shè)計(jì)模式系列教程-簡(jiǎn)單工廠模式
簡(jiǎn)單工廠模式職責(zé)單一,實(shí)現(xiàn)簡(jiǎn)單,且實(shí)現(xiàn)了客戶端代碼與具體實(shí)現(xiàn)的解耦。2016-06-06
C#進(jìn)行圖像處理的常見方法(Bitmap,BitmapData,IntPtr)使用詳解
這篇文章主要為大家詳細(xì)介紹了C#進(jìn)行圖像處理的幾個(gè)常見方法(Bitmap,BitmapData,IntPtr)具體使用,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以了解下2024-01-01

