ASP.NET Core如何自定義配置源示例詳解
前言
正如大家所知,在 .NET Core 中配置文件改成了 appsettings.json,表面上和 .NET Framework 的 web.config 或 app.config 好像沒有太大的區(qū)別,只是一種是 json ,一種是 xml,但其實 .NET Core 的配置體系是一種全新的設(shè)計,靈活且具擴展性。這里主要介紹一下在 .NET Core 的配置體系下如何擴展自定義配置源,配置源其實就是配置信息存放的載體,最常用的就是文件類型。
.NET Core 配置體系
在進行自定義配置源介紹前,我們需要先了解一下 .NET Core 中的配置體系。 .NET Core 的配置體系中主要包含 ConfigurationProvider、ConfigurationSource、ConfigurationBuilder、Configuration 幾大核心對象。
ConfigurationProvider
實現(xiàn) IConfigurationProvider 接口,配置源真正提供者,主要提供配置信息的加載與刷新。
ConfigurationSource
實現(xiàn) IConfigurationSource 接口,提供對應(yīng)的 ConfigurationProvider 具體實例。
ConfigurationBuilder
實現(xiàn) IConfigurationBuilder 接口,負(fù)責(zé)將 ConfigurationSource 添加到配置源集合,再根據(jù)配置源集合構(gòu)建出 ConfigurationRoot 對象,實現(xiàn) IConfigurationRoot 接口。
Configuration
實現(xiàn) IConfiguration 接口,Configuration 對象在邏輯上體現(xiàn)出樹形化層次結(jié)構(gòu),配置信息均已鍵/值對的方式提供使用。
注 :*IConfigurationRoot 、IConfigurationSection 均繼承于 IConfiguration,IConfigurationRoot 表示配置的根節(jié)點,IConfigurationSection 則表示配置的非根節(jié)點*
所以他們之間的關(guān)系就是 ConfigurationProvider 實現(xiàn)配置提供,然后通過 ConfigurationSource 構(gòu)造配置源實例,接著通過 ConfigurationBuilder 將配置源實例 ConfigurationSource 添加到配置源集合中并構(gòu)造出 ConfigurationRoot,最終以 Configuration 對象提供給程序使用。
默認(rèn)情況下,Configuration 對象的 Providers 屬性包含如下 Provider:
- ChainedConfigurationProvider:應(yīng)用程序本身相關(guān)配置信息,如:applicationName、contentRoot;
- JsonConfigurationProvider:appsettings.json 和 appsettings.Development.json 中的配置信息;
- EnvironmentVariablesConfigurationProvider:環(huán)境變量的配置信息;
- CommandLineConfigurationProvider:命令行輸入的配置信息;
這些類型的 Provider 在 .NET Core Web 項目中默認(rèn)會自動加載,不需要手動配置,當(dāng)然預(yù)置的 Provider 并不止這幾種。
自定義配置源
前面提到 .NET Core 的配置體系是具有擴展性的,所以我們可以實現(xiàn)自定義的配置源,比如基于配置中心(如:etcd、apollo、consul 等)的實現(xiàn),下面將模擬從配置中心獲取,先了解整體實現(xiàn)方式,后面也會介紹我們在實際項目中基于 etcd 的實現(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
實現(xiàn) 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<Startup>(); });
測試效果
再次查看 Configuration 對象的 Providers 屬性,發(fā)現(xiàn)已包含 CustomConfigurationProvider:
然后可通過 Configuration 對象獲取對應(yīng) key 的內(nèi)容:
[HttpGet] public IEnumerable<string> Get() { return new string[] { _configuration["name"], _configuration["company"] }; }
總結(jié)
以上完成了一個簡單的自定義配置源,實際情況會比這復(fù)雜些。如果關(guān)注過 JsonConfigurationProvider 的配置加載參數(shù),有一個 reloadOnChange 參數(shù)用來設(shè)置當(dāng)配置文件有變化時是否重新加載,如果 reloadOnChange 設(shè)置為 true,當(dāng)配置文件變化時不需要重啟服務(wù)就可以生效,很多時候我們是需要 Provider 具有這個功能的,在接下來介紹的 EtcdConfigurationProvider 中會實現(xiàn),實現(xiàn)源碼 已在 Github 可供參考。
好了,以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,謝謝大家對我們的支持。
上一篇:NLog路由規(guī)則和上下文信息知識點總結(jié)
欄 目:ASP.NET
本文標(biāo)題:ASP.NET Core如何自定義配置源示例詳解
本文地址:http://mengdiqiu.com.cn/a1/ASP_NET/10842.html
您可能感興趣的文章
- 01-11如何給asp.net core寫個簡單的健康檢查
- 01-11淺析.Net Core中Json配置的自動更新
- 01-11.net core高吞吐遠(yuǎn)程方法如何調(diào)用組件XRPC詳解
- 01-11.NET Core 遷移躺坑記續(xù)集之Win下莫名其妙的超時
- 01-11docker部署Asp.net core應(yīng)用的完整步驟
- 01-11.net core webapi jwt 更為清爽的認(rèn)證詳解
- 01-11ASP.NET Core靜態(tài)文件的使用方法
- 01-11.NET Core 3.0之創(chuàng)建基于Consul的Configuration擴展組件
- 01-11.net core EF Core調(diào)用存儲過程的方式
- 01-11asp.net Core3.0區(qū)域與路由配置的方法


閱讀排行
本欄相關(guān)
- 01-11vscode extension插件開發(fā)詳解
- 01-11VsCode插件開發(fā)之插件初步通信的方法
- 01-11如何給asp.net core寫個簡單的健康檢查
- 01-11.net core高吞吐遠(yuǎn)程方法如何調(diào)用組件
- 01-11淺析.Net Core中Json配置的自動更新
- 01-11.NET開發(fā)人員關(guān)于ML.NET的入門學(xué)習(xí)
- 01-11.NET Core 遷移躺坑記續(xù)集之Win下莫名其
- 01-11.net core webapi jwt 更為清爽的認(rèn)證詳解
- 01-11docker部署Asp.net core應(yīng)用的完整步驟
- 01-11ASP.NET Core靜態(tài)文件的使用方法
隨機閱讀
- 08-05織夢dedecms什么時候用欄目交叉功能?
- 01-10使用C語言求解撲克牌的順子及n個骰子
- 08-05DEDE織夢data目錄下的sessions文件夾有什
- 04-02jquery與jsp,用jquery
- 08-05dedecms(織夢)副欄目數(shù)量限制代碼修改
- 01-10delphi制作wav文件的方法
- 01-10C#中split用法實例總結(jié)
- 01-11ajax實現(xiàn)頁面的局部加載
- 01-11Mac OSX 打開原生自帶讀寫NTFS功能(圖文
- 01-10SublimeText編譯C開發(fā)環(huán)境設(shè)置