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

时间:2015-05-20 02:29:57

标签: c# asp.net asp.net-core config.json

我正在关注一些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,但这并没有解释选择:的原因。

3 个答案:

答案 0 :(得分:9)

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

无论如何,如果您不想担心这些约定,我建议使用ConfigurationBinder将配置绑定到模型(强类型对象)。 Here是可以作为示例的测试。

答案 1 :(得分:4)

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"
  },
}

答案 2 :(得分:1)

深入查看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"
},