搜尋

首頁 >後端開發 >C#.Net教程 >.NetCore如何取得Json和Xml格式的設定資訊講解

.NetCore如何取得Json和Xml格式的設定資訊講解

巴扎黑
巴扎黑原創
2017-09-20 09:36:003719瀏覽

本篇將和大家分享的是如何獲取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, Actionae92d117680019c8adb696c6f7aa0015 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节点： 7a286013418a1834dc7c3eeef39dd0f2神牛步行100d001d0ea2d832461d3ff9217bf550e ，这个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();
  }
 }
}

以上是.NetCore如何取得Json和Xml格式的設定資訊講解的詳細內容。更多資訊請關注PHP中文網其他相關文章！

陳述：
本文內容由網友自願投稿，版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容，請聯絡admin@php.cn
上一篇：詳解.Net Core使用Socket與樹莓派進行通信下一篇：詳解.Net Core使用Socket與樹莓派進行通信

相關文章

看更多