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

转载于:https://www.cnblogs.com/wangrudong003/p/7535650.html

.NetCore获取Json和Xml格式的配置信息相关推荐

ajax请求json和xml数据及对json和xml格式数据的解析
ajax请求json和xml数据及对json和xml格式数据的解析一.ajax请求json数据并解析 ajax的写法: json数据解析: 请求json经常出现的跨域报错: 二.ajax请求xml数 ...
node 微信开发 json转xml 格式
在微信开发中,大多请求接口格式需要传xml,所以提供一下微信适用的json转xml格式代码: json2Xml: (json) => {let _xml = '';Object.keys(jso ...
Retrofit动态设置支持JSON和XML格式转换工厂
Retrofit动态设置支持JSON和XML格式转换工厂 Retrofit-Converter.Factory转换工厂导入相关依赖创建ConverterFormat枚举类声明RequestCon ...
Tomcat下conf下server.xml的文件配置信息
Tomcat下conf下server.xml的文件配置信息,基本上不用做任何修改就可以使用,修改的地方就是host区域的一些配置,此文件设置端口为80. 注意:Tomcat配置文件中(即server. ...
mybatis-config.xml常用的配置信息
本文来说下mybatis-config.xml常用的配置信息文章目录概述概述 mybatis-config.xml常用的配置信息 <?xml version="1.0" ...
java 序列化成xml文件_将Java对象序列化成JSON和XML格式
1.先定义一个Java对象Person: public class Person { String name; int age; int number; public String getName() ...
SpringBoot使用教程【1】Restful API设计返回json，xml格式...
版权声明:本文为博主原创文章,未经博主允许不得转载. https://blog.csdn.net/qingfeng812/article/details/74738885 效果展示: 浏览器截图 ht ...
php json 转 xml格式,PHP中如何将JSON文件转XML格式
首先获取JSON文件中的字符:$content = file_get_contents('./data.json'); 然后使用函数"json_decode()"函数将字符串转为数 ...
java json转换xml格式_在Java中将JSON对象转换为XML格式？
JSON是一种轻量级的数据交换格式,并且JSON的格式类似于键值对.我们可以使用org.json.XML类将JSONObject转换为XML格式,这提供了将XML文本转换为JSONObject并将JS ...

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

获取Json配置信息

获取Xml配置信息

获取xml节点属性值

配置文件能否不和应用放在一起呢？答案是肯定的

.NetCore获取Json和Xml格式的配置信息相关推荐

最新文章

热门文章

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

获取Json配置信息

获取Xml配置信息

获取xml节点属性值

配置文件能否不和应用放在一起呢？ 答案是肯定的

.NetCore获取Json和Xml格式的配置信息相关推荐

最新文章

热门文章

配置文件能否不和应用放在一起呢？答案是肯定的