ASP.Net Core 2.0 獲取Json和Xml格式的配置信息

時間 2019-11-11

標籤 asp.net asp core 2.0 獲取 json xml 格式配置信息欄目 ASP 简体版

原文原文鏈接

本篇將和你們分享的是：如何獲取Json和Xml格式的配置信息，主要介紹的是Configuration擴展方法的使用，由於netcore的web應用在Startup中已經默認嵌入appsettings.json文件的配置信息，故而我把測試點放在在了netcore的控制檯應用上；控制檯上使用配置文件也是經常使用的事情，而且官網實例主要講解的是json格式，對xml格式直接帶過了，所以有了本篇的分享，但願能給你好的幫助；web

獲取Json配置信息
獲取Xml配置信息
獲取xml節點屬性值
配置文件可否不和應用放在一塊兒呢？答案是確定的

對於netcore的netstandard擴展來講其自帶了配置文件信息操做類，由於core的Web應用和控制檯應用都是統一的，所以下面講解測試用例在控制檯應用演示的，可是也可用於Web應用；json

首先，咋們須要在控制檯應用中引用以下nuget包（我這裏測試基於2.0）：app

Install-Package Microsoft.Extensions.Configuration -Version 2.0.0 ide

Install-Package Microsoft.Extensions.Configuration.Abstractions -Version 2.0.0 函數

獲取Json配置信息

要獲取json配置咱們除了上面兩個引用外，還須要引用：測試

Install-Package Microsoft.Extensions.Configuration.Json -Version 2.0.0 ui

這是json配置的基礎引用，咱們在控制檯應用中建立appsettings.json文件，並定義以下json配置文件信息：this

{
  "MyConfig": {
    "UserName": "神牛步行3",
    "userPwd": "666666",
    "GaoDeApi": {
      "UserName": "神牛步行1",
      "userPwd": "111111"
    },
    "BaiDuApi":{
      "userName": "神牛步行2",
      "userPwd": "222222"
    }
  }
}

而後只須要以下代碼，便可獲取到該文件信息：spa

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開發經驗的朋友而言，上面直接能看懂，不過爲了完善的講解這裏仍是須要簡單說下的：xml

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 }