如何在 ASP.NET5 中正确读取 config.json 中的嵌套配置值？

Question

我关注了一些examples for ASP.NET 5，但对如何正确读取“嵌套”配置值（如果这是正确的术语）感到困惑。

这是config.json的相关部分：

{
    "ApplicationName" : "OwNextApp",
    "AppSettings": {
        "SiteTitle": "OwNext"
    },
}

以及HomeController.cs的相关部分：

public IActionResult About()
{
    var appNestedNameFailed = _config.Get("AppSettings.SiteTitle");
    var appNestedNameSuccess = _config.Get("AppSettings:SiteTitle");
    var appName = _config.Get("ApplicationName");
    ViewBag.Message = string.Format(@"Your 
        APP NAME: {0};
        APP NESTED NAME FAILED: {1}; 
        APP NESTED NAME SUCCESS: {2}", 
            appName, appNestedNameFailed, appNestedNameSuccess);

    return View();
}

appNestedNameFailed 的值为空（我在研究之前的初步尝试）。而appNestedNameSuccess 是有价值的；在我进行研究并在Configuration 的测试中发现之后（显示了相关代码）：

// Assert
Assert.Equal("IniValue1", config.Get("IniKey1"));
Assert.Equal("IniValue2", config.Get("IniKey2:IniKey3"));

有人可以解释为什么会这样吗？为什么使用: 而不是. 有意义？从我与 JSON 数据的交互来看，. 符号通常可以正常工作，例如How to access nested json data。

另外，我发现了类似的SO question，但这并没有解释为什么选择:。

Answer 1

这是我们在第一次创建配置模型时决定的约定。我们从 json 开始，: 是那里的分隔符。

无论如何，如果您不想担心这些约定，我建议使用 ConfigurationBinder 将配置绑定到模型（强类型对象）。 Here are the tests on GitHub 可以作为例子。

Answer 2

using Microsoft.Extensions.Configuration;
using System.IO;

IConfigurationRoot configuration = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json")
                .Build();

var connectionString = configuration.GetValue<string>("ConnectionStrings:DefaultConnection");

// or

var connectionString2= configuration.GetSection("ConnectionStrings").GetSection("DefaultConnection").Value;  

appsettings.json：

{
  "ConnectionStrings": {
    "DefaultConnection": "myconnection"
  },
}

Answer 3

深入了解JsonConfigurationFileParser 源的内部，并指责其中的进入/退出方法：

private void VisitJObject(JObject jObject)
{
    foreach (var property in jObject.Properties())
    {
        EnterContext(property.Name);
        VisitProperty(property);
        ExitContext();
    }
}

private void EnterContext(string context)
{
    _context.Push(context);
    _currentPath = string.Join(":", _context.Reverse());
}

private void ExitContext()
{
    _context.Pop();
    _currentPath = string.Join(":", _context.Reverse());
}

似乎 ASP.NET 团队应该留下更多有启发性的签入 cmets :)。

我的最佳猜测是 config.json 文件中可能存储了需要在其中包含 . 的数据，而 : 会不太常见。例如：

"AppSettings": {
    "Site.Title": "Is .NET getting faster?"
},

这是一个不好的例子，但他们希望尽可能“安全”并使用超出规范的东西似乎是合理的。如果你想存储一个类型的全名，那也会稍微容易一些，而无需担心杂散期。

"AppSettings": {
    "ImportantTypeName": "WebApp.CoolStuff.Helpers.AwesomeClass"
},