如何从非内联MSBuild Task中访问属性且不设为用户可修改参数

我有如下外联MSBuild任务：

<UsingTask TaskName="MyTask" TaskFactory="CodeTaskFactory">
  <ParameterGroup>
    ...
  </ParameterGroup>
  <Task>
    <Code Language="cs" Source="MyTask.cs" />
  </Task>
</UsingTask>

在MyTask.cs中，代码如下：

public class MyTask : Task
{
  public override bool Execute()
  {
    ...
  }
}

我希望在Execute()方法内部访问MSBuild变量X。如果是内联任务，可以直接使用$(X)，但该任务位于单独文件中。我知道可以通过将X作为参数传递来实现，但这需要在所有Task实例中重复其值，还允许用户自定义它，而我不希望出现这些情况。请问如何直接从Task内部访问X？

你可以借助Task基类的BuildEngine属性直接获取MSBuild的全局或项目属性，无需通过参数传递。

方法1：获取全局属性 #

如果X是全局属性（比如通过命令行/p:X=xxx设置，或在Directory.Build.props等全局配置中定义），可以使用BuildEngine.TryGetGlobalProperty方法：

public class MyTask : Task
{
  public override bool Execute()
  {
      if (BuildEngine.TryGetGlobalProperty("X", out string xValue))
      {
          // 使用获取到的X值进行操作
          Log.LogMessage(MessageImportance.Normal, $"全局属性X的值：{xValue}");
      }
      else
      {
          Log.LogWarning("未找到全局属性X");
      }
      return true;
  }
}

注：TryGetGlobalProperty是MSBuild 16.0及以上版本提供的方法；若使用旧版本，可改用BuildEngine.GetGlobalProperty("X")，该方法在属性不存在时返回null。

方法2：获取项目级属性 #

如果X是当前项目的属性（在.csproj或项目文件中通过PropertyGroup定义），可以通过BuildEngine获取当前项目实例后读取属性：

using Microsoft.Build.Execution;

public class MyTask : Task
{
  public override bool Execute()
  {
      if (BuildEngine is IBuildEngine4 buildEngine4)
      {
          ProjectInstance projectInstance = buildEngine4.ProjectInstance;
          string xValue = projectInstance.GetPropertyValue("X");
          if (!string.IsNullOrEmpty(xValue))
          {
              Log.LogMessage(MessageImportance.Normal, $"项目属性X的值：{xValue}");
          }
          else
          {
              Log.LogWarning("未找到项目属性X");
          }
      }
      return true;
  }
}

核心优势 #

• 无需在ParameterGroup中重复定义参数，简化配置
• 用户无法通过任务参数直接修改X的值（仅能通过MSBuild全局/项目配置修改，实现你需要的权限控制）
• 直接从MSBuild引擎获取最新属性值，保证数据一致性

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