如何在Azure Pipeline中注入Conditional compilation symbols实现C#条件编译

实现逻辑 #

C# 条件编译符号通过 MSBuild 构建参数传递即可生效，不需要修改项目文件硬编码，直接和不同流水线的客户、环境变量绑定即可实现差异化构建。

操作步骤 #

• 定义流水线变量
  每个面向不同客户、不同环境的流水线，单独定义名为BuildSymbols的变量，多个符号用英文分号分隔，示例：
  • 客户A生产环境：BuildSymbols: CUSTOMER_A;PROD
  • 客户B测试环境：BuildSymbols: CUSTOMER_B;TEST
    变量可以直接写在YAML中，也可以用Azure Pipeline的可视化变量面板配置，或者用变量组统一管理。
• 构建任务传入参数

dotnet 项目（.NET Core/.NET 5+） #

使用DotNetCoreCLI构建任务时，在arguments参数中传入DefineConstants属性：

- task: DotNetCoreCLI@2
  displayName: '项目构建'
  inputs:
    command: 'build'
    projects: '**/*.csproj'
    arguments: '-p:DefineConstants=$(BuildSymbols)'

.NET Framework 项目 #

使用VSBuild构建任务时，在msbuildArgs参数中传入属性：

- task: VSBuild@1
  displayName: '项目构建'
  inputs:
    solution: '**/*.sln'
    msbuildArgs: '/p:DefineConstants=$(BuildSymbols)'
    platform: '$(BuildPlatform)'
    configuration: '$(BuildConfiguration)'

• 代码中使用条件编译
  直接在C#代码中用对应符号做逻辑区分即可：

#if CUSTOMER_A
    // 客户A专属业务逻辑
#elif CUSTOMER_B
    // 客户B专属业务逻辑
#endif

#if PROD
    // 生产环境专属逻辑
#elif TEST
    // 测试环境专属逻辑
#endif

优化配置 #

• 本地构建兜底
  为了避免本地构建时未传入参数导致默认逻辑丢失，可以在csproj项目文件中添加默认值兜底：

<PropertyGroup>
  <!-- 本地构建未传入参数时的默认编译符号 -->
  <DefineConstants Condition="'$(DefineConstants)' == ''">DEBUG;TRACE</DefineConstants>
</PropertyGroup>

• 保留原有默认符号
  如果需要同时保留项目原有默认的DEBUG、TRACE等符号，可以直接在构建参数中拼接：
  arguments: '-p:DefineConstants=$(BuildSymbols);DEBUG;TRACE'

注意事项 #

• 条件编译符号大小写敏感，流水线中定义的符号需要和代码中的完全一致
• 多个符号之间只用英文分号分隔，不要加多余空格
• 条件编译的逻辑会在构建期决定是否编译进最终程序集，运行期无法修改

内容的提问来源于stack exchange，提问作者Thomas KiTe Trentin