本篇将同豪门享受的是:如何获取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的意思;来看望效果图:

图片 1

不行强烈这里收获到了安排文件被的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");

图片 2

注意:节点不区分轻重缓急写,多级节点使用‘:’获取;

拿到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,这里虽是鲜种植的此外一种植有别于;如图:

图片 3

匪发出因外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");

图片 4

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 }

 

相关文章

网站地图xml地图