如何通过编程方式使用MSBuild构建VS解决方案？

以下是补全后的完整代码，解决BuildRequestData参数准备的问题，同时包含构建结果的判断逻辑：

using Microsoft.Build.Framework;
using Microsoft.Build.Locator;
using Microsoft.Build.Evaluation;
using Microsoft.Build.Execution;
using System.Collections.Generic;
using System.Linq;

void MethodThatDoesNotDirectlyCallMSBuild()
{
    // 获取最新版本的Visual Studio/MSBuild实例
    var instance = MSBuildLocator.QueryVisualStudioInstances()
        .OrderByDescending(instance => instance.Version)
        .First();

    MSBuildLocator.RegisterInstance(instance);
    MethodThatCallsMSBuild(instance);
}

void MethodThatCallsMSBuild(VisualStudioInstance instance)
{
    // 初始化构建参数，配置控制台日志器
    var buildParameters = new BuildParameters(new ProjectCollection())
    {
        Loggers = new ILogger[] { new ConsoleLogger(LoggerVerbosity.Normal) }
    };

    // 定义解决方案路径
    var solutionPath = @"X:\Drivers\Dsp\Dsp.sln";
    
    // 设置构建属性：对应VS中的配置、平台选项
    var globalProperties = new Dictionary<string, string>
    {
        { "Configuration", "Release" },
        { "Platform", "x64" }
    };

    // 完整初始化BuildRequestData
    var buildRequest = new BuildRequestData(
        solutionPath,
        globalProperties,
        null, // 使用注册的MSBuild工具版本
        new[] { "Build" }, // 指定要执行的构建目标，可选Clean、Rebuild等
        null,
        BuildRequestDataOptions.None);

    // 执行构建并获取结果
    var buildResult = BuildManager.DefaultBuildManager.Build(buildParameters, buildRequest);

    // 判断构建状态
    if (buildResult.OverallResult == BuildResultCode.Success)
    {
        Console.WriteLine("解决方案构建成功！");
    }
    else
    {
        Console.WriteLine("解决方案构建失败！");
        // 可通过buildResult.ResultsByTarget查看具体目标的失败详情
    }
}

关键说明 #

1. NuGet依赖：确保项目已安装以下包：

   • Microsoft.Build
   • Microsoft.Build.Locator
   • Microsoft.Build.Framework
   • Microsoft.Build.Execution

2. BuildRequestData参数解析：

   • 路径参数：传入解决方案或单个项目的绝对路径
   • 全局属性：配置构建的核心参数，比如编译配置、目标平台
   • 构建目标：指定要执行的操作，Build为常规编译，Rebuild为清理后重新编译
   • 选项参数：按需设置，比如SkipNonexistentTargets可跳过不存在的目标

3. 注意事项：

   • 避免硬编码路径，建议通过配置文件或命令行参数传入
   • MSBuild 16.0+（对应VS2019及以上）才支持直接加载.sln文件，旧版本需解析解决方案为项目列表后逐个构建
   • 可自定义日志器，将构建日志输出到文件，方便排查构建失败问题

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