C#依赖注入容器加载无报错但无法读取JSON配置文件问题排查

项目环境与代码 #

目录结构 #

C:\Users\myuser\repos\myapp\MyApp\
    bin/
    obj/
    MyConfig.cs
    myconfig.json
    Program.cs

myconfig.json内容 #

{
  "SerialKey": "12345"
}

MyConfig.cs代码 #

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

public class MyConfig
{
    public string SerialKey { get; set; }
}

Program.cs代码 #

namespace MyAppNamespace
{
    class Program
    {
        static void Main(string[] args)
        {
            IConfiguration configuration = new ConfigurationBuilder()
                .SetBasePath(AppContext.BaseDirectory)
                .AddJsonFile("myconfig.json", optional: true, reloadOnChange: true)
                .Build();

            // load app settings configs
            var serviceProvider = new ServiceCollection()
                .Configure<MyConfig>(options => configuration.GetSection("MyConfig").Bind(options))
                .BuildServiceProvider();

            var myConfig = serviceProvider.GetRequiredService<IOptions<MyConfig>>().Value;
            
            Console.WriteLine("serial key is: " + myConfig.SerialKey);

            // do something
            DoSomething();
        }
    }
}

问题分析 #

运行后myConfig.SerialKey为null且无报错，核心原因有三点：

• 配置绑定路径错误：JSON中SerialKey是根节点，但代码里尝试读取MyConfig子节点（该节点不存在），导致绑定失败。
• JSON文件未复制到输出目录：AppContext.BaseDirectory指向程序运行的bin目录，若文件未设置复制属性，配置构建器找不到文件，但optional: true会跳过报错，最终读取空配置。
• 缺少必要NuGet依赖：使用IConfiguration、ServiceCollection、IOptions需要对应包支持，隐性缺失可能导致功能异常。

修复步骤 #

1. 修正配置绑定逻辑（二选一） #

方案A：直接绑定根配置

修改Configure代码，用根配置直接绑定MyConfig：

var serviceProvider = new ServiceCollection()
    .Configure<MyConfig>(configuration)
    .BuildServiceProvider();

方案B：调整JSON结构匹配代码节点

如果要保留MyConfig节点，修改myconfig.json：

{
  "MyConfig": {
    "SerialKey": "12345"
  }
}

2. 设置JSON文件复制属性 #

在Visual Studio中：

• 右键myconfig.json → 「属性」
• 将「复制到输出目录」设为「如果较新则复制」或「始终复制」

3. 安装必要NuGet包 #

使用Package Manager Console执行：

Install-Package Microsoft.Extensions.Configuration.Json
Install-Package Microsoft.Extensions.DependencyInjection
Install-Package Microsoft.Extensions.Options

或使用.NET CLI命令：

dotnet add package Microsoft.Extensions.Configuration.Json
dotnet add package Microsoft.Extensions.DependencyInjection
dotnet add package Microsoft.Extensions.Options

验证修复 #

重新编译运行项目，myConfig.SerialKey可正确读取到12345。

内容的提问来源于stack exchange，提问作者hotmeatballsoup