.netCore读取配置文件

一：netcore读取配置文件（单个节点配置，得到的是字符串）

.netcore里面是没有web.config等xml文件，但是它是有appsettings.json，在发布后会生成到对应的项目中。如下图：

在framework项目中，我们晓得读取web.config文件，需要引用ConfigManager，然后是用ConfigurationManager.AppSettings[key]等方式读取，那么在.netCore该如何读取呢？

下面是appsettings.json的文件内容

{
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "option1": "value1_from_json",
  "option2": 2,
  "subsection": {
    "suboption1": "subvalue1_from_json"
  },
  "wizards": [
    {
      "Name": "Gandalf",
      "Age": "1000"
    },
    {
      "Name": "Harry",
      "Age": "17"
    }
  ],
  "AllowedHosts": "*"
}

读取的时候，其实.netCore已经有封装好的方法，我们直接拿来用就可以，下面在Startup下面进行调试监视Configuration，然后会发现如下图：

 所以如果想要读取的时候可以通过可以来获取，如下代码：

Console.WriteLine($"option1 = {this.Configuration["Option1"]}");
Console.WriteLine($"option2 = {this.Configuration["option2"]}");
Console.WriteLine($"suboption1 = {this.Configuration["subsection:suboption1"]}");
Console.WriteLine("Wizards:");
Console.Write($"{this.Configuration["wizards:0:Name"]}, ");
Console.WriteLine($"age {this.Configuration["wizards:0:Age"]}");
Console.Write($"{this.Configuration["wizards:1:Name"]}, ");
Console.WriteLine($"age {this.Configuration["wizards:1:Age"]}");

只能通过key来获取对应的值。

然后我们可以对上面进行封装一下：

1：新增帮助类：

public class SiteConfig
{
    private static IConfiguration _iConfiguration = null;

    /// <summary>
    /// key的值
    /// </summary>
    public static string AppSetting(string key)
    {
        string str  = _iConfiguration.GetSection(key)?.Value;              
        return str;
    }

    public static void SetAppSetting(IConfiguration iConfiguration)
    {
        _iConfiguration = iConfiguration;
    }   
}

2：然后在Startup启动时初始化config对象：

 // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
 public void Configure(IApplicationBuilder app, IHostingEnvironment env)
 {
     SiteConfig.SetAppSetting(this.Configuration); //初始化config对象
 
     app.UseSession();
     app.UseStaticFiles();
     app.UseCookiePolicy();
     app.UseMvc(routes =>
     {
         routes.MapRoute(
             name: "default",
             template: "{controller=Home}/{action=Index}/{id?}");
     });
 }

3：直接在用到的地方可以直接拿来使用，具体使用如下：

 var test1 = SiteConfig.AppSetting("option1");
 var test2 = SiteConfig.AppSetting("wizards:1:Name");
 var test3 = SiteConfig.AppSetting("subsection:suboption1");
 var test4 = SiteConfig.AppSetting("subsection:suboption1");

看完上面的代码，小伙伴肯定会问，只能通过这样的方式读取吗？wizards明明就是一个json格式，我们能直接获取这样的结构体吗？答案是肯定的，下面第二条我们来具体介绍

 

二：netcore读取appsettings.json的整个json节点

下面我们来封装一个方法来进行读取：

1：新增工具类

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Configuration.Json;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;

namespace Test.Core.MVC6.Models
{
    public class ConfigurationTool
    {
        public static T GetAppSettings<T>(string key) where T : class, new()
        {
            IConfiguration config = new ConfigurationBuilder()
            .Add(new JsonConfigurationSource { Path = "appsettings.json", ReloadOnChange = true })
            .Build();

            T appconfig = new ServiceCollection()
                .AddOptions()
                .Configure<T>(config.GetSection(key))
                .BuildServiceProvider()
                .GetService<IOptions<T>>()
                .Value;

            return appconfig;
        }
    }
}

2：新增对应要读取的配置的json对应的实体类，我们以wizards为例：

 public class Wizards
 {
     public string Name { set; get; }

     public int Age { set; get; }
 }

3：最重要的一点儿是要设置appsettings.json属性为始终复制，这样编译会生成到对应的bin目录下面，不设置，上面第一步的配置文件会找不到该文件。

4：通过下面调用：

 //wizards为Appsettings.json文件的节点的名字
 var wizardLists =ConfigurationTool.GetAppSettings<List<Wizards>>("wizards");

这样就实现了读取配置文件整个格式。