C# .Net中如何实现自定义JSON文件的多环境自动扩展

问题描述 #

项目中读取包含API URL列表的JSON文件，反序列化后发起健康检查请求。需要实现类似web.config环境变量的效果，针对开发、测试、生产等不同环境自动使用对应的JSON配置文件，且方案需支持任意JSON文件（不限于appsettings.json）。

当前使用的JSON结构：

{
  "ListOfApi": [
    {
      "EndPoint": "URL1",
      "Description": "Desc1"
    },
    {
      "EndPoint": "URL2",
      "Description": "Desc2"
    }
  ]
}

反序列化类：

public class ApiHealthCheckObject
{
    public string EndPoint { get; set; }
    public string Description { get; set; }
}

public class ApiHealthCheckJsonObject
{
    public List<ApiHealthCheckObject> ListOfApi { get; set; }
}

解决方案 #

方法一：Visual Studio 构建时配置转换 #

通过修改项目文件，实现构建时根据当前配置（Debug/Release等）自动复制对应环境的JSON文件到输出目录，覆盖主配置文件。

1. 创建环境特定JSON文件
   在Resources目录下创建对应环境的文件，例如：

   • HealthCheckList.Development.json（对应Debug环境）
   • HealthCheckList.Production.json（对应Release环境）

2. 修改项目文件（.csproj）
   添加以下MSBuild规则，实现构建时的文件复制：

<ItemGroup>
  <!-- 主配置文件，默认复制到输出目录 -->
  <None Include="Resources\HealthCheckList.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
  </None>
  <!-- 环境特定配置文件，作为主文件的依赖项，不默认复制 -->
  <None Include="Resources\HealthCheckList.*.json">
    <DependentUpon>HealthCheckList.json</DependentUpon>
    <CopyToOutputDirectory>Never</CopyToOutputDirectory>
  </None>
</ItemGroup>

<!-- 构建后根据当前配置复制对应环境的文件 -->
<Target Name="CopyEnvironmentSpecificJson" AfterTargets="AfterBuild">
  <Copy 
    SourceFiles="Resources\HealthCheckList.$(Configuration).json" 
    DestinationFiles="$(OutputPath)\Resources\HealthCheckList.json"
    Condition="Exists('Resources\HealthCheckList.$(Configuration).json')" />
</Target>

• 若环境名称与配置名称不匹配（比如Debug对应Test环境），可修改$(Configuration)为自定义环境变量，或调整文件名与配置名称一致。

方法二：运行时动态加载环境特定文件 #

通过代码检测当前环境变量，动态拼接配置文件名并加载，支持运行时切换环境。

修改原Execute方法逻辑：

protected override ResponseDTO Execute(RequestDTO request)
{
    ResponseDTO response = new ResponseDTO { ApiPropertiesObjects = new List<ApiHealthCheckObject>() };
    
    // 获取环境变量（可自定义变量名，这里用通用的ASPNETCORE_ENVIRONMENT）
    string environment = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT") ?? "Development";
    // 拼接环境特定配置文件名
    string configFileName = $"HealthCheckList.{environment}.json";
    string configPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, @"Resources", configFileName);

    // 若环境特定文件不存在，回退到默认配置文件
    if (!File.Exists(configPath))
    {
        configPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, @"Resources\HealthCheckList.json");
    }

    // 读取并反序列化配置
    using (StreamReader readFile = new StreamReader(configPath, Encoding.UTF8))
    {
        ApiHealthCheckJsonObject healthCheckObjects = JsonConvert.DeserializeObject<ApiHealthCheckJsonObject>(readFile.ReadToEnd());
        foreach (var api in healthCheckObjects.ListOfApi)
        {
            if (!SendReqUrlsAndHealthCheck(api))
            {
                response.ApiPropertiesObjects.Add(api);
            }
        }
    }
    return response;
}

• 需将所有环境特定JSON文件的复制到输出目录设置为PreserveNewest，确保文件能被输出到运行目录。

方法三：使用Microsoft.Extensions.Configuration框架 #

利用官方配置框架，支持多环境配置的分层覆盖、热重载等功能，适合复杂配置场景。

1. 安装NuGet包
   安装以下包：

   Microsoft.Extensions.Configuration
   Microsoft.Extensions.Configuration.Json
   

2. 构建配置并绑定到类

// 在项目初始化环节构建配置对象
var configBuilder = new ConfigurationBuilder()
    .SetBasePath(AppDomain.CurrentDomain.BaseDirectory)
    // 加载主配置文件（必填）
    .AddJsonFile(@"Resources\HealthCheckList.json", optional: false, reloadOnChange: true)
    // 加载环境特定配置文件（可选，会覆盖主配置的对应项）
    .AddJsonFile(
        $"Resources\\HealthCheckList.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT") ?? "Development"}.json",
        optional: true,
        reloadOnChange: true
    );

IConfiguration configuration = configBuilder.Build();

// 绑定配置到你的类（直接获取ListOfApi节点）
List<ApiHealthCheckObject> apiList = configuration.GetSection("ListOfApi").Get<List<ApiHealthCheckObject>>();

• 此方法支持部分覆盖：环境特定JSON只需定义需要修改的项，无需重复整个配置结构。

方案选择建议 #

• 若需构建时确定环境、部署后无需调整，选择方法一；
• 若需运行时灵活切换环境，选择方法二；
• 若配置结构复杂、需要分层覆盖或热重载，选择方法三。

内容的提问来源于stack exchange，提问作者Emin Altınışık