查看: 447|回复: 0

[ASP.NET教程] .NetCore获取Json和Xml格式的配置信息

发表于 2018-1-3 08:00:01

本篇将和大家分享的是:如何获取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):

  1. Install-Package Microsoft.Extensions.Configuration -Version 2.0.0
  2. Install-Package Microsoft.Extensions.Configuration.Abstractions -Version 2.0.0
复制代码

获取Json配置信息

要获取json配置我们除了上面两个引用外,还需要引用:

  1. Install-Package Microsoft.Extensions.Configuration.Json -Version 2.0.0
复制代码

这是json配置的基础引用,我们在控制台应用中创建appsettings.json文件,并定义如下json配置文件信息:

  1. {
  2. "MyConfig": {
  3. "UserName": "神牛步行3",
  4. "userPwd": "666666",
  5. "GaoDeApi": {
  6. "UserName": "神牛步行1",
  7. "userPwd": "111111"
  8. },
  9. "BaiDuApi":{
  10. "userName": "神牛步行2",
  11. "userPwd": "222222"
  12. }
  13. }
  14. }
复制代码

然后只需要如下代码,即可获取到该文件信息:

  1. var configBasePath = Directory.GetCurrentDirectory(); //configBasePath = @"D:\D\TTest";
  2. sbLog.Append($"配置文件所在目录:{configBasePath}\n");
  3. var builder = new ConfigurationBuilder().
  4. SetBasePath(configBasePath).
  5. AddJsonFile("appsettings.json");
  6. var config = builder.Build();
  7. 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文件的封装为如下方法:

  1. /// <summary>
  2. /// json配置文件读取
  3. /// </summary>
  4. /// <param name="configFileName"></param>
  5. /// <param name="basePath"></param>
  6. /// <returns></returns>
  7. public static IConfigurationRoot GetJsonConfig(
  8. string configFileName = "appsettings.json",
  9. string basePath = "")
  10. {
  11. basePath = string.IsNullOrWhiteSpace(basePath) ? Directory.GetCurrentDirectory() : basePath;
  12. var builder = new ConfigurationBuilder().
  13. SetBasePath(basePath).
  14. AddJsonFile(configFileName);
  15. return builder.Build();
  16. }
复制代码

对了这里注意下AddJsonFile方法是通过开节引用的 Microsoft.Extensions.Configuration.Json 扩展的;由于IConfiguration不光用GetSection函数,她也能根据 this[string key] 方式获取节点,下面是分别获取高德地图和百度地图配置节点信息的代码和效果图:

  1. var configJson = GetJsonConfig();
  2. sbLog.Append($"json配置-MyConfg节点的值:\n");
  3. sbLog.Append($"高德-UserName:{configJson.GetSection("MyConfig:GaoDeApi:UserName").Value}\n");
  4. sbLog.Append($"百度-userName:{configJson["MyConfig:BaiDuApi:UserName"]}\n\r\n");
复制代码

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

获取Xml配置信息

xml配置文件也是我们常见的,对已扩展的IConfigurationBuilder来说,我们同样也有类似于json那样扩展的方法,首先需要引用如下包:

  1. Install-Package Microsoft.Extensions.Configuration.Xml -Version 2.0.0
复制代码

然后几乎和json同样的代码获取xml配置文件:

  1. /// <summary>
  2. /// xml配置文件读取
  3. /// </summary>
  4. /// <param name="configFileName"></param>
  5. /// <param name="basePath"></param>
  6. /// <returns></returns>
  7. public static IConfigurationRoot GetXmlConfig(
  8. string configFileName = "appsettings.xml",
  9. string basePath = "")
  10. {
  11. basePath = string.IsNullOrWhiteSpace(basePath) ? Directory.GetCurrentDirectory() : basePath;
  12. var builder = new ConfigurationBuilder().
  13. //SetBasePath(basePath).
  14. AddXmlFile(b =>
  15. {
  16. b.Path = configFileName;
  17. b.FileProvider = new PhysicalFileProvider(basePath);
  18. });
  19. return builder.Build();
  20. }
复制代码

区别在于扩展IConfigurationBuilder的AddXmlFile方法,本次示例为了多样化使用了 public static IConfigurationBuilder AddXmlFile(this IConfigurationBuilder builder, Action configureSource) 来传递配置文件名称和基础路径;

下面来新建并初始化appsettings.xml配置文件信息:

  1. <MyConfig>
  2. <GaoDeApi>
  3. <UserName des="高德的账号">神牛步行1</UserName>
  4. <userPwd>111111</userPwd>
  5. </GaoDeApi>
  6. <BaiDuApi>
  7. <userName des="百度的账号">神牛步行2</userName>
  8. <userPwd>222222</userPwd>
  9. </BaiDuApi>
  10. </MyConfig>
复制代码

再来看看调用获取配置节点的部分代码:

  1. var configXml = GetXmlConfig();
  2. sbLog.Append($"xml配置-MyConfg节点的值:\n");
  3. sbLog.Append($"高德-UserName:{configXml.GetSection("GaoDeApi:UserName").Value}\n");
  4. 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节点: 神牛步行1 ,这个des=""就是属性,我们要怎么才能获取这个值呢;这里其实同样还是通过':'来关联的,如下代码获取属性节点des的值:

  1. sbLog.Append($"高德-UserName-des:{configXml.GetSection("GaoDeApi:UserName:des").Value}\n");
  2. 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. namespace MyService
  9. {
  10. class Program
  11. {
  12. static void Main(string[] args)
  13. {
  14. Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
  15. Console.OutputEncoding = Encoding.GetEncoding("GB2312");
  16. var sbLog = new StringBuilder(string.Empty);
  17. var configBasePath = Directory.GetCurrentDirectory(); //configBasePath = @"D:\D\TTest";
  18. sbLog.Append($"配置文件所在目录:{configBasePath}\n");
  19. var builder = new ConfigurationBuilder().
  20. SetBasePath(configBasePath).
  21. AddJsonFile("appsettings.json");
  22. var config = builder.Build();
  23. sbLog.Append($"MyConfig:UserName节点的值:{config.GetSection("MyConfig:UserName").Value}\n\r\n");
  24. var configJson = GetJsonConfig();
  25. sbLog.Append($"json配置-MyConfg节点的值:\n");
  26. sbLog.Append($"高德-UserName:{configJson.GetSection("MyConfig:GaoDeApi:UserName").Value}\n");
  27. sbLog.Append($"百度-userName:{configJson["MyConfig:BaiDuApi:UserName"]}\n\r\n");
  28. var configXml = GetXmlConfig();
  29. sbLog.Append($"xml配置-MyConfg节点的值:\n");
  30. sbLog.Append($"高德-UserName:{configXml.GetSection("GaoDeApi:UserName").Value}\n");
  31. sbLog.Append($"百度-userName:{configXml["BaiDuApi:UserName"]}\n\r\n");
  32. sbLog.Append($"高德-UserName-des:{configXml.GetSection("GaoDeApi:UserName:des").Value}\n");
  33. sbLog.Append($"百度-userName-des:{configXml["BaiDuApi:UserName:des"]}\n\r\n");
  34. Console.WriteLine(sbLog);
  35. Console.ReadLine();
  36. }
  37. /// <summary>
  38. /// json配置文件读取
  39. /// </summary>
  40. /// <param name="configFileName"></param>
  41. /// <param name="basePath"></param>
  42. /// <returns></returns>
  43. public static IConfigurationRoot GetJsonConfig(
  44. string configFileName = "appsettings.json",
  45. string basePath = "")
  46. {
  47. basePath = string.IsNullOrWhiteSpace(basePath) ? Directory.GetCurrentDirectory() : basePath;
  48. var builder = new ConfigurationBuilder().
  49. SetBasePath(basePath).
  50. AddJsonFile(configFileName);
  51. return builder.Build();
  52. }
  53. /// <summary>
  54. /// xml配置文件读取
  55. /// </summary>
  56. /// <param name="configFileName"></param>
  57. /// <param name="basePath"></param>
  58. /// <returns></returns>
  59. public static IConfigurationRoot GetXmlConfig(
  60. string configFileName = "appsettings.xml",
  61. string basePath = "")
  62. {
  63. basePath = string.IsNullOrWhiteSpace(basePath) ? Directory.GetCurrentDirectory() : basePath;
  64. var builder = new ConfigurationBuilder().
  65. //SetBasePath(basePath).
  66. AddXmlFile(b =>
  67. {
  68. b.Path = configFileName;
  69. b.FileProvider = new PhysicalFileProvider(basePath);
  70. });
  71. return builder.Build();
  72. }
  73. }
  74. }
复制代码

总结

以上所述是小编给大家介绍的.NetCore获取Json和Xml格式的配置信息,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对程序员之家网站的支持!



回复

使用道具 举报