ASP.NET Core 6 如何同步appsettings.json与Debug/Release生成配置

你当前用条件编译宏硬绑定运行环境的方式灵活性很差，完全没必要这么写，ASP.NET Core 内置的默认配置逻辑已经原生支持你要的多环境配置加载能力，不需要手动写环境切换代码。

核心原理 #

Host.CreateDefaultBuilder 方法默认已经内置了多环境配置加载规则：

• 首先加载基础配置文件 appsettings.json
• 自动读取系统环境变量 ASPNETCORE_ENVIRONMENT 的值作为当前运行环境名
• 再加载对应环境的配置文件 appsettings.{环境名}.json，文件中重名的配置项会覆盖基础配置文件的值
• 如果没有设置 ASPNETCORE_ENVIRONMENT 环境变量，默认值就是 Production，刚好匹配你Release发布的需求。

具体实现步骤 #

1. 删掉你代码里所有 #if DEBUG 相关的条件编译和 UseEnvironment 配置，精简后的CreateHostBuilder代码如下：

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureLogging(logging =>
        {
           // 保留你原有日志配置逻辑
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

2. 本地Debug调试的环境配置不需要写在代码里，直接修改项目下Properties/launchSettings.json文件，在调试启动配置的环境变量中指定开发环境即可，这个文件仅在本地开发调试时生效，不会跟随项目发布：

{
  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "你的项目名称": {
      "commandName": "Project",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

3. Release发布部署时，只需要在部署的服务器、容器或者IIS配置中设置环境变量ASPNETCORE_ENVIRONMENT的值为Production即可，不需要重新编译代码。如果需要切换到预发布、测试等其他环境，只需要修改对应环境变量值，新增对应名称的appsettings配置文件即可，无需改动业务代码。

原有写法的弊端 #

• 把编译模式和运行环境强绑定，违背了ASP.NET Core配置与代码分离的设计原则
• 后续新增测试、预发布等环境时必须修改代码、新增条件编译分支，维护成本高
• 发布后的程序无法通过运维侧配置调整运行环境，切换环境必须重新编译对应版本，灵活性极差。

如果你确实有强需求必须把编译模式和环境完全绑定（极不推荐），也可以通过在项目Debug编译配置中定义常量、在Release配置中定义另一个常量的方式简化写法，但本质还是和你原来的实现逻辑一致，不建议使用。

内容的提问来源于stack exchange，提问作者LA.27