使用MSBuild编程构建C#解决方案失败问题求助

问题概述 #

需要通过C#程序调用MSBuild构建.NET解决方案，但使用Microsoft.Build API时遇到两个错误：

1. 使用BuildManager构建时出现MSB4036: 找不到“Message”任务
2. 直接用Project类加载解决方案时出现MSB4236: 找不到SDK 'Microsoft.NET.Sdk'

命令行执行dotnet build或MSBuild.exe可正常构建。

现有代码与错误日志 #

代码1（BuildManager方式） #

private void BuildSolution(string solutionPath)
{
    BuildResult result = null;

    using (var pc = new ProjectCollection())
        result = BuildManager.DefaultBuildManager.Build(
            new BuildParameters(pc) { Loggers = new[] { new FileLogger() {
                Parameters = SolverConfig.Path + "build.log",
                Verbosity = LoggerVerbosity.Diagnostic,
                SkipProjectStartedText = true,
            } } },
            new BuildRequestData(SolverConfig.Path + solutionPath,
                new Dictionary<string, string>
                {
                    { "Configuration", "Release" },
                    { "Platform", "Any CPU" }
                }, "6.0", new[] { "Rebuild" }, null));

    if (result.OverallResult == BuildResultCode.Failure)
        throw new Exception("Solver build failed");
}

代码1对应的错误日志 #

Target "ValidateSolutionConfiguration" in file "\ProjetosSolver\BILS_Solver\BILS_Solver.sln.metaproj":
  Task "Error" skipped, due to false condition; (('$(CurrentSolutionConfigurationContents)' == '') and ('$(SkipInvalidConfigurations)' != 'true')) was evaluated as (('<SolutionConfiguration>
    <ProjectConfiguration Project="{73067654-AEC8-4FA1-98E7-E5C5C93DC264}" AbsolutePath="\ProjetosSolver\BILS_Solver\BILS_Solver.csproj" BuildProjectInSolution="True">Debug|AnyCPU</ProjectConfiguration>
    <ProjectConfiguration Project="{D535A4DF-2FF6-4A10-8CC0-EE3EBB8EE520}" AbsolutePath="\ProjetosSolver\BILS_Commons\BILS_Commons.csproj" BuildProjectInSolution="True">Debug|AnyCPU</ProjectConfiguration>
    <ProjectConfiguration Project="{FC94B850-3E0D-455D-97D4-A84BDC43712B}" AbsolutePath="\ProjetosSolver\BILS_Evaluator\BILS_Evaluator.csproj" BuildProjectInSolution="True">Debug|AnyCPU</ProjectConfiguration>
    <ProjectConfiguration Project="{A6D612E3-DB96-4CA8-A69F-BD77E7001A25}" AbsolutePath="\ProjetosSolver\bmhf\BMHF\BMHF.csproj" BuildProjectInSolution="True">Debug|AnyCPU</ProjectC...' == '') and ('' != 'true')).
  Task "Warning" skipped, due to false condition; (('$(CurrentSolutionConfigurationContents)' == '') and ('$(SkipInvalidConfigurations)' == 'true')) was evaluated as (('<SolutionConfiguration>
    <ProjectConfiguration Project="{73067654-AEC8-4FA1-98E7-E5C5C93DC264}" AbsolutePath="\ProjetosSolver\BILS_Solver\BILS_Solver.csproj" BuildProjectInSolution="True">Debug|AnyCPU</ProjectConfiguration>
    <ProjectConfiguration Project="{D535A4DF-2FF6-4A10-8CC0-EE3EBB8EE520}" AbsolutePath="\ProjetosSolver\BILS_Commons\BILS_Commons.csproj" BuildProjectInSolution="True">Debug|AnyCPU</ProjectConfiguration>
    <ProjectConfiguration Project="{FC94B850-3E0D-455D-97D4-A84BDC43712B}" AbsolutePath="\ProjetosSolver\BILS_Evaluator\BILS_Evaluator.csproj" BuildProjectInSolution="True">Debug|AnyCPU</ProjectConfiguration>
    <ProjectConfiguration Project="{A6D612E3-DB96-4CA8-A69F-BD77E7001A25}" AbsolutePath="\ProjetosSolver\bmhf\BMHF\BMHF.csproj" BuildProjectInSolution="True">Debug|AnyCPU</ProjectC...' == '') and ('' == 'true')).
  MSBUILD : warning MSB4196: The "*.overridetasks" files could not be successfully loaded from their expected location "\src\WebUI\bin\Debug\net6.0". Default tasks will not be overridden. 
  MSBUILD : warning MSB4010: The "*.tasks" files could not be successfully loaded from their expected location "\src\WebUI\bin\Debug\net6.0". Default tasks will not be available. 
  \ProjetosSolver\BILS_Solver\BILS_Solver.sln.metaproj : error MSB4036: The "Message" task was not found. Check the following: 1.) The name of the task in the project file is the same as the name of the task class. 2.) The task class is "public" and implements the Microsoft.Build.Framework.ITask interface. 3.) The task is correctly declared with <UsingTask> in the project file, or in the *.tasks files located in the "\src\WebUI\bin\Debug\net6.0" directory.
Done building target "ValidateSolutionConfiguration" in project "BILS_Solver.sln" -- FAILED.

Done building project "BILS_Solver.sln" -- FAILED.

代码2（直接加载Project） #

private void BuildSolution(string solutionPath)
{
    Project project = new Project(SolverConfig.Path + solutionPath);
    project.Build();
}

代码2对应的错误 #

error MSB4236: The SDK 'Microsoft.NET.Sdk' specified could not be found.

问题根源分析 #

1. MSB4036错误：MSBuild核心任务（如Message）未被正确加载。原因是ProjectCollection未初始化到正确的MSBuild环境，无法找到SDK和任务文件；同时FileLogger的Parameters格式错误（缺少logfile=前缀），指定的ToolsVersion="6.0"未关联到实际的.NET 6 MSBuild SDK。
2. MSB4236错误：Project类主要用于加载单个.csproj文件，不支持直接加载.sln解决方案，且未配置SDK路径导致无法识别Microsoft.NET.Sdk。

解决方案 #

方案1：修复MSBuild API调用（使用MSBuildLocator） #

1. 安装NuGet包：Microsoft.Build.Locator，用于自动定位系统中安装的MSBuild实例。
2. 在应用启动时注册MSBuild定位器，确保加载正确的环境。
3. 修改构建代码，修正参数错误并配置SDK路径。

修改后的代码：

using Microsoft.Build.Locator;
using System.IO;

// 应用启动时执行一次，初始化MSBuild环境
static YourClassName()
{
    MSBuildLocator.RegisterDefaults();
}

private void BuildSolution(string solutionPath)
{
    BuildResult result = null;
    var fullSolutionPath = Path.Combine(SolverConfig.Path, solutionPath);
    var logPath = Path.Combine(SolverConfig.Path, "build.log");

    using (var pc = new ProjectCollection())
    {
        // 获取MSBuild路径，设置SDK路径全局属性
        var vsInstance = MSBuildLocator.QueryVisualStudioInstances().First();
        pc.GlobalProperties["MSBuildSDKsPath"] = Path.Combine(vsInstance.MSBuildPath, "Sdks");

        result = BuildManager.DefaultBuildManager.Build(
            new BuildParameters(pc)
            {
                Loggers = new[]
                {
                    new FileLogger()
                    {
                        Parameters = $"logfile={logPath}", // 修正日志参数格式
                        Verbosity = LoggerVerbosity.Diagnostic,
                        SkipProjectStartedText = true
                    }
                }
            },
            new BuildRequestData(
                fullSolutionPath,
                new Dictionary<string, string>
                {
                    { "Configuration", "Release" },
                    { "Platform", "AnyCPU" } // 解决方案平台为AnyCPU，无空格
                },
                null, // 由MSBuildLocator自动处理ToolsVersion，无需手动指定
                new[] { "Rebuild" },
                null));
    }

    if (result.OverallResult == BuildResultCode.Failure)
        throw new Exception("Solver build failed");
}

方案2：直接调用dotnet build命令行（推荐） #

命令行方式无需配置复杂的MSBuild API环境，行为与手动执行dotnet build完全一致，兼容性和稳定性更好。

代码示例：

using System.Diagnostics;
using System.IO;

private void BuildSolution(string solutionPath)
{
    var fullSolutionPath = Path.Combine(SolverConfig.Path, solutionPath);
    var processStartInfo = new ProcessStartInfo
    {
        FileName = "dotnet",
        Arguments = $"build \"{fullSolutionPath}\" -c Release -p:Platform=AnyCPU --no-incremental",
        RedirectStandardOutput = true,
        RedirectStandardError = true,
        UseShellExecute = false,
        CreateNoWindow = true,
        WorkingDirectory = SolverConfig.Path // 设置工作目录为解决方案所在路径
    };

    using (var process = Process.Start(processStartInfo))
    {
        process.WaitForExit();
        var output = process.StandardOutput.ReadToEnd();
        var error = process.StandardError.ReadToEnd();

        if (process.ExitCode != 0)
        {
            throw new Exception($"构建失败，输出信息：\n{output}\n错误信息：\n{error}");
        }
    }
}

关键修改点说明 #

• Platform参数：解决方案中的平台是AnyCPU（无空格），原代码中的"Any CPU"会导致配置不匹配。
• MSBuildLocator：自动定位系统中安装的Visual Studio/MSBuild环境，避免手动配置路径的错误。
• 命令行方式：依赖系统已安装的.NET SDK，无需额外引用MSBuild相关包，减少版本兼容性问题。

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