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

Question

我正在关注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是有价值的； 在我做了研究并在配置测试中发现之后（显示了相关代码）：

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

有人可以解释为什么会这样吗？ 为什么使用: over 有意义. ? 从我通常与 JSON 数据的交互来看. 符号工作正常，例如如何访问嵌套的 json 数据。

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

Answer 1

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

无论如何，如果您不想担心这些约定，我建议使用ConfigurationBinder ，它将配置绑定到模型（强类型对象）。 以下是可以作为示例的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 团队应该留下更多有启发性的签入评论:)。

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

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

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

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