如何在.NET Core中配置日志
创始人
2024-11-27 18:01:54
0次

假设有预先设置的appsettings.json文件:

{
 "option1": "value1_from_json",
 "option2": 2,

 "subsection": {
  "suboption1": "subvalue1_from_json"
 },
 "wizards": [
  {
   "Name": "Gandalf",
   "Age": "1000"
  },
  {
   "Name": "Harry",
   "Age": "17"
  }
 ]
}

在代码中读取可以按下面的方式操作:

public class Program
{
  public static IConfiguration Configuration { get; set; }

  public static void Main(string[] args = null)
  {
    var builder = new ConfigurationBuilder()
      .SetBasePath(Directory.GetCurrentDirectory())
      .AddJsonFile("appsettings.json");

    Configuration = builder.Build();

    Console.WriteLine($"option1 = {Configuration["Option1"]}");
    Console.WriteLine($"option2 = {Configuration["option2"]}");
    Console.WriteLine(
      $"suboption1 = {Configuration["subsection:suboption1"]}");
    Console.WriteLine();

    Console.WriteLine("Wizards:");
    Console.Write($"{Configuration["wizards:0:Name"]}, ");
    Console.WriteLine($"age {Configuration["wizards:0:Age"]}");
    Console.Write($"{Configuration["wizards:1:Name"]}, ");
    Console.WriteLine($"age {Configuration["wizards:1:Age"]}");
    Console.WriteLine();

    Console.WriteLine("Press a key...");
    Console.ReadKey();
  }
}

首先,实例化一个ConfigurationBuilder对象,接着设置基础路径。

SetBasePath的操作其实是在ConfigurationBuilder的属性字典里设置FileProvider的值。
public static IConfigurationBuilder SetBasePath(this IConfigurationBuilder builder, string basePath)
{
  ...
  
  return builder.SetFileProvider(new PhysicalFileProvider(basePath));
}

public static IConfigurationBuilder SetFileProvider(this IConfigurationBuilder builder, IFileProvider fileProvider)
{
  ...

  builder.Properties[FileProviderKey] = fileProvider ?? throw new ArgumentNullException(nameof(fileProvider));
  return builder;
}

然后是添加JSON文件。

public static IConfigurationBuilder AddJsonFile(this IConfigurationBuilder builder, IFileProvider provider, string path, bool optional, bool reloadOnChange)
{
  ...

  return builder.AddJsonFile(s =>
  {
    s.FileProvider = provider;
    s.Path = path;
    s.Optional = optional;
    s.ReloadOnChange = reloadOnChange;
    s.ResolveFileProvider();
  });
}

public static IConfigurationBuilder AddJsonFile(this IConfigurationBuilder builder, Action configureSource)
  => builder.Add(configureSource);

ConfigurationBuilder里添加了一个JsonConfigurationSource对象。

最后,执行ConfigurationBuilder的Build方法,就可以得到保存配置信息的Configuration对象。

总结例子中的代码,获取配置信息的操作其实就分为两步:

1.生成Configuration对象
2.按键值从Configuration对象中获取信息

生成Configuration对象的步骤至少要有三个基础环节。

1.生成ConfigurationBuilder对象
2.添加ConfigurationSource对象
3.创建Configuration对象

查看创建Configuration对象的代码,会发现内部利用的其实是ConfigurationSource中创建的ConfigurationProvider对象。

public IConfigurationRoot Build()
{
  var providers = new List();
  foreach (var source in Sources)
  {
    var provider = source.Build(this);
    providers.Add(provider);
  }
  return new ConfigurationRoot(providers);
}

再看IConfiguratonSource接口,也只有一个Build方法。

public interface IConfigurationSource
{
  IConfigurationProvider Build(IConfigurationBuilder builder);
}

最终创建的Configuration对象,即ConfigurationRoot中包含了所有的ConfigurationProvider,说明配置信息都由这些ConfigurationProvider所提供。

跟踪至ConfigurationRoot类型的构造方法,果然在其生成对象时,对所有ConfigurationProvider进行了加载操作。

public ConfigurationRoot(IList providers)
{
  ...

  _providers = providers;
  foreach (var p in providers)
  {
    p.Load();
    ChangeToken.OnChange(() => p.GetReloadToken(), () => RaiseChanged());
  }
}

比如JsonConfigurationProvider中:

public override void Load(Stream stream)
{
  try
  {
    Data = JsonConfigurationFileParser.Parse(stream);
  }
  ...
}

通过JSON解析器,将JSON文件的配置信息读取至ConfigurationProvider的Data属性中。这个属性即是用于保存所有配置信息。

 /// 
 /// The configuration key value pairs for this provider.
 /// 
 protected IDictionary Data { get; set; }

有了ConfigurationRoot对象后,获取配置信息的操作就很简单了。遍历各个ConfigurationProvider,从中获取第一个匹配键值的数据。

public string this[string key]
{
  get
  {
    foreach (var provider in _providers.Reverse())
    {
      string value;

      if (provider.TryGet(key, out value))
      {
        return value;
      }
    }

    return null;
  }

  ...
}

ConfigurationProvider对象从Data属性获取配置的值。

public virtual bool TryGet(string key, out string value)
=> Data.TryGetValue(key, out value);

在最初的例子中可以看Configuration["wizards:0:Name"]这样的写法,这是因为在Load文件时,存储的方式就是用:为分隔符,以作为嵌套对象的键值。

也可以用另一种方法来写,将配置信息绑定为对象。

先定义对象类型:

public class AppSettings
{
  public string Option1 { get; set; }
  public int Option2 { get; set; }
  public Subsection Subsection { get; set; }
  public IList Wizards { get; set; }
}

public class Subsection
{
  public string Suboption1 { get; set; }
}

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

再绑定对象:

static void Main(string[] args)
{
  var builder = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json");

  Configuration = builder.Build();

  var appConfig = new AppSettings();
  Configuration.Bind(appConfig);

  Console.WriteLine($"option1 = {appConfig.Option1}");
  Console.WriteLine($"option2 = {appConfig.Option2}");
  Console.WriteLine(
    $"suboption1 = {appConfig.Subsection.Suboption1}");
  Console.WriteLine();

  Console.WriteLine("Wizards:");
  Console.Write($"{appConfig.Wizards[0].Name}, ");
  Console.WriteLine($"age {appConfig.Wizards[0].Age}");
  Console.Write($"{appConfig.Wizards[1].Name}, ");
  Console.WriteLine($"age {appConfig.Wizards[1].Age}");
  Console.WriteLine();

  Console.WriteLine("Press a key...");
  Console.ReadKey();
}

写法变成了常见的对象调用属性方式,但结果是一样的。

除了可以用JSON文件存储配置信息外,ASP.NET Core同时也支持INI与XML文件。当然有其它类型文件时,也可以通过实现IConfigurationSource接口并继承ConfigurationProvider类建立自定义的ConfigrationProvider对象来加载配置文件。

至于文件以外的方式,ASP.NET Core也提供了不少。

  1. 命令行,AddCommandLine

  2. 环境变量,AddEnvironmentVariables

  3. 内存, AddInMemoryCollection

  4. 用户机密,AddUserSecrets

  5. Azure Key Vault,AddAzureKeyVault

相关内容

热门资讯

空调连续工作多久需要停机休息 空调连续工作的时间取决于多个因素,包括空调的型号、功率、使用环境和维护情况等。一般来说,空调可以连续...
空调哪个符号是除湿的 空调除湿功能通常用一个水滴形状的符号表示。不同品牌和型号的空调遥控器可能会有所差异,但一般来说,除湿...
格力空调多长时间加一次氟利昂 1、一般情况下,空调对氟利昂的使用量是非常小的,所以在空调使用了四年左右的时候再考虑加也没问题。2、...
空调用多长时间需要加氟一次 一般情况下是五年。当出现以下这几种情况时,空调才需要加氟。1、空调的室内机和室外机各有两个接口,当接...
格调生活·C标思享荟:卡萨帝在... 9月12日的郑州龙湖金融岛,夜风轻拂,灯光璀璨。“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑...
品牌价值破千亿、高端份额持续领... 9月12日,“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑州站”在郑州龙湖金融岛举办。2026...
空调主板坏了修800还是换新的 空调主板坏了是修还是换新,需要考虑多个因素,以下是一些建议:1. 维修成本:如果维修费用较低,比如 ...
空调开多久需要休息多长时间 问题:空调开多久需要休息多长时间回答:1、在使用空调的过程中,一般空调开7~8个小时左右需要休息2~...
中央空调多长时间清洗一次 1、一般空调开机前清洗一次即可,空调开机中间时段再清洗一次,空调关机时清洗一次,这样比较合理。2、空...
中央空调氟利昂多久加一次 看空调制热和制冷程度,很多人的观点认为氟利昂必须一年放一次,其实这个观点是错误的,理解上面有点偏差,...