.NET?Core讀取配置文件的方法
配置文件是每個(gè)項(xiàng)目最基礎(chǔ)的部分，也是不可或缺的部分，比如：數(shù)據(jù)庫(kù)連接、中間件屬性等常見的配置。
今天這篇文章主要內(nèi)容就是，在.Net Core項(xiàng)目中怎樣去讀取配置文件并使用。
提前準(zhǔn)備
appsettings.json 文件
{
"User": {
"userName": "趙一",
"userAge": 18
}
}
對(duì)應(yīng)實(shí)體模型
public class UserOption
{
public string userName { get; set; }
public int userAge { get; set; }
}
常規(guī)讀取
1、注冊(cè)
在 startup 類中注冊(cè)，主要用到的是 Configure 方法：
services.Configure<UserOption>(Configuration.GetSection("User"));
2、控制器中注入并讀取
public class HomeController : ControllerBase
{
private readonly UserOption user;
public HomeController(IOptions<UserOption> userOptions)
{
user = userOptions.Value;
}
[HttpGet]
public string Get()
{
return $"姓名：{user.userName}，年齡：{user.userAge} ";
}
}
輸出結(jié)果：姓名：趙一，年齡：18
嵌套讀取
我們對(duì) appsettings.json 文件做一點(diǎn)小小的改動(dòng)，增加一個(gè)子節(jié)點(diǎn) child ：
{
"User": {
"userName": "趙一",
"userAge": 18,
"child": {
"userName": "趙一的崽",
"userAge": 2
}
}
}
再對(duì)注冊(cè)的代碼做一點(diǎn)小小的修改：
services.Configure<UserOption>(Configuration.GetSection("User:child"));
輸出結(jié)果：姓名：趙一的崽，年齡：2
分實(shí)例讀取
這個(gè)時(shí)候需求又有變化了，需要同時(shí)讀取 User 與 child 節(jié)點(diǎn)的數(shù)據(jù)，我們?cè)囋囅旅娴姆椒纯尚胁豢尚校?/p>
// 注冊(cè)
services.Configure<UserOption>(Configuration.GetSection("User"));
services.Configure<UserOption>(Configuration.GetSection("User:child"));
// 控制器
public class HomeController : ControllerBase
{
private readonly UserOption user;
private readonly UserOption child;
public HomeController(IOptions<UserOption> userOptions, IOptions<UserOption> childOptions)
{
user = userOptions.Value;
child = childOptions.Value;
}
[HttpGet]
public string Get()
{
return $"姓名：{user.userName}，年齡：{user.userAge} \r\n姓名：{child.userName}，年齡：{child.userAge}";
}
}
輸出結(jié)果很顯然滿足不了我們的需求：
姓名：趙一的崽，年齡：2 姓名：趙一的崽，年齡：2
有的小伙伴肯定會(huì)說，在實(shí)體模型內(nèi)在加一個(gè)子節(jié)點(diǎn)字段。這樣肯定是沒問題的，但是與常規(guī)讀取方式就沒什么兩樣了。
這里我要說的是分實(shí)例讀取，引入 Configure 的另一個(gè)重載方法，與之前不同的是多了一個(gè)參數(shù) name：
public static IServiceCollection Configure<TOptions>(this IServiceCollection services, string name, IConfiguration config) where TOptions : class;
下面我們重新注冊(cè)：
services.Configure<UserOption>("father", Configuration.GetSection("User"));
services.Configure<UserOption>("son", Configuration.GetSection("User:child"));
在控制器構(gòu)造函數(shù)中注入，也引入了一個(gè)新的接口對(duì)象：IOptionsMonitor
public class HomeController : ControllerBase
{
private readonly UserOption user;
private readonly UserOption child;
public HomeController(IOptionsMonitor<UserOption> userOptions, IOptionsMonitor<UserOption> childOptions)
{
user = userOptions.Get("father");
child = childOptions.Get("son");
}
[HttpGet]
public string Get()
{
return $"姓名：{user.userName}，年齡：{user.userAge} \r\n姓名：{child.userName}，年齡：{child.userAge}";
}
輸出結(jié)果：
姓名：趙一，年齡：18 姓名：趙一的崽，年齡：2
其實(shí)還有一個(gè)接口對(duì)象能實(shí)現(xiàn)這樣的效果：IOptionsSnapshot，那 IOptionsMonitor 與 IOptionsSnapshot 有什么不同呢？請(qǐng)接著往下看。
IOptionsMonitor與IOptionsSnapshot的不同之處
我們先來看看微軟官方的注釋：
IOptionsMonitor
//
// 摘要:
// Used for notifications when TOptions instances change.
//
// 類型參數(shù):
// TOptions:
// The options type.
public interface IOptionsMonitor<out TOptions>
{
//
// 摘要:
// Returns the current TOptions instance with the Microsoft.Extensions.Options.Options.DefaultName.
TOptions CurrentValue { get; }
//
// 摘要:
// Returns a configured TOptions instance with the given name.
TOptions Get(string name);
//
// 摘要:
// Registers a listener to be called whenever a named TOptions changes.
//
// 參數(shù):
// listener:
// The action to be invoked when TOptions has changed.
//
// 返回結(jié)果:
// An System.IDisposable which should be disposed to stop listening for changes.
IDisposable OnChange(Action<TOptions, string> listener);
}
IOptionsSnapshot
//
// 摘要:
// Used to access the value of TOptions for the lifetime of a request.
//
// 類型參數(shù):
// TOptions:
// Options type.
public interface IOptionsSnapshot<out TOptions> : IOptions<TOptions> where TOptions : class, new()
{
//
// 摘要:
// Returns a configured TOptions instance with the given name.
TOptions Get(string name);
}
從字面上理解，IOptionsMonitor 建議在配置信息更改后需要通知的場(chǎng)景下使用，所以多了個(gè) OnChange 的方法；而 IOptionsSnapshot 翻譯過來的意思是：用于在請(qǐng)求的生命周期內(nèi)訪問配置，有點(diǎn)難以理解哈，我們接下來用代碼來驗(yàn)證一下。
IOptionsMonitor 與 IOptionsSnapshot的生命周期
我們對(duì)實(shí)體模型再做一點(diǎn)小小的修改，增加一個(gè) guid 字段，并給上默認(rèn)值：
public class UserOption
{
public string userName { get; set; }
public int userAge { get; set; }
public Guid guid { get; set; } = Guid.NewGuid();
}
我們?cè)俅芜\(yùn)行程序：
father — 姓名：趙一，年齡：19，編號(hào)：e0d71f47-e8f1-4a6d-875e-2074c985f4a0 son — 姓名：趙一的崽，年齡：3，編號(hào)：d865151b-f9bf-4eff-bb4e-8ab6dc61160c
然后不停的刷新頁(yè)面會(huì)發(fā)現(xiàn)，father 的編號(hào)沒有發(fā)生任何編號(hào)，而 son 的編號(hào)每次刷新都會(huì)改變。這是不是比較像我們注冊(cè)時(shí)所用到的三種模式：
services.AddScoped(); services.AddTransient(); services.AddSingleton()
其中 father 類似 AddSingleton，son 則類似 AddScoped 與 AddTransient。
大家可以在同一個(gè)方法里多次調(diào)用 childOptions.Get("son") 看看 son 到底時(shí)類似 AddScoped 還是 AddTransient。
IOptionsMonitor的OnChange調(diào)用方式
userOptions.OnChange((user,name)=> { Console.WriteLine(user.userName +"-"+ name); });
無文件配置
無文件配置就是不需要以靜態(tài)文件的方式進(jìn)行配置。相關(guān)信息在配置一次后就不用再做修改，我們可以采用無文件配置的方式，比如我們熟悉的 AddCors 跨域配置
services.AddCors(op => {
op.AddPolicy(CorsName, set => {
set.SetIsOriginAllowed(origin => true).AllowAnyHeader().AllowAnyMethod().AllowCredentials();
});
});
我們對(duì)之前的注冊(cè)方法進(jìn)行一下改動(dòng)：
services.Configure<UserOption>(c =>
{
c.userName = "錢二";
c.userAge = 60;
});
控制器注入采用常規(guī)的注入方式，最終輸出結(jié)果：姓名：錢二，年齡：60
分享一個(gè)源碼查看網(wǎng)站：https://source.dot.net/
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
- .NET?Core控制臺(tái)應(yīng)用ConsoleApp讀取appsettings.json配置文件
- .NET Core讀取配置文件
- ASP.NET?CORE讀取json格式配置文件
- ASP.NET Core讀取配置文件
- .Net?Core讀取文件時(shí)中文亂碼問題的解決方法分享
- .Net Core讀取Json配置文件的實(shí)現(xiàn)示例
- Asp.net Core與類庫(kù)讀取配置文件信息的方法
- .net core 讀取本地指定目錄下的文件的實(shí)例代碼
- .Net?Core?配置文件讀取IOptions,IOptionsMonitor,IOptionsSnapshot
相關(guān)文章
這篇文章介紹了.Net性能測(cè)試框架Crank的使用方法。對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-11-11
ASP.NET 入門的五個(gè)步驟...2007-01-01
那些年，我還在學(xué)習(xí)asp.net（二） 學(xué)習(xí)筆記
那些年覺得看視頻是很輕松的了解一個(gè)東西，但是這樣的不足就是感覺太慢了，沒有看書來得快，所以在有了一些了解后，還得看點(diǎn)書，也許書上的不一定好，但書上會(huì)把每一個(gè)應(yīng)該說到的地方說到，好有個(gè)初步的認(rèn)識(shí)2012-03-03
本文主要介紹了ASP.NET中BulletedList列表控件的詳細(xì)使用方法，講解各屬性的含義以及三種顯示模式，希望能幫到大家。2016-04-04
這篇文章介紹了ASP.NET Core的中間件，文中通過示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2022-04-04
詳解Asp.net 5中的ApplicationBuilder
這篇文章介紹了Asp.net 5中的ApplicationBuilder，文中通過示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2022-01-01
ASP.Net?Core?MVC基礎(chǔ)系列之獲取配置信息
這篇文章介紹了ASP.Net?Core?MVC獲取配置信息的方法，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-02-02
本文主要介紹Calendar日歷控件的各個(gè)屬性以及舉例演示Calendar控件的具體使用方法，希望對(duì)大家有所幫助。2016-04-04
這篇文章介紹了WCF入門需要掌握的基礎(chǔ)知識(shí)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-01-01
三種方法解決ASP.NET?Core?6中的依賴項(xiàng)
這篇文章主要介紹了解決ASP.NET?Core?6依賴項(xiàng)的三種方法，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2021-11-11