msbuild

定义

msbuild 是微软提供的应用程序构建平台,其正式名称为 Microsoft Build Engine^[1]。它为项目文件规定了一套 XML 架构,由该架构决定构建平台如何处理源代码并生成软件^[2]。

从功能定位看,它是一组面向公共语言基础结构(CLI)托管代码以及原生 C、C++ 代码的构建工具集,属于 .NET Framework 体系的组成部分^[3]。开发者既可以借助 Visual Studio 调用它,也可以在只安装生成工具或 .NET SDK 的机器上通过命令行入口 msbuild.exe 及 dotnet build 命令驱动构建^[6][4]。

原理

MSBuild 的项目文件描述两件事:要构建哪些对象,以及在不同操作系统与配置下如何构建它们;同时允许把可复用的构建规则拆分到独立文件中引用,使同一产品内多个项目的构建过程保持一致^[2]。项目文件中,属性(键值对,写作 $(名称))用于保存配置,项(通常代表文件,写作 @(类型))是构建的输入,任务是可以执行的代码单元,目标则按特定次序把任务组合成构建入口,四者构成其基本模型^[2][7]。

任务的执行逻辑以托管代码书写,通过 UsingTask 元素与引擎绑定;开发者可实现 ITask 接口编写自定义任务,引擎也自带 Copy、MakeDir、Csc 等常用任务^[2]。Visual Studio 把项目特有的逻辑留在项目文件里,而把标准构建逻辑放入扩展名为 .props 与 .targets 的被导入文件;在 .NET Core 及其后版本的 SDK 风格项目中,这些导入由 SDK 隐式指定,项目文件里只写一条 SDK 引用^[2][6]。

在执行层面,MSBuild 先评估项目文件中的构建结构并排定顺序,再按依赖关系逐个执行,使依赖其他项目的代码等待前置项目完成^[8]。由于目录状态在构建期间需要保持一致,项目不在不同线程上并行执行,而是采用进程隔离:引擎按处理器数量最多创建 n 个构建进程,并复用这些进程构建解决方案中的各项目^[9]。增量构建依靠目标元素上的 Inputs 与 Outputs 属性,引擎比较输入与输出的时间戳,输出均为最新时跳过该目标^[10]。

发展历程

MSBuild 的创建始于 2003 年,最初面向用于 Visual Studio 2005(代号 Whidbey)和 Windows Vista(代号 Longhorn)的 .NET Framework 2.0,首个版本于 2003 年发布,版本号 2.0^[3][11]。在 Visual Studio 2005 之前,应用程序由开发环境自身完成构建,此后微软把构建过程从集成开发环境中剥离出来,以便开发者调整^[12]。

其后各版本功能逐步扩展:3.5 版随 .NET Framework 3.5 与 Visual Studio 2008 提供,支持将 .NET 2.0、3.0、3.5 作为项目目标版本,并支持多处理器构建;4.0 版是首个能够构建 Visual C++ 项目的版本^[13][12]。

2015 年 3 月,微软在 GitHub 上公开了 MSBuild 的源代码,并承诺将 MSBuild 迁移到 Linux 和 macOS 平台,使开发者在其他系统上也能构建 .NET 程序^[5]。同年,MSBuild 的开发移交 .NET 基金会,源代码以 MIT 许可证开放^[12]。到 Visual Studio 2019 时期,其开发分支已同时面向 .NET Core 与桌面 .NET Framework 构建。

应用

MSBuild 是 Visual Studio 的构建系统,新建项目时生成的各类项目文件即为它提供输入,其中记录项目包含的文件、生成配置与输出配置等信息^[14][15]。C#、C++ 等语言的项目均通过它完成编译与打包,Windows 应用开发命令行等工具也依赖它^[8]。

在持续集成场景中,Azure Pipelines 与 GitHub Actions 等流水线借助 MSBuild 从代码仓库拉取代码,交付测试构建和发布版本^[8]。命令行开关还可用于生成代码的依赖关系图,为整理软件物料清单提供起点,并能通过进程数量参数适配不同硬件资源^[8]。

此外,MSBuild 可以执行项目文件中指定的测试与其他工作负载;项目若是 Web 应用,还会调用 MSDeploy 或 VSDBCMD 等工具完成部署并与数据库交互^[16]。

局限

MSBuild 的构建参数主要来自项目 XML 与开发环境规范文件,而非像 GCC 一类编译器那样由命令行选项主导,因此单独使用时需要先准备可用的项目文件^[16]。在只安装 .NET SDK、未安装 Visual Studio 或生成工具的机器上,只能通过 dotnet build 间接使用 MSBuild,且该命令只处理自身专有的选项,其余选项才转发给 MSBuild^[6]。

增量构建依赖目标中声明的输入与输出,若项目文件缺少这些声明,构建可能每次都重新执行;早期从旧版升级的 C++ 项目就曾出现此类情况^[17]。并行能力也有限:并行发生在项目之间,单个项目内部的任务仍按顺序执行,项目间依赖较多时并行收益不明显^[18]。并行构建还会改变部分行为,例如错误与异常可能与非并行构建时不同,且某个项目构建失败不会中止其他项目的构建^[9]。

MSBuild 的构建工具受与 Visual Studio 相同的许可协议约束,与开源软件一起使用时需留意协议合规问题^[8]。

参见

• .NET Framework —— MSBuild 最初随该框架发布,是其组成部分。

• Visual Studio —— 集成并调用 MSBuild 的微软集成开发环境。

• GitHub —— MSBuild 源代码公开托管与协作开发的平台。

• .NET 基金会 —— 2015 年接手 MSBuild 开发的开源组织。

• 持续集成 —— MSBuild 常用于自动化构建与交付流水线。