ASP.NET Core 自定義配置源

2019-11-26     日行四善

正如大家所知，在 .NET Core 中配置文件改成了 appsettings.json，表面上和 .NET Framework 的 web.config 或 app.config 好像沒有太大的區別，只是一種是 json ，一種是 xml，但其實 .NET Core 的配置體系是一種全新的設計，靈活且具擴展性。這裡主要介紹一下在 .NET Core 的配置體系下如何擴展自定義配置源，配置源其實就是配置信息存放的載體，最常用的就是文件類型。

.NET Core 配置體系

在進行自定義配置源介紹前，我們需要先了解一下 .NET Core 中的配置體系。 .NET Core 的配置體系中主要包含 ConfigurationProvider、ConfigurationSource、ConfigurationBuilder、Configuration 幾大核心對象。

ConfigurationProvider

實現 IConfigurationProvider 接口，配置源真正提供者，主要提供配置信息的加載與刷新。

ConfigurationSource

實現 IConfigurationSource 接口，提供對應的 ConfigurationProvider 具體實例。

ConfigurationBuilder

實現 IConfigurationBuilder 接口，負責將 ConfigurationSource 添加到配置源集合，再根據配置源集合構建出 ConfigurationRoot 對象，實現 IConfigurationRoot 接口。

Configuration

實現 IConfiguration 接口，Configuration 對象在邏輯上體現出樹形化層次結構，配置信息均已鍵/值對的方式提供使用。

注 ：IConfigurationRoot 、IConfigurationSection 均繼承於 IConfiguration，IConfigurationRoot 表示配置的根節點，IConfigurationSection 則表示配置的非根節點

所以他們之間的關係就是 ConfigurationProvider 實現配置提供，然後通過 ConfigurationSource 構造配置源實例，接著通過 ConfigurationBuilder 將配置源實例 ConfigurationSource 添加到配置源集合中並構造出 ConfigurationRoot，最終以 Configuration 對象提供給程序使用。

relation

默認情況下，Configuration 對象的 Providers 屬性包含如下 Provider：

providers

  1. ChainedConfigurationProvider：應用程式本身相關配置信息，如：applicationName、contentRoot；
  2. JsonConfigurationProvider：appsettings.json 和 appsettings.Development.json 中的配置信息；
  3. EnvironmentVariablesConfigurationProvider：環境變量的配置信息；
  4. CommandLineConfigurationProvider：命令行輸入的配置信息；

這些類型的 Provider 在 .NET Core Web 項目中默認會自動加載，不需要手動配置，當然預置的 Provider 並不止這幾種。

自定義配置源

前面提到 .NET Core 的配置體系是具有擴展性的，所以我們可以實現自定義的配置源，比如基於配置中心（如：etcd、apollo、consul 等）的實現，下面將模擬從配置中心獲取，先了解整體實現方式，後面也會介紹我們在實際項目中基於 etcd 的實現方案。

創建 ConfigurationProvider

自定義 Provider 需要繼承 ConfigurationProvider，然後重寫 Load 方法，設置 Data 屬性。

public class CustomConfigurationProvider : ConfigurationProvider
{
 public override void Load()
 {
 // 模擬從遠程配置中心獲取配置信息 
 using var httpClient = new HttpClient
 {
 BaseAddress = new Uri("http://localhost:5000")
 };

 var response = httpClient.GetStringAsync("/api/configs")
 .ConfigureAwait(false)
 .GetAwaiter()
 .GetResult();

 if (!string.IsNullOrEmpty(response))
 {
 Data = JsonConvert.DeserializeObject>(response);
 }
 }
}

http://localhost:5000/api/configs 接口返回的 json 字符串，如下：

{"name":"beck","company":"mingdao"}

創建 ConfigurationSource

實現 IConfigurationSource 接口，在 Build 方法中返回 CustomConfigurationProvider 實例。

public class CustomConfigurationSource : IConfigurationSource
{
 public IConfigurationProvider Build(IConfigurationBuilder builder)
 {
 return new CustomConfigurationProvider();
 }
}

加入 ConfigurationBuilder 配置源列表

添加 IConfigurationBuilder 擴展方法 AddCustom，將 CustomConfigurationSource 加入配置源集合中。

public static class CustomConfigurationExtensions
{
 public static IConfigurationBuilder AddCustom(this IConfigurationBuilder builder)
 {
 return builder.Add(new CustomConfigurationSource());
 }
}

啟動入口添加 AddCustom

在 Program.cs 中的 ConfigureAppConfiguration 引用自定義配置源：

public static IHostBuilder CreateHostBuilder(string[] args) =>
 Host.CreateDefaultBuilder(args)
 .ConfigureWebHostDefaults(webBuilder =>
 {
 webBuilder.ConfigureAppConfiguration((context, configBuiler) =>
 {
 configBuiler.AddCustom();
 });
 webBuilder.UseStartup();
 });

測試效果

再次查看 Configuration 對象的 Providers 屬性，發現已包含 CustomConfigurationProvider：

customConfigurationProvider

然後可通過 Configuration 對象獲取對應 key 的內容：

[HttpGet]
public IEnumerable Get()
{
 return new string[] { _configuration["name"], _configuration["company"] };
}

result

總結

以上完成了一個簡單的自定義配置源，實際情況會比這複雜些。如果關注過 JsonConfigurationProvider 的配置加載參數，有一個 reloadOnChange 參數用來設置當配置文件有變化時是否重新加載，如果 reloadOnChange 設置為 true，當配置文件變化時不需要重啟服務就可以生效，很多時候我們是需要 Provider 具有這個功能的，在接下來介紹的 EtcdConfigurationProvider 中會實現，實現源碼 已在 Github 可供參考。


作者：BeckJin
連結：https://www.jianshu.com/p/4cc6671284d9

文章來源: https://twgreatdaily.com/zh-tw/xxOysG4BMH2_cNUg8ENz.html