如何通过CodeDeploy实现.NET Web API的AppSettings环境变量替换

下面是几种实用的实现方式，可根据你的场景选择：

方案1：利用.NET环境特定配置文件 + CodeBuild阶段切换 #

.NET原生支持按环境区分配置文件，结合CodeBuild的环境变量就能快速实现配置替换：

• 第一步：在项目根目录创建对应环境的配置文件，比如appsettings.Staging.json、appsettings.Production.json，每个文件写入对应环境的数据库连接字符串等配置项。
• 第二步：修改CodeBuild的buildspec.yml，根据CodePipeline传递的环境变量，在构建发布阶段复制对应环境的配置文件覆盖主appsettings.json：

  phases:
    build:
      commands:
        - dotnet restore
        - dotnet publish -c Release -o ./publish
        # 根据环境变量ENV_NAME切换配置文件
        - case "$ENV_NAME" in
            Production) cp appsettings.Production.json ./publish/appsettings.json ;;
            Staging) cp appsettings.Staging.json ./publish/appsettings.json ;;
            *) cp appsettings.Development.json ./publish/appsettings.json ;;
          esac
  

• 第三步：在CodePipeline的不同部署阶段（比如预发布、生产）设置ENV_NAME环境变量，CodeBuild会自动加载对应环境的配置。

方案2：用AWS SSM参数存储托管配置 + .NET运行时动态加载 #

如果希望配置集中管理、无需修改代码包，可以把配置存在SSM参数存储，让应用启动时根据环境拉取：

• 第一步：在AWS Systems Manager参数存储中创建分层参数，比如/MyWebApi/Production/ConnectionStrings/Default、/MyWebApi/Staging/ConnectionStrings/Default，分别填入对应环境的连接字符串。
• 第二步：给项目安装AWSSDK.Extensions.NETCore.Setup和AWSSDK.SimpleSystemsManagement两个NuGet包。
• 第三步：修改Program.cs，添加从SSM加载配置的逻辑：

  var builder = WebApplication.CreateBuilder(args);
  var envName = builder.Environment.EnvironmentName;
  
  // 从SSM加载对应环境的配置参数
  builder.Configuration.AddSystemsManager($"/MyWebApi/{envName}/");
  
  // 后续正常注册服务、构建应用
  var app = builder.Build();
  

• 第四步：在CodePipeline部署时，给目标运行环境（ECS任务定义、EC2实例、Beanstalk环境）设置ASPNETCORE_ENVIRONMENT环境变量，应用启动时会自动拉取对应环境的配置。

方案3：部署阶段直接修改配置文件（适合简单场景） #

如果不想维护多份配置文件，可以在部署阶段用脚本直接替换appsettings.json里的内容：

• 第一步：在CodeDeploy的部署包中添加替换配置的脚本replace_config.sh：

  #!/bin/bash
  CONFIG_PATH="/var/www/myapi/publish/appsettings.json"
  
  if [ "$ENV_NAME" = "Production" ]; then
    sed -i 's/"DefaultConnection": "Dev_DB_String"/"DefaultConnection": "Prod_DB_String"/g' $CONFIG_PATH
  elif [ "$ENV_NAME" = "Staging" ]; then
    sed -i 's/"DefaultConnection": "Dev_DB_String"/"DefaultConnection": "Staging_DB_String"/g' $CONFIG_PATH
  fi
  

• 第二步：修改CodeDeploy的appspec.yml，在部署前执行这个脚本：

  version: 0.0
  os: linux
  files:
    - source: /publish
      destination: /var/www/myapi/publish
  hooks:
    BeforeInstall:
      - location: replace_config.sh
        timeout: 300
        runas: root
  

• 第三步：在CodePipeline的对应部署阶段设置ENV_NAME环境变量，确保脚本能读取到并完成替换。

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