.NetCore如何擷取Json和Xml格式的配置資訊講解

本篇將和大家分享的是如何擷取Json和Xml格式的配置資訊，主要介紹的是Configuration擴充方法的使用，對.netcore 擷取json和xml格式的配置資訊的相關知識，感興趣的朋友一起看看吧

本篇將和大家分享的是：如何擷取Json和Xml格式的配置資訊，主要介紹的是Configuration擴充方法的使用，因為netcore的web應用在Startup中已經預設嵌入appsettings.json檔案的配置資訊，故而我把測試點放在在了netcore的控制台應用上；控制台上使用設定檔也是常用的事情，並且官網執行個體主要講解的是json格式，對xml格式直接帶過了，因此有了本篇的分享，希望能給你好的協助；

1. 擷取Json配置資訊

2. 擷取Xml配置資訊

3. 擷取xml節點屬性值

設定檔能否不和應用放在一起呢？ 答案是肯定的

對於netcore的netstandard擴充來說其內建了設定檔資訊操作類，因為core的Web應用和控制台應用都是統一的，因此下面講解測試案例在控制台應用示範的，但是也可用於Web應用；

首先，咋們需要在控制台應用中引用如下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配置的基礎引用，我們在控制台應用中建立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節點的值：{config.GetSection("MyConfig:UserName").Value}");

對於已經有core開發經驗的朋友而言，上面直接能看懂，不過為了完善的講解這裡還是需要簡單說下的：

ConfigurationBuilder執行個體過後需要通過SetBasePath方法設定設定檔基礎路徑，再通過AddJsonFile擴充方法指定讀取的檔案名稱；這些步驟執行返回的都是IConfigurationBuilder介面，最後還需要Build方法執行載入配置資訊，這個builder有點類似於start的意思；來看看：

很顯然這裡擷取到了設定檔中的MyConfig:UserName節點的值，這裡通過 IConfigurationSection GetSection(string key); 函數擷取配置節點，配置節點層級關係通過“:”連結，因此這裡就有了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();}

對了這裡注意下AddJsonFile方法是通過開節引用的 Microsoft.Extensions.Configuration.Json 擴充的；由於IConfiguration不光用GetSection函數，她也能根據 this[string key] 方式擷取節點，下面是分別擷取高德地圖和百度地圖配置節點資訊的代碼和：

var configJson = GetJsonConfig();sbLog.Append($"json配置-MyConfg節點的值：\n");sbLog.Append($"高德-UserName：{configJson.GetSection("MyConfig:GaoDeApi:UserName").Value}\n");sbLog.Append($"百度-userName：{configJson["MyConfig:BaiDuApi:UserName"]}\n\r\n");

注意：節點不區分大小寫，多級節點使用‘:'擷取；

擷取Xml配置資訊

xml設定檔也是我們常見的，對已擴充的IConfigurationBuilder來說，我們同樣也有類似於json那樣擴充的方法，首先需要引用如下包：

 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();}

區別在於擴充IConfigurationBuilder的AddXmlFile方法，本次樣本為了多樣化使用了 public static IConfigurationBuilder AddXmlFile(this IConfigurationBuilder builder, Action<XmlConfigurationSource> configureSource) 來傳遞設定檔名稱和基礎路徑；

下面來建立並初始化appsettings.xml設定檔資訊：

<MyConfig> <GaoDeApi> <UserName des="高德的帳號">神牛步行1</UserName> <userPwd>111111</userPwd> </GaoDeApi> <BaiDuApi> <userName des="百度的帳號">神牛步行2</userName> <userPwd>222222</userPwd> </BaiDuApi></MyConfig>

再來看看調用擷取配置節點的部分代碼：

var configXml = GetXmlConfig();sbLog.Append($"xml配置-MyConfg節點的值：\n");sbLog.Append($"高德-UserName：{configXml.GetSection("GaoDeApi:UserName").Value}\n");sbLog.Append($"百度-userName：{configXml["BaiDuApi:UserName"]}\n\r\n");

能夠看出xml和json讀取配置節點的方式一樣“:”展示層級關係，但是特別注意點在於xml不需要最外層跟節點，如這裡的：GaoDeApi:UserName，如果按照json方式的話這裡的key應該是這樣：MyConfig:GaoDeApi:UserName，這裡就是兩種的另外一種區別；

不出以外json和xml配置資訊都能擷取到了；

擷取xml節點屬性值

通常xml設定檔節點還有屬性(attribute)，如上面的xml節點： <UserName des="高德的帳號">神牛步行1</UserName> ，這個des=""就是屬性，我們要怎麼才能擷取這個值呢；這裡其實同樣還是通過':'來關聯的，如下代碼擷取屬性節點des的值：

sbLog.Append($"高德-UserName-des：{configXml.GetSection("GaoDeApi:UserName:des").Value}\n");sbLog.Append($"百度-userName-des：{configXml["BaiDuApi:UserName:des"]}\n\r\n");

xml屬性節點名稱不能是name，不然是無法讀取成功的；如這裡的des改成name名稱的話，無法正常擷取資訊，謹記於心；

設定檔能否不和應用放在一起呢？ 答案是肯定的

有部分朋友會提出一個問題：設定檔能否不和應用放在一起呢？ 答案是肯定的，我們只需把Directory.GetCurrentDirectory()（擷取當前應用所在磁碟目錄）替換成設定檔所在的基礎目錄就行了，如我這裡的： configBasePath = @"D:\D\TTest";

下面是本次執行個體的整個測試案例代碼：

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節點的值：{config.GetSection("MyConfig:UserName").Value}\n\r\n");   var configJson = GetJsonConfig();   sbLog.Append($"json配置-MyConfg節點的值：\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節點的值：\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();  } }}