ASP.NET Core自定義配置源的案例分析

這篇文章將為大家詳細(xì)講解有關(guān)ASP.NET Core自定義配置源的案例分析，小編覺得挺實(shí)用的，因此分享給大家做個(gè)參考，希望大家閱讀完這篇文章后可以有所收獲。

前言

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

.NET Core 配置體系

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

ConfigurationProvider

實(shí)現(xiàn) IConfigurationProvider 接口，配置源真正提供者，主要提供配置信息的加載與刷新。

ConfigurationSource

實(shí)現(xiàn) IConfigurationSource 接口，提供對(duì)應(yīng)的 ConfigurationProvider 具體實(shí)例。

ConfigurationBuilder

實(shí)現(xiàn) IConfigurationBuilder 接口，負(fù)責(zé)將 ConfigurationSource 添加到配置源集合，再根據(jù)配置源集合構(gòu)建出 ConfigurationRoot 對(duì)象，實(shí)現(xiàn) IConfigurationRoot 接口。

Configuration

實(shí)現(xiàn) IConfiguration 接口，Configuration 對(duì)象在邏輯上體現(xiàn)出樹形化層次結(jié)構(gòu)，配置信息均已鍵/值對(duì)的方式提供使用。

注 ：*IConfigurationRoot 、IConfigurationSection 均繼承于 IConfiguration，IConfigurationRoot 表示配置的根節(jié)點(diǎn)，IConfigurationSection 則表示配置的非根節(jié)點(diǎn)*

所以他們之間的關(guān)系就是 ConfigurationProvider 實(shí)現(xiàn)配置提供，然后通過 ConfigurationSource 構(gòu)造配置源實(shí)例，接著通過 ConfigurationBuilder 將配置源實(shí)例 ConfigurationSource 添加到配置源集合中并構(gòu)造出 ConfigurationRoot，最終以 Configuration 對(duì)象提供給程序使用。

默認(rèn)情況下，Configuration 對(duì)象的 Providers 屬性包含如下 Provider：

1. ChainedConfigurationProvider：應(yīng)用程序本身相關(guān)配置信息，如：applicationName、contentRoot；

2. JsonConfigurationProvider：appsettings.json 和 appsettings.Development.json 中的配置信息；

3. EnvironmentVariablesConfigurationProvider：環(huán)境變量的配置信息；

4. CommandLineConfigurationProvider：命令行輸入的配置信息；

這些類型的 Provider 在 .NET Core Web 項(xiàng)目中默認(rèn)會(huì)自動(dòng)加載，不需要手動(dòng)配置，當(dāng)然預(yù)置的 Provider 并不止這幾種。

自定義配置源

前面提到 .NET Core 的配置體系是具有擴(kuò)展性的，所以我們可以實(shí)現(xiàn)自定義的配置源，比如基于配置中心（如：etcd、apollo、consul 等）的實(shí)現(xiàn)，下面將模擬從配置中心獲取，先了解整體實(shí)現(xiàn)方式，后面也會(huì)介紹我們?cè)趯?shí)際項(xiàng)目中基于 etcd 的實(shí)現(xiàn)方案。

創(chuàng)建 ConfigurationProvider

自定義 Provider 需要繼承 ConfigurationProvider，然后重寫 Load 方法，設(shè)置 Data 屬性。

public class CustomConfigurationProvider : ConfigurationProvider
{
 public override void Load()
 {
 // 模擬從遠(yuǎn)程配置中心獲取配置信息 
 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<Dictionary<string, string>>(response);
 }
 }
}

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

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

創(chuàng)建 ConfigurationSource

實(shí)現(xiàn) IConfigurationSource 接口，在 Build 方法中返回 CustomConfigurationProvider 實(shí)例。

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

加入 ConfigurationBuilder 配置源列表

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

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

啟動(dòng)入口添加 AddCustom

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

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

測(cè)試效果
再次查看 Configuration 對(duì)象的 Providers 屬性，發(fā)現(xiàn)已包含 CustomConfigurationProvider：

然后可通過 Configuration 對(duì)象獲取對(duì)應(yīng) key 的內(nèi)容：

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

關(guān)于“ASP.NET Core自定義配置源的案例分析”這篇文章就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，使各位可以學(xué)到更多知識(shí)，如果覺得文章不錯(cuò)，請(qǐng)把它分享出去讓更多的人看到。