.NET桌面应用如何实现Debug保留可编辑配置、Release嵌入配置？

一、项目构建流程配置（修改.csproj文件） #

直接编辑项目的.csproj文件，添加条件编译逻辑，区分Debug/Release模式处理配置文件：

1. Debug模式配置 #

保持App.Debug.config可编辑，编译时自动替换app.config并输出到输出目录：

<PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
  <TransformOnBuild>true</TransformOnBuild>
  <TransformFile>App.Debug.config</TransformFile>
  <OutputPath>bin\Debug\</OutputPath>
</PropertyGroup>

<Target Name="TransformConfig" Condition=" '$(Configuration)' == 'Debug' " BeforeTargets="Build">
  <TransformXml Source="app.config" Transform="$(TransformFile)" Destination="$(OutputPath)$(AssemblyName).exe.config" />
</Target>

Debug编译后，输出目录会生成可编辑的[程序名].exe.config，QA可直接修改后重启应用生效。

2. Release模式配置 #

将App.Release.config合并到app.config后，作为嵌入式资源嵌入程序集，不输出外部配置文件：

<PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
  <TransformOnBuild>true</TransformOnBuild>
  <TransformFile>App.Release.config</TransformFile>
  <EmbedConfig>true</EmbedConfig>
</PropertyGroup>

<Target Name="TransformAndEmbedConfig" Condition=" '$(Configuration)' == 'Release' " BeforeTargets="Build">
  <!-- 先合并配置 -->
  <TransformXml Source="app.config" Transform="$(TransformFile)" Destination="obj\Release\EmbeddedApp.config" />
  <!-- 将合并后的配置设为嵌入式资源 -->
  <ItemGroup>
    <EmbeddedResource Include="obj\Release\EmbeddedApp.config">
      <LogicalName>EmbeddedApp.config</LogicalName>
    </EmbeddedResource>
  </ItemGroup>
  <!-- 禁止输出外部配置文件 -->
  <PropertyGroup>
    <GenerateResourceNeverLockTypeAssemblies>true</GenerateResourceNeverLockTypeAssemblies>
    <AutoGenerateBindingRedirects>false</AutoGenerateBindingRedirects>
  </PropertyGroup>
</Target>

Release编译时，合并后的配置文件会嵌入到程序集里，输出目录不会生成外部的.exe.config文件。

二、配置读取逻辑实现（编写辅助类） #

创建ConfigHelper类，根据当前编译模式选择读取外部配置或嵌入式资源：

using System;
using System.Configuration;
using System.IO;
using System.Reflection;
using System.Xml;

public static class ConfigHelper
{
    private static Configuration _configuration;

    static ConfigHelper()
    {
#if DEBUG
        // Debug模式直接读取外部配置文件
        _configuration = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
#else
        // Release模式读取嵌入式资源中的配置
        var assembly = Assembly.GetExecutingAssembly();
        using (var stream = assembly.GetManifestResourceStream("你的程序集名称.EmbeddedApp.config"))
        {
            if (stream == null)
                throw new InvalidOperationException("嵌入式配置资源未找到");

            var xmlDoc = new XmlDocument();
            xmlDoc.Load(stream);

            var tempConfigPath = Path.Combine(Path.GetTempPath(), "TempApp.config");
            xmlDoc.Save(tempConfigPath);

            _configuration = ConfigurationManager.OpenMappedExeConfiguration(
                new ExeConfigurationFileMap { ExeConfigFilename = tempConfigPath },
                ConfigurationUserLevel.None);
        }
#endif
    }

    // 获取配置项的通用方法
    public static string GetAppSetting(string key)
    {
        return _configuration.AppSettings.Settings[key]?.Value;
    }

    // 获取连接字符串的方法
    public static string GetConnectionString(string name)
    {
        return _configuration.ConnectionStrings.ConnectionStrings[name]?.ConnectionString;
    }
}

注意替换代码中的你的程序集名称为实际项目的程序集名称（可在项目属性的应用程序选项卡中查看）。

三、验证步骤 #

1. Debug模式测试：
   • 编译Debug版本，检查输出目录是否生成.exe.config文件
   • 修改该文件的配置项，重启应用，验证配置是否生效
2. Release模式测试：
   • 编译Release版本，检查输出目录是否无.exe.config文件
   • 手动添加或修改配置文件后重启应用，验证应用仍使用嵌入式配置，不受外部文件影响

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