.NetCore獲取Json和Xml格式的配置信息
本篇將和大家分享的是:如何獲取Json和Xml格式的配置信息,主要介紹的是Configuration擴(kuò)展方法的使用,因?yàn)閚etcore的web應(yīng)用在Startup中已經(jīng)默認(rèn)嵌入appsettings.json文件的配置信息,故而我把測(cè)試點(diǎn)放在在了netcore的控制臺(tái)應(yīng)用上;控制臺(tái)上使用配置文件也是常用的事情,并且官網(wǎng)實(shí)例主要講解的是json格式,對(duì)xml格式直接帶過(guò)了,因此有了本篇的分享,希望能給你好的幫助;
- 獲取Json配置信息
- 獲取Xml配置信息
- 獲取xml節(jié)點(diǎn)屬性值
配置文件能否不和應(yīng)用放在一起呢? 答案是肯定的
對(duì)于netcore的netstandard擴(kuò)展來(lái)說(shuō)其自帶了配置文件信息操作類(lèi),因?yàn)閏ore的Web應(yīng)用和控制臺(tái)應(yīng)用都是統(tǒng)一的,因此下面講解測(cè)試用例在控制臺(tái)應(yīng)用演示的,但是也可用于Web應(yīng)用;
首先,咋們需要在控制臺(tái)應(yīng)用中引用如下nuget包(我這里測(cè)試基于2.0):
Install-Package Microsoft.Extensions.Configuration -Version 2.0.0 Install-Package Microsoft.Extensions.Configuration.Abstractions -Version 2.0.0
獲取Json配置信息
要獲取json配置我們除了上面兩個(gè)引用外,還需要引用:
Install-Package Microsoft.Extensions.Configuration.Json -Version 2.0.0
這是json配置的基礎(chǔ)引用,我們?cè)诳刂婆_(tái)應(yīng)用中創(chuàng)建appsettings.json文件,并定義如下json配置文件信息:
{ "MyConfig": { "UserName": "神牛步行3", "userPwd": "666666", "GaoDeApi": { "UserName": "神牛步行1", "userPwd": "111111" }, "BaiDuApi":{ "userName": "神牛步行2", "userPwd": "222222" } } }
然后只需要如下代碼,即可獲取到該文件信息:
var configBasePath = Directory.GetCurrentDirectory(); //configBasePath = @"D:\D\TTest"; sbLog.Append($"配置文件所在目錄:{configBasePath}\n"); var builder = new ConfigurationBuilder(). SetBasePath(configBasePath). AddJsonFile("appsettings.json"); var config = builder.Build(); sbLog.Append($"MyConfig:UserName節(jié)點(diǎn)的值:{config.GetSection("MyConfig:UserName").Value}");
對(duì)于已經(jīng)有core開(kāi)發(fā)經(jīng)驗(yàn)的朋友而言,上面直接能看懂,不過(guò)為了完善的講解這里還是需要簡(jiǎn)單說(shuō)下的:
ConfigurationBuilder實(shí)例過(guò)后需要通過(guò)SetBasePath方法設(shè)置配置文件基礎(chǔ)路徑,再通過(guò)AddJsonFile擴(kuò)展方法指定讀取的文件名稱(chēng);這些步驟執(zhí)行返回的都是IConfigurationBuilder接口,最后還需要Build方法執(zhí)行加載配置信息,這個(gè)builder有點(diǎn)類(lèi)似于start的意思;來(lái)看看效果圖:
很顯然這里獲取到了配置文件中的MyConfig:UserName節(jié)點(diǎn)的值,這里通過(guò) IConfigurationSection GetSection(string key); 函數(shù)獲取配置節(jié)點(diǎn),配置節(jié)點(diǎn)層級(jí)關(guān)系通過(guò)“:”鏈接,因此這里就有了key=MyConfig:UserName;
為了程序的美觀性和多使用性,這里吧獲取json文件的封裝為如下方法:
/// <summary> /// json配置文件讀取 /// </summary> /// <param name="configFileName"></param> /// <param name="basePath"></param> /// <returns></returns> public static IConfigurationRoot GetJsonConfig( string configFileName = "appsettings.json", string basePath = "") { basePath = string.IsNullOrWhiteSpace(basePath) ? Directory.GetCurrentDirectory() : basePath; var builder = new ConfigurationBuilder(). SetBasePath(basePath). AddJsonFile(configFileName); return builder.Build(); }
對(duì)了這里注意下AddJsonFile方法是通過(guò)開(kāi)節(jié)引用的 Microsoft.Extensions.Configuration.Json 擴(kuò)展的;由于IConfiguration不光用GetSection函數(shù),她也能根據(jù) this[string key] 方式獲取節(jié)點(diǎn),下面是分別獲取高德地圖和百度地圖配置節(jié)點(diǎn)信息的代碼和效果圖:
var configJson = GetJsonConfig(); sbLog.Append($"json配置-MyConfg節(jié)點(diǎn)的值:\n"); sbLog.Append($"高德-UserName:{configJson.GetSection("MyConfig:GaoDeApi:UserName").Value}\n"); sbLog.Append($"百度-userName:{configJson["MyConfig:BaiDuApi:UserName"]}\n\r\n");
注意:節(jié)點(diǎn)不區(qū)分大小寫(xiě),多級(jí)節(jié)點(diǎn)使用‘:'獲??;
獲取Xml配置信息
xml配置文件也是我們常見(jiàn)的,對(duì)已擴(kuò)展的IConfigurationBuilder來(lái)說(shuō),我們同樣也有類(lèi)似于json那樣擴(kuò)展的方法,首先需要引用如下包:
Install-Package Microsoft.Extensions.Configuration.Xml -Version 2.0.0
然后幾乎和json同樣的代碼獲取xml配置文件:
/// <summary> /// xml配置文件讀取 /// </summary> /// <param name="configFileName"></param> /// <param name="basePath"></param> /// <returns></returns> public static IConfigurationRoot GetXmlConfig( string configFileName = "appsettings.xml", string basePath = "") { basePath = string.IsNullOrWhiteSpace(basePath) ? Directory.GetCurrentDirectory() : basePath; var builder = new ConfigurationBuilder(). //SetBasePath(basePath). AddXmlFile(b => { b.Path = configFileName; b.FileProvider = new PhysicalFileProvider(basePath); }); return builder.Build(); }
區(qū)別在于擴(kuò)展IConfigurationBuilder的AddXmlFile方法,本次示例為了多樣化使用了 public static IConfigurationBuilder AddXmlFile(this IConfigurationBuilder builder, Action<XmlConfigurationSource> configureSource) 來(lái)傳遞配置文件名稱(chēng)和基礎(chǔ)路徑;
下面來(lái)新建并初始化appsettings.xml配置文件信息:
<MyConfig> <GaoDeApi> <UserName des="高德的賬號(hào)">神牛步行1</UserName> <userPwd>111111</userPwd> </GaoDeApi> <BaiDuApi> <userName des="百度的賬號(hào)">神牛步行2</userName> <userPwd>222222</userPwd> </BaiDuApi> </MyConfig>
再來(lái)看看調(diào)用獲取配置節(jié)點(diǎn)的部分代碼:
var configXml = GetXmlConfig(); sbLog.Append($"xml配置-MyConfg節(jié)點(diǎn)的值:\n"); sbLog.Append($"高德-UserName:{configXml.GetSection("GaoDeApi:UserName").Value}\n"); sbLog.Append($"百度-userName:{configXml["BaiDuApi:UserName"]}\n\r\n");
能夠看出xml和json讀取配置節(jié)點(diǎn)的方式一樣“:”表示層級(jí)關(guān)系,但是特別注意點(diǎn)在于xml不需要最外層跟節(jié)點(diǎn),如這里的:GaoDeApi:UserName,如果按照json方式的話(huà)這里的key應(yīng)該是這樣:MyConfig:GaoDeApi:UserName,這里就是兩種的另外一種區(qū)別;如圖:
不出以外json和xml配置信息都能獲取到了;
獲取xml節(jié)點(diǎn)屬性值
通常xml配置文件節(jié)點(diǎn)還有屬性(attribute),如上面的xml節(jié)點(diǎn): <UserName des="高德的賬號(hào)">神牛步行1</UserName> ,這個(gè)des=""就是屬性,我們要怎么才能獲取這個(gè)值呢;這里其實(shí)同樣還是通過(guò)':'來(lái)關(guān)聯(lián)的,如下代碼獲取屬性節(jié)點(diǎn)des的值:
sbLog.Append($"高德-UserName-des:{configXml.GetSection("GaoDeApi:UserName:des").Value}\n"); sbLog.Append($"百度-userName-des:{configXml["BaiDuApi:UserName:des"]}\n\r\n");
xml屬性節(jié)點(diǎn)名稱(chēng)不能是name,不然是無(wú)法讀取成功的;如這里的des改成name名稱(chēng)的話(huà),無(wú)法正常獲取信息,謹(jǐn)記于心;
配置文件能否不和應(yīng)用放在一起呢? 答案是肯定的
有部分朋友會(huì)提出一個(gè)問(wèn)題:配置文件能否不和應(yīng)用放在一起呢? 答案是肯定的,我們只需把Directory.GetCurrentDirectory()(獲取當(dāng)前應(yīng)用所在磁盤(pán)目錄)替換成配置文件所在的基礎(chǔ)目錄就行了,如我這里的: configBasePath = @"D:\D\TTest";
下面是本次實(shí)例的整個(gè)測(cè)試用例代碼:
using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Configuration.Json; using Microsoft.Extensions.FileProviders; using System; using System.Diagnostics; using System.IO; using System.Text; namespace MyService { class Program { static void Main(string[] args) { Encoding.RegisterProvider(CodePagesEncodingProvider.Instance); Console.OutputEncoding = Encoding.GetEncoding("GB2312"); var sbLog = new StringBuilder(string.Empty); var configBasePath = Directory.GetCurrentDirectory(); //configBasePath = @"D:\D\TTest"; sbLog.Append($"配置文件所在目錄:{configBasePath}\n"); var builder = new ConfigurationBuilder(). SetBasePath(configBasePath). AddJsonFile("appsettings.json"); var config = builder.Build(); sbLog.Append($"MyConfig:UserName節(jié)點(diǎn)的值:{config.GetSection("MyConfig:UserName").Value}\n\r\n"); var configJson = GetJsonConfig(); sbLog.Append($"json配置-MyConfg節(jié)點(diǎn)的值:\n"); sbLog.Append($"高德-UserName:{configJson.GetSection("MyConfig:GaoDeApi:UserName").Value}\n"); sbLog.Append($"百度-userName:{configJson["MyConfig:BaiDuApi:UserName"]}\n\r\n"); var configXml = GetXmlConfig(); sbLog.Append($"xml配置-MyConfg節(jié)點(diǎn)的值:\n"); sbLog.Append($"高德-UserName:{configXml.GetSection("GaoDeApi:UserName").Value}\n"); sbLog.Append($"百度-userName:{configXml["BaiDuApi:UserName"]}\n\r\n"); sbLog.Append($"高德-UserName-des:{configXml.GetSection("GaoDeApi:UserName:des").Value}\n"); sbLog.Append($"百度-userName-des:{configXml["BaiDuApi:UserName:des"]}\n\r\n"); Console.WriteLine(sbLog); Console.ReadLine(); } /// <summary> /// json配置文件讀取 /// </summary> /// <param name="configFileName"></param> /// <param name="basePath"></param> /// <returns></returns> public static IConfigurationRoot GetJsonConfig( string configFileName = "appsettings.json", string basePath = "") { basePath = string.IsNullOrWhiteSpace(basePath) ? Directory.GetCurrentDirectory() : basePath; var builder = new ConfigurationBuilder(). SetBasePath(basePath). AddJsonFile(configFileName); return builder.Build(); } /// <summary> /// xml配置文件讀取 /// </summary> /// <param name="configFileName"></param> /// <param name="basePath"></param> /// <returns></returns> public static IConfigurationRoot GetXmlConfig( string configFileName = "appsettings.xml", string basePath = "") { basePath = string.IsNullOrWhiteSpace(basePath) ? Directory.GetCurrentDirectory() : basePath; var builder = new ConfigurationBuilder(). //SetBasePath(basePath). AddXmlFile(b => { b.Path = configFileName; b.FileProvider = new PhysicalFileProvider(basePath); }); return builder.Build(); } } }
總結(jié)
以上所述是小編給大家介紹的.NetCore獲取Json和Xml格式的配置信息,希望對(duì)大家有所幫助,如果大家有任何疑問(wèn)請(qǐng)給我留言,小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持!
相關(guān)文章
Asp.net MVC中獲取控制器的名稱(chēng)的方法
這篇文章主要介紹了Asp.net MVC中獲取控制器的名稱(chēng)的方法,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下2016-10-10.NET(C#)連接各類(lèi)數(shù)據(jù)庫(kù)代碼-集錦
.NET(C#)連接各類(lèi)數(shù)據(jù)庫(kù)代碼-集錦...2007-03-03asp.net中不能在DropDownList中選擇多個(gè)項(xiàng) 原因分析及解決方法
不能在 DropDownList 中選擇多個(gè)項(xiàng),在前一步操作的過(guò)程中,已經(jīng)選擇了某個(gè)Item2012-10-10Web.config 和 App.config 的區(qū)別分析
Web.config 和 App.config 的區(qū)別分析,需要的朋友可以參考一下2013-05-05ASP.NET 圖片防盜鏈的實(shí)現(xiàn)原理分析
防盜鏈的原理,從圖片請(qǐng)求的URL地址上判斷是否是我們自己網(wǎng)站上的域名,如果不是,恭喜,你的圖片已經(jīng)被盜鏈了!2010-01-01解決.net項(xiàng)目中上傳的圖片或者文件太大無(wú)法上傳問(wèn)題
本文主要介紹了解決.net項(xiàng)目中上傳的圖片或者文件太大無(wú)法上傳問(wèn)題的具有方法,具有很好的參考價(jià)值,有需要的朋友可以看下2016-12-12ASP.NET中的URL過(guò)濾實(shí)現(xiàn)代碼
最近做的一個(gè)Web項(xiàng)目需要對(duì)URL進(jìn)行過(guò)濾,在網(wǎng)上搜了一下,知道J2EE有個(gè)Filter的東西,而在.NET方面,其實(shí)也可以實(shí)現(xiàn)2013-01-01ASP.NET設(shè)計(jì)網(wǎng)絡(luò)硬盤(pán)之兩重要類(lèi)代碼
要進(jìn)行“網(wǎng)絡(luò)硬盤(pán)”功能設(shè)計(jì),首先要熟悉.NET中處理文件和文件夾的操作。File類(lèi)和Directory類(lèi)是其中最主要的兩個(gè)類(lèi)。了解它們將對(duì)后面功能的實(shí)現(xiàn)提供很大的便利2012-10-10