.NET Core发布时重命名appSettings配置文件的方法

核心思路 #

借助MSBuild的发布目标（Publish），结合条件判断与文件复制/重命名任务，仅保留目标环境的配置文件并替换为通用名称appSettings.config。

具体csproj配置 #

在你的项目文件（.csproj）中添加以下配置：

<!-- 禁止默认appSettings.config被发布 -->
<ItemGroup>
  <Content Remove="appSettings.config" />
  <None Include="appSettings.config">
    <CopyToPublishDirectory>Never</CopyToPublishDirectory>
  </None>
</ItemGroup>

<!-- 定义目标环境变量，默认设为Development，发布时可覆盖 -->
<PropertyGroup>
  <TargetEnvironment>Development</TargetEnvironment>
</PropertyGroup>

<!-- 发布阶段执行的重命名任务 -->
<Target Name="PublishEnvironmentConfig" AfterTargets="Publish">
  <!-- 将目标环境配置文件复制到发布目录并重命名 -->
  <Copy
    SourceFiles="appSettings.$(TargetEnvironment).config"
    DestinationFiles="$(PublishDir)appSettings.config"
    OverwriteReadOnlyFiles="true"
  />

  <!-- 排除其他环境的配置文件，避免混入发布目录 -->
  <ItemGroup>
    <ExcludeFromPublish Include="appSettings.*.config" Condition="!('%(Filename)' == 'appSettings.$(TargetEnvironment)')" />
  </ItemGroup>
</Target>

使用方式 #

命令行发布 #

执行发布命令时指定目标环境：

dotnet publish -c Release /p:TargetEnvironment=Production

Visual Studio发布配置 #

1. 打开发布配置文件（.pubxml）
2. 在<PropertyGroup>节点内添加：<TargetEnvironment>Production</TargetEnvironment>

关键说明 #

• AfterTargets="Publish"：确保任务在发布流程完成后执行，覆盖默认的文件复制逻辑
• $(PublishDir)：MSBuild内置变量，指向最终的发布目录路径
• OverwriteReadOnlyFiles="true"：避免因文件只读属性导致复制失败
• 排除其他环境配置：保证发布目录中仅存在目标环境的配置文件，且名称统一为appSettings.config

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