.NET Core开发之配置详解

更新时间：2018年08月05日 15:49:26 作者：Ken.W

这篇文章给大家分享了.NET Core开发中相关配置的知识点内容，有需要的朋友们可以参考下。

熟悉ASP.NET的开发者一定对web.config文件不陌生。在ASP.NET环境中，要想添加配置参数，一般也都会在此文件中操作。其中最常用的莫过于AppSettings与ConnectionStrings两项。而要在代码中获得文件中的配置信息，ConfigurationManager则是必不可少需要引入的程序集。

然而到了ASP.NET Core时代，存储与读取配置的方式都发生了改变。

如果对ASP.NET Core项目有所了解的话，应该会看到过appsettings.json这个文件。这里就从JSON文件配置方式开始解释ASP.NET Core中是如何读取配置信息的。

假设有预先设置的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<JsonConfigurationSource> configureSource)
  => builder.Add(configureSource);

ConfigurationBuilder里添加了一个JsonConfigurationSource对象。

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

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

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

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

生成ConfigurationBuilder对象
添加ConfigurationSource对象

创建Configuration对象

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

public IConfigurationRoot Build()
{
  var providers = new List<IConfigurationProvider>();
  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<IConfigurationProvider> 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属性中。这个属性即是用于保存所有配置信息。

 /// <summary>
 /// The configuration key value pairs for this provider.
 /// </summary>
 protected IDictionary<string, string> 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> 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也提供了不少。

命令行，AddCommandLine
环境变量，AddEnvironmentVariables
内存， AddInMemoryCollection
用户机密，AddUserSecrets
Azure Key Vault，AddAzureKeyVault

选择何种存储与读取配置的方法取决于实际场景，ASP.NET Core已经开放了配置方面的入口，任何接入方式理论上都是可行的。实践方面，则需要开发者们不断去尝试与探索。

您可能感兴趣的文章:

.NET
Core

C#中如何将MongoDB->RunCommand结果映射到业务类的方法总结
这篇文章主要给大家总结介绍了关于C#中如何将MongoDB->RunCommand结果映射到业务类的方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面来一起看看吧。
2018-04-04
C#常用GDI+文字操作汇总
这篇文章主要介绍了C#常用GDI+文字操作,包括文字投影、倒影、旋转等特效,对于提升程序界面的视觉效果有很大的用处,需要的朋友可以参考下
2014-08-08
详解从零开始---用C#制作扫雷游戏
这篇文章主要介绍了详解从零开始---用C#制作扫雷游戏，非常具有实用价值，需要的朋友可以参考下
2017-06-06
C# Char结构中IsLetterOrDigit(Char)的方法详解
这篇文章给大家介绍了C#的Char 结构的IsLetterOrDigit(Char)的方法,并通过代码示例给大家介绍的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
2024-02-02
C#操作FTP出现500错误解决办法
最近在做项目的时候需要操作ftp进行文件的上传下载，但在调用using (var response = (FtpWebResponse)FtpWebRequest.GetResponse())的时候总是出现"远程服务器返回错误:(550)文件不可用(例如,未找到文件,无法访问文件)"的异常
2014-03-03
C# 一个WCF简单实例
以订票为例简单应用wcf程序，需要的朋友可以参考下
2012-10-10
Unity键盘WASD实现物体移动
这篇文章主要为大家详细介绍了Unity键盘WASD实现物体移动，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-02-02
简单对比C#程序中的单线程与多线程设计
这篇文章主要介绍了C#程序中的单线程与多线程设计的简单对比,通过实际的代码演示可以清晰看出多线程并发来避免单线程阻塞问题的特点,需要的朋友可以参考下
2016-04-04
C# 守护进程的介绍及实现详解
本文主要介绍了C# 守护进程的介绍及实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-06-06
C#集合之链表的用法
这篇文章介绍了C#集合之链表的用法，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-04-04