.NetCore獲取Json和Xml格式的配置資訊

神牛003發表於2017-09-18
NetCoreJSONXML

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

  • 獲取Json配置資訊
  • 獲取Xml配置資訊
  • 獲取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"; 

下面是本次例項的整個測試用例程式碼：

 1 using Microsoft.Extensions.Configuration;
 2 using Microsoft.Extensions.Configuration.Json;
 3 using Microsoft.Extensions.FileProviders;
 4 using System;
 5 using System.Diagnostics;
 6 using System.IO;
 7 using System.Text;
 8 
 9 namespace MyService
10 {
11     class Program
12     {
13         static void Main(string[] args)
14         {
15             
16             Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
17             Console.OutputEncoding = Encoding.GetEncoding("GB2312");
18 
19             var sbLog = new StringBuilder(string.Empty);
20             var configBasePath = Directory.GetCurrentDirectory(); //configBasePath = @"D:\D\TTest";
21             sbLog.Append($"配置檔案所在目錄：{configBasePath}\n");
22 
23             var builder = new ConfigurationBuilder().
24                 SetBasePath(configBasePath).
25                 AddJsonFile("appsettings.json");
26             var config = builder.Build();
27             sbLog.Append($"MyConfig:UserName節點的值：{config.GetSection("MyConfig:UserName").Value}\n\r\n");
28 
29             var configJson = GetJsonConfig();
30             sbLog.Append($"json配置-MyConfg節點的值：\n");
31             sbLog.Append($"高德-UserName：{configJson.GetSection("MyConfig:GaoDeApi:UserName").Value}\n");
32             sbLog.Append($"百度-userName：{configJson["MyConfig:BaiDuApi:UserName"]}\n\r\n");
33 
34             var configXml = GetXmlConfig();
35             sbLog.Append($"xml配置-MyConfg節點的值：\n");
36             sbLog.Append($"高德-UserName：{configXml.GetSection("GaoDeApi:UserName").Value}\n");
37             sbLog.Append($"百度-userName：{configXml["BaiDuApi:UserName"]}\n\r\n");
38 
39             sbLog.Append($"高德-UserName-des：{configXml.GetSection("GaoDeApi:UserName:des").Value}\n");
40             sbLog.Append($"百度-userName-des：{configXml["BaiDuApi:UserName:des"]}\n\r\n");
41 
42             Console.WriteLine(sbLog);
43             Console.ReadLine();
44         }
45 
46         /// <summary>
47         /// json配置檔案讀取
48         /// </summary>
49         /// <param name="configFileName"></param>
50         /// <param name="basePath"></param>
51         /// <returns></returns>
52         public static IConfigurationRoot GetJsonConfig(
53             string configFileName = "appsettings.json",
54             string basePath = "")
55         {
56             basePath = string.IsNullOrWhiteSpace(basePath) ? Directory.GetCurrentDirectory() : basePath;
57 
58             var builder = new ConfigurationBuilder().
59                SetBasePath(basePath).
60                AddJsonFile(configFileName);
61             return builder.Build();
62         }
63 
64         /// <summary>
65         /// xml配置檔案讀取
66         /// </summary>
67         /// <param name="configFileName"></param>
68         /// <param name="basePath"></param>
69         /// <returns></returns>
70         public static IConfigurationRoot GetXmlConfig(
71             string configFileName = "appsettings.xml",
72             string basePath = "")
73         {
74             basePath = string.IsNullOrWhiteSpace(basePath) ? Directory.GetCurrentDirectory() : basePath;
75 
76             var builder = new ConfigurationBuilder().
77                //SetBasePath(basePath).
78                AddXmlFile(b =>
79                {
80                    b.Path = configFileName;
81                    b.FileProvider = new PhysicalFileProvider(basePath);
82                });
83             return builder.Build();
84         }
85     }
86 }

 

相關文章