MSBuild 任务

  • 项目

生成平台需要能够在生成过程中执行任意数量的操作。 MSBuild 使用任务执行这些操作。 任务是由 MSBuild 用于执行原子生成操作的可执行代码单元。

任务逻辑

MSBuild XML 项目文件格式本身无法完全执行生成操作，因此必须在项目文件之外实现任务逻辑。

任务的执行逻辑作为 .NET 类实现，此类实现 Microsoft.Build.Framework 命名空间中定义的 ITask 接口。

任务类还定义项目文件中的任务可用的输入和输出参数。 通过在 Task 元素上放置具有相同名称的对应属性，并将其值设置为本文后面的示例中所示的值，可在项目文件中为由任务类公开的所有公共可设置的非静态非抽象属性提供值。

可以通过创作一个实现 ITask 接口的托管类来编写自己的任务。 有关详细信息，请参阅任务写入。

从项目文件执行任务

在项目文件中执行任务前，必须先通过 UsingTask 元素将执行任务的程序集中的类型映射到任务名称。 这样，当 MSBuild 在项目文件中找到任务时，能知道查找任务的执行逻辑的位置。

若要在 MSBuild 项目文件中执行任务，请创建一个与任务同名的元素，并将其指定为 Target 元素的子元素。 如果任务接受了参数，这些参数将作为元素的属性进行传递。

MSBuild 项列表和属性都可用作参数。 例如，以下代码调用 MakeDir 任务，并将 MakeDir 对象的 Directories 属性的值设置为 BuildDir 属性的值：

<Target Name="MakeBuildDirectory">
    <MakeDir
        Directories="$(BuildDir)" />
</Target>

任务还可将信息返回到项目文件，该信息可存储在项或属性中以供稍后使用。 例如，以下代码调用 Copy 任务，并将来自 CopiedFiles 输出属性的信息存储在 SuccessfullyCopiedFiles 项列表中。

<Target Name="CopyFiles">
    <Copy
        SourceFiles="@(MySourceFiles)"
        DestinationFolder="@(MyDestFolder)">
        <Output
            TaskParameter="CopiedFiles"
            ItemName="SuccessfullyCopiedFiles"/>
     </Copy>
</Target>

包括的任务

MSBuild 附带了许多任务，例如用于复制文件的 Copy、用于创建目录的 MakeDir 以及用于编译 C# 源代码文件的 Csc。 有关可用任务的完整列表以及用法信息，请参阅任务参考。

覆盖的任务

MSBuild 在多个位置查找任务。 第一个位置位于存储在 MSBuild 目录中扩展名为 .OverrideTasks 的文件中。 这些文件中的任务会覆盖具有相同名称的其他任何任务，包括项目文件中的任务。 第二个位置位于项目文件及其导入中。 如果未在项目中定义该任务，将在 MSBuild 的默认任务中搜索该任务，默认任务是在 MSBuild 目录的 .tasks 文件中定义的。

相关内容