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

本篇将和大家分享的是:如何获取JsonXml格式的配置信息,主要介绍的是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 }

 

关键词:配置 username json basepath xml 获取 文档 sblog 节点 append

相关推荐:

【API调用】腾讯云短信

Unity3D连接本地或局域网MySQL数据库

oracle监听器初识-配置多SERVICE_NAMES

MySql优化

使用ado.net打造通用的数据库操作类

Web Api:基于RESTful标准

redis安装与使用

数据库MySql在python中的使用

动力节点 mysql 郭鑫 34道经典的面试题三

[Mysql]——通过例子理解事务的4种隔离级别(转)