淺析.netcore中的Configuration具體使用
不管是.net還是.netcore項目,我們都少不了要讀取配置文件,在.net中項目,配置一般就存放在web.config中,但是在.netcore中我們新建的項目根本就看不到web.config,取而代之的是appsetting.json。
新建一個webapi項目,可以在startup中看到一個IConfiguration,通過框架自帶的IOC使用構造函數(shù)進行實例化,在IConfiguration中我們發(fā)現(xiàn)直接就可以讀取到appsetting.json中的配置項了,如果在控制器中需要讀取配置,也是直接通過構造
函數(shù)就可以實例化IConfiguration對象進行配置的讀取。下面我們試一下運行的效果,在appsetting.json添加一個配置項,在action中可以進行訪問。
添加其他配置文件
那我們的配置項是不是只能寫在appsetting.json中呢?當然不是,下面我們看看如何添加其他的文件到配置項中,根據(jù)官網(wǎng)教程,我們可以使用ConfigureAppConfiguration實現(xiàn)。
首先我們在項目的根目錄新建一個config.json,然后在其中隨意添加幾個配置,然后在program.cs中添加高亮顯示的部分,這樣很簡單的就將我們新增的json文件中的配置加進來了,然后在程序中就可以使用IConfiguration進行訪問config.json中的配置項了。
public class Program { public static void Main(string[] args) { CreateHostBuilder(args).Build().Run(); } public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .ConfigureAppConfiguration(configure => { configure.AddJsonFile("config.json"); //無法熱修改 }) .ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); }); }
但是這個無法在配置項修改后讀取到最新的數(shù)據(jù),我們可以調(diào)用重載方法configure.AddJsonFile("config.json",true,reloadOnChange:true)實現(xiàn)熱更新。
除了添加json文件外,我們還可以使用AddXmlFile添加xml文件,使用AddInMemoryCollection添加內(nèi)存配置
public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .ConfigureAppConfiguration((context,configure) => { Dictionary<string, string> memoryConfig = new Dictionary<string, string>(); memoryConfig.Add("memoryKey1", "m1"); memoryConfig.Add("memoryKey2", "m2"); configure.AddInMemoryCollection(memoryConfig); }) .ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); });
源碼解讀:
在自動生成的項目中,我們沒有配置過如何獲取配置文件,那.netcore框架是怎么知道要appsetting.json配置文件的呢?我們通過查看源碼我們就可以明白其中的道理。
Host.CreateDefaultBuilder(args) .ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); }); //CreateDefaultBuilder源碼 public static IHostBuilder CreateDefaultBuilder(string[] args) { var builder = new HostBuilder(); builder.UseContentRoot(Directory.GetCurrentDirectory()); builder.ConfigureHostConfiguration(config => { config.AddEnvironmentVariables(prefix: "DOTNET_"); if (args != null) { config.AddCommandLine(args); } }); builder.ConfigureAppConfiguration((hostingContext, config) => { var env = hostingContext.HostingEnvironment; config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true) .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true); if (env.IsDevelopment() && !string.IsNullOrEmpty(env.ApplicationName)) { var appAssembly = Assembly.Load(new AssemblyName(env.ApplicationName)); if (appAssembly != null) { config.AddUserSecrets(appAssembly, optional: true); } } config.AddEnvironmentVariables(); if (args != null) { config.AddCommandLine(args); } }); .... return builder; }
怎么樣?是不是很有意思,在源碼中我們看到在Program中構建host的時候就會調(diào)用ConfigureAppConfiguration對應用進行配置,會讀取appsetting.json文件,并且會根據(jù)環(huán)境變量加載不同環(huán)境的appsetting,同時還可以看到應用不僅添加了
appsetting的配置,而且添加了從環(huán)境變量、命令行傳入?yún)?shù)的支持,對于AddUserSecrets支持讀取用戶機密文件中的配置,這個在存儲用戶機密配置的時候會用到。
那為什么我們可以通過再次調(diào)用ConfigureAppConfiguration去追加配置信息,而不是覆蓋呢?我們同樣可以在源碼里面找到答案。
public static void Main(string[] args) { CreateHostBuilder(args).Build().Run(); } //以下為部分源碼 private List<Action<HostBuilderContext, IConfigurationBuilder>> _configureAppConfigActions = new List<Action<HostBuilderContext, IConfigurationBuilder>>();private IConfiguration _appConfiguration; public IHostBuilder ConfigureAppConfiguration(Action<HostBuilderContext, IConfigurationBuilder> configureDelegate) { _configureAppConfigActions.Add(configureDelegate ?? throw new ArgumentNullException(nameof(configureDelegate))); return this; } public IHost Build() { ... BuildAppConfiguration(); ... } private void BuildAppConfiguration() { var configBuilder = new ConfigurationBuilder() .SetBasePath(_hostingEnvironment.ContentRootPath) .AddConfiguration(_hostConfiguration, shouldDisposeConfiguration: true); foreach (var buildAction in _configureAppConfigActions) { buildAction(_hostBuilderContext, configBuilder); } _appConfiguration = configBuilder.Build(); _hostBuilderContext.Configuration = _appConfiguration; }
框架聲明了一個List<Action<HostBuilderContext, IConfigurationBuilder>>,我們每次調(diào)用ConfigureAppConfiguration都是往這個集合中添加元素,等到Main函數(shù)調(diào)用Build的時候會觸發(fā)ConfigurationBuilder,將集合中的所有元素進行循環(huán)追加
到ConfigurationBuilder,最后就形成了我們使用的IConfiguration,這樣一看對于.netcore中IConfiguration是怎么來的就很清楚了。
讀取層級配置項
如果需要讀取配置文件中某個層級的配置應該怎么做呢?也很簡單,使用IConfiguration["key:childKey..."]
比如有這樣一段配置:
"config_key2": { "config_key2_1": "config_key2_1", "config_key2_2": "config_key2_2" }
可以使用IConfiguration["config_key2:config_key2_1"]來獲取到config_key2_1的配置項,如果config_key2_1下還有子配置項childkey,依然可以繼續(xù)使用:childkey來獲取
選項模式獲取配置項
選項模式使用類來提供對相關配置節(jié)的強類型訪問,將配置文件中的配置項轉化為POCO模型,可為開發(fā)人員編寫代碼提供更好的便利和易讀性
我們添加這樣一段配置:
"Student": { "Sno": "SNO", "Sname": "SNAME", "Sage": 18, "ID": "001" }
接下來我們定義一個Student的Model類
public class Student { private string _id; public const string Name = "Student"; private string ID { get; set; } public string Sno { get; set; } public string Sname { get; set; } public int Sage { get; set; } }
可以使用多種方式來進行綁定:
1、使用Bind方式綁定
Student student = new Student(); _configuration.GetSection(Student.Name).Bind(student);
2、使用Get方式綁定
var student1 = _configuration.GetSection(Student.Name).Get<Student>(binderOptions=> { binderOptions.BindNonPublicProperties = true; });
Get方式和Bind方式都支持添加一個Action<BinderOptions>的重載,通過這個我們配置綁定時的一些配置,比如非公共屬性是否綁定(默認是不綁定的),但是Get比BInd使用稍微方便一些,如果需要綁定集合也是一樣的道理,將Student
替換成List<Student>。
3、全局方式綁定
前兩種方式只能在局部生效,要想做一次配置綁定,任何地方都生效可用,我們可以使用全局綁定的方式,全局綁定在Startup.cs中定義
services.Configure<Student>(Configuration.GetSection(Student.Name));
此方式會使用選項模式進行配置綁定,并且會注入到IOC中,在需要使用的地方可以在構造函數(shù)中進行實例化
private readonly ILogger<WeatherForecastController> _logger; private readonly IConfiguration _configuration; private readonly Student _student; public WeatherForecastController(ILogger<WeatherForecastController> logger, IConfiguration configuration, IOptions<Student> student) { _logger = logger; _configuration = configuration; _student = student.Value; }
命名選項的使用
對于不同的配置節(jié),包含的配置項一樣時,我們在使用選項綁定的時候無需定義和注入兩個類,可以在綁定時指定名稱,比如下面的配置:
"Root": { "child1": { "child_1": "child1_1", "child_2": "child1_2" }, "child2": { "child_1": "child2_1", "child_2": "child2_2" } }public class Root{ public string child_1{get;set;} public string child_2{get;set;}} services.Configure<Root>("Child1",Configuration.GetSection("Root:child1")); services.Configure<Root>("Child2", Configuration.GetSection("Root:child2")); private readonly ILogger<WeatherForecastController> _logger; private readonly IConfiguration _configuration; private readonly Student _student; private readonly Root _child1; private readonly Root _child2; public WeatherForecastController(ILogger<WeatherForecastController> logger, IConfiguration configuration, IOptions<Student> student,IOptionsSnapshot<Root> root) { _logger = logger; _configuration = configuration; _student = student.Value; _child1 = root.Get("Child1"); _child2 = root.Get("Child2"); }
到此這篇關于淺析.netcore中的Configuration具體使用的文章就介紹到這了,更多相關.net core Configuration內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
VB.NET 中刪除DataGridView中所選行的小例子
之前為這個刪除所選行還費了點腦筋,因為每Removeat一行之后,后面的行會自動縮進,而且會自動選中下一行,很麻煩,后來發(fā)現(xiàn)很簡單:2013-04-04asp.net中日歷函數(shù)Calendar的使用方法
calendar 控件用于在瀏覽器中顯示日歷,該控件可顯示某個月的日歷,允許用戶選擇日期,也可以跳到前一個或下一個月2011-05-05asp.net BOF或EOF有一個是真,或者當前記錄已被刪除
在調(diào)試“學生管理系統(tǒng)”時,想修改學籍信息,如果此時數(shù)據(jù)庫中的數(shù)據(jù)已被完全刪除則會出現(xiàn)“BoF 或Eof有一個是真,或當前記錄已被刪除的錯誤2009-07-07利用ASP.NET MVC和Bootstrap快速搭建個人博客之文章打賞功能(六)
這篇文章主要介紹了利用ASP.NET MVC和Bootstrap快速搭建個人博客之文章打賞功能(六) 的相關資料,非常不錯,具有參考借鑒價值,需要的朋友可以參考下2016-07-07ASP.NET設計網(wǎng)絡硬盤之刪除文件夾實現(xiàn)代碼
對于不再需要的文件/文件夾用戶有權限做刪除處理。這一節(jié)就介紹如何實現(xiàn)這一功能2012-10-10