如何强制MSBuild属性必须赋值？解决空属性无报错问题

问题场景 #

在MSBuild中，直接给<ProjectReference>的Include设置空字符串会触发预期的构建错误：

<!-- ERROR -->
<ProjectReference Include="" />

但如果使用未定义的属性作为Include值时，MSBuild不会抛出任何错误或警告：

<!-- No error or warning -->
<ProjectReference Include="$(ThisPropertyDoesNotExist)" />

下面是几种解决这个问题的方案，以及对全局严格检查特性的说明：

1. 自定义函数实现OrThrow()风格的简洁断言 #

如果想实现类似$(Property.OrThrow())的语法，可以通过自定义MSBuild任务封装断言逻辑，避免重复引用属性名：

首先在项目文件中添加自定义任务和封装的属性函数：

<UsingTask TaskName="ThrowIfPropertyUndefined" TaskFactory="CodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.Core.dll">
  <ParameterGroup>
    <PropertyName ParameterType="System.String" Required="true" />
    <PropertyValue ParameterType="System.String" Required="true" />
  </ParameterGroup>
  <Task>
    <Code Type="Fragment" Language="cs">
      if (string.IsNullOrWhiteSpace(PropertyValue))
      {
        throw new System.ArgumentException($"Required property '{PropertyName}' is undefined or empty.");
      }
    </Code>
  </Task>
</UsingTask>

<!-- 封装成可直接调用的宏 -->
<PropertyGroup>
  <Require>$([MSBuild]::CreateEscapedValue(`$(ThrowIfPropertyUndefined PropertyName=`%(PropName)` PropertyValue=`$(`%(PropName)`)))$(`%(PropName)`)))</Require>
</PropertyGroup>

使用时只需传入属性名，就能自动检查并返回属性值，未定义则抛出错误：

<ProjectReference Include="$([MSBuild]::GetPropertyValue('Require', PropName='Property'))" />

2. 集中式属性检查（避免重复引用错误） #

如果不想写自定义任务，可以把所有必填属性的检查集中放在一个Target里，只需要定义一次属性名，降低拼写错误风险：

<!-- 定义所有必填属性的名称列表 -->
<PropertyGroup>
  <RequiredProjectProperties>MyRequiredProp;AnotherRequiredProp</RequiredProjectProperties>
</PropertyGroup>

<!-- 在构建前执行检查 -->
<Target Name="ValidateRequiredProperties" BeforeTargets="BeforeBuild">
  <Error 
    Text="Required property '%(RequiredProjectProperties.Identity)' is missing or empty."
    Condition="$([MSBuild]::IsNullOrWhiteSpace('$(`%(RequiredProjectProperties.Identity)`)))"
  />
</Target>

<!-- 正常使用属性即可 -->
<ProjectReference Include="$(MyRequiredProp)" />

这种方式把检查逻辑统一管理，不用在每个<ProjectReference>处重复写验证代码。

3. 简化版ValueOrDefault用法（快速生效） #

你之前尝试的ValueOrDefault方法可以优化得更语义化，用明确的无效占位符替代...，触发构建错误的同时更易理解：

<!-- 当Property未定义时，占位符会导致路径无效，触发构建错误 -->
<ProjectReference Include="$([MSBuild]::ValueOrDefault('$(Property)', 'REQUIRED_PROPERTY_NOT_SET'))" />

这种方式无需额外配置，直接在引用处使用即可。

关于全局严格检查（类似OptionStrict） #

目前MSBuild没有内置的全局开关，无法实现“所有未定义属性使用触发错误”的效果。如果需要全局级别的检查，可以借助第三方工具（比如MSBuild Analyzers）或者自定义日志记录器来扫描未定义属性的使用，但这需要额外的配置步骤。

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