欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

.NetCore获取Json和Xml格式的配置信息

程序员文章站 2022-06-28 16:09:41
本篇将和大家分享的是:如何获取json和xml格式的配置信息,主要介绍的是configuration扩展方法的使用,因为netcore的web应用在startup中已经默认...

本篇将和大家分享的是:如何获取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的意思;来看看效果图:

.NetCore获取Json和Xml格式的配置信息

很显然这里获取到了配置文件中的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");

.NetCore获取Json和Xml格式的配置信息

注意:节点不区分大小写,多级节点使用‘:'获取;

获取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,这里就是两种的另外一种区别;如图:

.NetCore获取Json和Xml格式的配置信息

不出以外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");

.NetCore获取Json和Xml格式的配置信息

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格式的配置信息,希望对大家有所帮助