這篇文章將為大家詳細(xì)講解有關(guān).NetCore怎么獲取Json和Xml格式的配置信息,小編覺得挺實(shí)用的,因此分享給大家做個參考,希望大家閱讀完這篇文章后可以有所收獲。
公司主營業(yè)務(wù):網(wǎng)站設(shè)計制作、成都做網(wǎng)站、移動網(wǎng)站開發(fā)等業(yè)務(wù)。幫助企業(yè)客戶真正實(shí)現(xiàn)互聯(lián)網(wǎng)宣傳,提高企業(yè)的競爭能力。創(chuàng)新互聯(lián)公司是一支青春激揚(yáng)、勤奮敬業(yè)、活力青春激揚(yáng)、勤奮敬業(yè)、活力澎湃、和諧高效的團(tuán)隊。公司秉承以“開放、自由、嚴(yán)謹(jǐn)、自律”為核心的企業(yè)文化,感謝他們對我們的高要求,感謝他們從不同領(lǐng)域給我們帶來的挑戰(zhàn),讓我們激情的團(tuán)隊有機(jī)會用頭腦與智慧不斷的給客戶帶來驚喜。創(chuàng)新互聯(lián)公司推出新絳免費(fèi)做網(wǎng)站回饋大家。獲取Json配置信息
獲取Xml配置信息
獲取xml節(jié)點(diǎn)屬性值
配置文件能否不和應(yīng)用放在一起呢? 答案是肯定的
對于netcore的netstandard擴(kuò)展來說其自帶了配置文件信息操作類,因?yàn)閏ore的Web應(yīng)用和控制臺應(yīng)用都是統(tǒng)一的,因此下面講解測試用例在控制臺應(yīng)用演示的,但是也可用于Web應(yīng)用;
首先,咋們需要在控制臺應(yīng)用中引用如下nuget包(我這里測試基于2.0):
Install-Package Microsoft.Extensions.Configuration -Version 2.0.0 Install-Package Microsoft.Extensions.Configuration.Abstractions -Version 2.0.0
獲取Json配置信息
要獲取json配置我們除了上面兩個引用外,還需要引用:
Install-Package Microsoft.Extensions.Configuration.Json -Version 2.0.0
這是json配置的基礎(chǔ)引用,我們在控制臺應(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}");
對于已經(jīng)有core開發(fā)經(jīng)驗(yàn)的朋友而言,上面直接能看懂,不過為了完善的講解這里還是需要簡單說下的:
ConfigurationBuilder實(shí)例過后需要通過SetBasePath方法設(shè)置配置文件基礎(chǔ)路徑,再通過AddJsonFile擴(kuò)展方法指定讀取的文件名稱;這些步驟執(zhí)行返回的都是IConfigurationBuilder接口,最后還需要Build方法執(zhí)行加載配置信息,這個builder有點(diǎn)類似于start的意思;來看看效果圖:
很顯然這里獲取到了配置文件中的MyConfig:UserName節(jié)點(diǎn)的值,這里通過 IConfigurationSection GetSection(string key); 函數(shù)獲取配置節(jié)點(diǎn),配置節(jié)點(diǎn)層級關(guān)系通過“:”鏈接,因此這里就有了key=MyConfig:UserName;
為了程序的美觀性和多使用性,這里吧獲取json文件的封裝為如下方法:
////// json配置文件讀取 /// /// /// ///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(); }
對了這里注意下AddJsonFile方法是通過開節(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ū)分大小寫,多級節(jié)點(diǎn)使用‘:'獲??;
獲取Xml配置信息
xml配置文件也是我們常見的,對已擴(kuò)展的IConfigurationBuilder來說,我們同樣也有類似于json那樣擴(kuò)展的方法,首先需要引用如下包:
Install-Package Microsoft.Extensions.Configuration.Xml -Version 2.0.0
然后幾乎和json同樣的代碼獲取xml配置文件:
////// xml配置文件讀取 /// /// /// ///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
下面來新建并初始化appsettings.xml配置文件信息:
神牛步行1 111111 神牛步行2 222222
再來看看調(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)的方式一樣“:”表示層級關(guān)系,但是特別注意點(diǎn)在于xml不需要最外層跟節(jié)點(diǎn),如這里的:GaoDeApi:UserName,如果按照json方式的話這里的key應(yīng)該是這樣:MyConfig:GaoDeApi:UserName,這里就是兩種的另外一種區(qū)別;如圖:
不出以外json和xml配置信息都能獲取到了;
獲取xml節(jié)點(diǎn)屬性值
通常xml配置文件節(jié)點(diǎn)還有屬性(attribute),如上面的xml節(jié)點(diǎn):
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)名稱不能是name,不然是無法讀取成功的;如這里的des改成name名稱的話,無法正常獲取信息,謹(jǐn)記于心;
配置文件能否不和應(yīng)用放在一起呢? 答案是肯定的
有部分朋友會提出一個問題:配置文件能否不和應(yīng)用放在一起呢? 答案是肯定的,我們只需把Directory.GetCurrentDirectory()(獲取當(dāng)前應(yīng)用所在磁盤目錄)替換成配置文件所在的基礎(chǔ)目錄就行了,如我這里的: configBasePath = @"D:\D\TTest";
下面是本次實(shí)例的整個測試用例代碼:
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(); } ////// json配置文件讀取 /// /// /// ///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(); } /// /// xml配置文件讀取 /// /// /// ///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(); } } }
關(guān)于.NetCore怎么獲取Json和Xml格式的配置信息就分享到這里了,希望以上內(nèi)容可以對大家有一定的幫助,可以學(xué)到更多知識。如果覺得文章不錯,可以把它分享出去讓更多的人看到。