appsettings.json配置绑定自定义配置类失败如何解决

核心错误原因 #

你当前代码调用GetSection时传入的配置节路径和appsettings.json里的实际配置层级不匹配，是导致绑定失效的最直接原因。

排查步骤 #

• 配置路径修正 #

  你当前代码取的是名为MainUserConfiguration的配置节，但是你的配置文件里对应MainUser的配置是嵌套在AppSettings节点下的，正确的层级路径为AppSettings:MainUser，将绑定代码修改为：

  MainUserConfiguration mainUserConfiguration = new MainUserConfiguration();
  var configSection = config.GetSection("AppSettings:MainUser");
  configSection.Bind(mainUserConfiguration);
  

  也可以用更简洁的写法直接获取绑定后的实例：

  var mainUserConfiguration = config.GetSection("AppSettings:MainUser").Get<MainUserConfiguration>();
  

• 自定义配置类校验 #

  确保MainUserConfiguration类的属性和配置文件里的键名、类型完全匹配：

  1. 属性名拼写要和配置一致，注意你配置里写的是SesstionTimeInMin（存在拼写错误，比正确的Session多了个s），如果类里属性名是正确的SessionTimeInMin也会绑定失败
  2. 类型匹配：SesstionTimeInMin可以直接声明为int类型，配置绑定会自动转换字符串格式的数字
     正确的配置类示例：

  public class MainUserConfiguration
  {
      public string Name { get; set; }
      public string Surname { get; set; }
      public int SesstionTimeInMin { get; set; }
  }
  

• 配置文件加载校验 #

  • 确认appsettings.json文件的「复制到输出目录」属性设置为「如果较新则复制」，避免运行时找不到配置文件
  • 如果你是非ASP.NET Core项目（比如控制台应用），需要手动添加JSON配置源：

  IConfiguration config = new ConfigurationBuilder()
      .SetBasePath(AppContext.BaseDirectory)
      .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
      .Build();
  

  • 配置文件里的尾随逗号可以去掉，避免部分低版本JSON解析器报错，修正后的配置片段：

  {
    "AppSettings": {
      "MainUser": {
        "Name": "Urs",
        "Surname": "Barandun",
        "SesstionTimeInMin": "30"
      }
    }
  }
  

内容的提问来源于stack exchange，提问作者Franz Peter Tebartz van Elst