如何将条件编译符号（DefineConstants）传递给 msbuild

Posted 2023-04-12

【中文标题】如何将条件编译符号（DefineConstants）传递给 msbuild

【英文标题】：How do you pass conditional compilation symbols (DefineConstants) to msbuild

【发布时间】：2012-05-29 16:33:35

【问题描述】：

所以，this 和 this 都非常清楚。只需传递/p:DefineConstants="SYMBOL"

它对我来说根本不起作用，即使在测试项目中也是如此。我期望传递 /p:DefineConstants="SYMBOL" 将覆盖 csproj 中定义的任何条件编译常量。然而事实并非如此......

下面的完整代码清单：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace DefineConstants

    class Program
    
        static void Main(string[] args)
        
#if DEV
            Console.WriteLine("DEV");
#elif UAT 
            Console.WriteLine("UAT");
#else
            Console.WriteLine("No environment provided");
#endif
        
    

.csproj 文件是：

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
    <Platform Condition=" '$(Platform)' == '' ">x86</Platform>
    <ProductVersion>8.0.30703</ProductVersion>
    <SchemaVersion>2.0</SchemaVersion>
    <ProjectGuid>57A2E870-0547-475C-B0EB-66CF9A2FE417</ProjectGuid>
    <OutputType>Exe</OutputType>
    <AppDesignerFolder>Properties</AppDesignerFolder>
    <RootNamespace>DefineConstants</RootNamespace>
    <AssemblyName>DefineConstants</AssemblyName>
    <TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
    <FileAlignment>512</FileAlignment>
  </PropertyGroup>
  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
    <PlatformTarget>x86</PlatformTarget>
    <DebugSymbols>true</DebugSymbols>
    <DebugType>full</DebugType>
    <Optimize>false</Optimize>
    <OutputPath>bin\Debug\</OutputPath>
    <DefineConstants>TRACE;DEBUG</DefineConstants>
    <ErrorReport>prompt</ErrorReport>
    <WarningLevel>4</WarningLevel>
  </PropertyGroup>
  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
    <PlatformTarget>x86</PlatformTarget>
    <DebugType>pdbonly</DebugType>
    <Optimize>true</Optimize>
    <OutputPath>bin\Release\</OutputPath>
    <DefineConstants>TRACE</DefineConstants>
    <ErrorReport>prompt</ErrorReport>
    <WarningLevel>4</WarningLevel>
  </PropertyGroup>
  <ItemGroup>
    <Reference Include="System" />
    <Reference Include="System.Core" />
    <Reference Include="System.Xml.Linq" />
    <Reference Include="System.Data.DataSetExtensions" />
    <Reference Include="System.Data" />
    <Reference Include="System.Xml" />
  </ItemGroup>
  <ItemGroup>
    <Compile Include="Program.cs" />
    <Compile Include="Properties\AssemblyInfo.cs" />
  </ItemGroup>
  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
       Other similar extension points exist, see Microsoft.Common.targets.
  <Target Name="BeforeBuild">
  </Target>
  <Target Name="AfterBuild">
  </Target>
  -->
</Project>

使用：

C:\Windows\Microsoft.NET\Framework\v4.0.30319\msbuild DefineConstants.sln /p:DefineConstants="DEV;DEBUG" /p:Configuration="Debug" /p:Platform="x86"

运行程序显示：

No environment provided

帮助！

【问题讨论】：

右键单击解决方案 -> 清洁解决方案 -> 重试您的构建命令。可能会有所帮助。

您是否尝试过在 csproj 文件而不是 sln 上使用 msbuild？

【参考方案1】：

使用DefineConstants 绝对有效。这意味着你做错了什么。我的猜测是您首先构建了项目而没有定义任何内容，然后再次构建它。然后 MSBuild 将看到该项目已经构建并且不会再次构建，而只是复制输出文件。您应该发布 msbuild 的输出，以便我们确定，但作为参考，我仅使用必要的开关编译了您的项目，结果如下（省略了完整的 msbuild 输出）：

> msbuild ConsoleApplication1.sln /p:DefineConstants="DEV" /t:Rebuild
....
Building solution configuration "Debug|x86".
Project ... is building ConsoleApplication1.csproj" (Rebuild target(s)).
...
> ConsoleApplication1\bin\Debug\DefineConstants.exe
DEV
> msbuild ConsoleApplication1.sln /p:DefineConstants="UAT" /t:Rebuild
...
> ConsoleApplication1\bin\Debug\DefineConstants.exe
UAT
> msbuild ConsoleApplication1.sln /t:Rebuild
...
> ConsoleApplication1\bin\Debug\DefineConstants.exe
No environment provided 

【讨论】：

是否在某处记录了需要 Rebuild 才能使 DefineConstants 工作，或者这只是暗示常识？所以没有办法使用 DefineConstants 进行增量构建？

@jJack 取决于您对 incremental 的含义：如果您先编辑 A.cs，然后构建，然后编辑 B.cs 并再次构建，它应该可以工作。虽然我不能 100% 确定在构建 B.cs 之前更改 DefineConstants 仍然会影响 A.cs - 当然你可以尝试一下。

【参考方案2】：

您似乎没有通过条件编译符号。这就是为什么你得到输出：没有提供环境。只需转到项目属性，然后单击构建选项卡（应用程序下方的左侧）。你会发现一个框询问条件编译符号。只需根据您想要的输出编写常量。例如。在您的示例中，要打印“DEV”，请在条件编译框中写入 DEV 并重建您的项目。我相信它会起作用的。

注意：如果你想传递任何符号而不是你的代码，它将打印：未选择环境。

【讨论】：

回答老问题时要小心。这个已经超过 5 岁并且有一个公认的答案。这个目前几乎没有增加额外的东西。 - 来自Review

嗨，这是真的。但是为什么我放这个答案，它可能会帮助其他人寻找同样的问题。