.NET Core開發之配置詳解

2020-01-24 00:16:04

字體：大中小

來源：轉載

供稿：網友

熟悉ASP.NET的開發者一定對web.config文件不陌生。在ASP.NET環境中，要想添加配置參數，一般也都會在此文件中操作。其中最常用的莫過于AppSettings與ConnectionStrings兩項。而要在代碼中獲得文件中的配置信息，ConfigurationManager則是必不可少需要引入的程序集。

然而到了ASP.NET Core時代，存儲與讀取配置的方式都發生了改變。

如果對ASP.NET Core項目有所了解的話，應該會看到過appsettings.json這個文件。這里就從JSON文件配置方式開始解釋ASP.NET Core中是如何讀取配置信息的。

假設有預先設置的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();  }}

首先，實例化一個ConfigurationBuilder對象，接著設置基礎路徑。

SetBasePath的操作其實是在ConfigurationBuilder的屬性字典里設置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里添加了一個JsonConfigurationSource對象。

最后，執行ConfigurationBuilder的Build方法，就可以得到保存配置信息的Configuration對象。

總結例子中的代碼，獲取配置信息的操作其實就分為兩步:

生成Configuration對象
按鍵值從Configuration對象中獲取信息

生成Configuration對象的步驟至少要有三個基礎環節。

生成ConfigurationBuilder對象
添加ConfigurationSource對象

創建Configuration對象

查看創建Configuration對象的代碼，會發現內部利用的其實是ConfigurationSource中創建的ConfigurationProvider對象。

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接口，也只有一個Build方法。

public interface IConfigurationSource{  IConfigurationProvider Build(IConfigurationBuilder builder);}

最終創建的Configuration對象，即ConfigurationRoot中包含了所有的ConfigurationProvider，說明配置信息都由這些ConfigurationProvider所提供。

跟蹤至ConfigurationRoot類型的構造方法，果然在其生成對象時，對所有ConfigurationProvider進行了加載操作。

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屬性中。這個屬性即是用于保存所有配置信息。

 /// <summary> /// The configuration key value pairs for this provider. /// </summary> protected IDictionary<string, string> Data { get; set; }

有了ConfigurationRoot對象后，獲取配置信息的操作就很簡單了。遍歷各個ConfigurationProvider，從中獲取第一個匹配鍵值的數據。

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對象從Data屬性獲取配置的值。

public virtual bool TryGet(string key, out string value)  => Data.TryGetValue(key, out value);

在最初的例子中可以看Configuration["wizards:0:Name"]這樣的寫法，這是因為在Load文件時，存儲的方式就是用:為分隔符，以作為嵌套對象的鍵值。

也可以用另一種方法來寫，將配置信息綁定為對象。

先定義對象類型：

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; }}

再綁定對象：

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();}

寫法變成了常見的對象調用屬性方式，但結果是一樣的。

除了可以用JSON文件存儲配置信息外，ASP.NET Core同時也支持INI與XML文件。當然有其它類型文件時，也可以通過實現IConfigurationSource接口并繼承ConfigurationProvider類建立自定義的ConfigrationProvider對象來加載配置文件。

至于文件以外的方式，ASP.NET Core也提供了不少。