使用MSBuild SDK解析项目时找不到Microsoft.Common.props的问题求助

这个异常的核心原因是未配置ProjectOptions的必要属性，导致MSBuild错误地在项目输出目录（如bin/Debug/net8.0-windows10.0.22621.0/Current）中寻找SDK依赖的Microsoft.Common.props文件，而非从.NET SDK的默认安装路径加载该文件（该文件是.NET SDK内置文件，无需手动创建）。

以下是两种可行的解决方式：

方式一：配置完整的ProjectOptions属性 #

通过设置GlobalProperties指定SDK路径和目标框架，同时初始化正确的ProjectCollection，引导MSBuild到正确路径加载依赖文件：

using System;
using System.Collections.Generic;
using System.IO;
using System.Runtime.InteropServices;
using Microsoft.Build.Definition;
using Microsoft.Build.Evaluation;
using Microsoft.Build.Execution;
using Microsoft.Build.Utilities;

public static void GenerateCodeMsBuild()
{
    var pathProject = @"D:\...\DomainBuilder.ConsoleApp.csproj";
    
    var projectOptions = new ProjectOptions
    {
        // 获取系统中最新的MSBuild工具版本
        ToolsVersion = ToolLocationHelper.GetLatestMSBuildVersion(),
        // 设置全局属性，确保SDK路径和目标框架正确
        GlobalProperties = new Dictionary<string, string>
        {
            ["TargetFramework"] = "net8.0",
            // 自动获取.NET SDK的安装路径，适配不同系统
            ["MSBuildSDKsPath"] = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
                ? Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles), "dotnet", "sdk")
                : "/usr/share/dotnet/sdk"
        },
        // 使用新的ProjectCollection确保上下文独立
        ProjectCollection = new ProjectCollection()
    };

    try
    {
        var project = Project.FromFile(pathProject, projectOptions);
        var projectInstance = ProjectInstance.FromFile(pathProject, projectOptions);
        
        // 示例：输出项目的引用列表
        foreach (var reference in project.Items.Where(i => i.ItemType == "Reference"))
        {
            Console.WriteLine($"项目引用：{reference.EvaluatedInclude}");
        }
    }
    catch (Exception ex)
    {
        Console.WriteLine($"加载项目失败：{ex.Message}");
    }
}

方式二：使用默认ProjectCollection加载项目 #

利用默认ProjectCollection自动读取系统环境中的MSBuild配置，只需补充必要的全局属性即可：

using System;
using System.Collections.Generic;
using Microsoft.Build.Definition;
using Microsoft.Build.Evaluation;
using Microsoft.Build.Execution;

public static void GenerateCodeMsBuild()
{
    var pathProject = @"D:\...\DomainBuilder.ConsoleApp.csproj";
    
    // 使用默认ProjectCollection，自动继承系统MSBuild环境配置
    using var projectCollection = new ProjectCollection();
    
    var globalProperties = new Dictionary<string, string>
    {
        ["TargetFramework"] = "net8.0"
    };

    try
    {
        var project = new Project(pathProject, globalProperties, null, projectCollection);
        var projectInstance = ProjectInstance.FromFile(pathProject, new ProjectOptions
        {
            GlobalProperties = globalProperties,
            ProjectCollection = projectCollection
        });
        
        // 示例：输出项目中的编译文件
        foreach (var file in project.Items.Where(i => i.ItemType == "Compile"))
        {
            Console.WriteLine($"编译文件：{file.EvaluatedInclude}");
        }
    }
    catch (Exception ex)
    {
        Console.WriteLine($"加载项目失败：{ex.Message}");
    }
}

关键注意事项 #

• Microsoft.Common.props是.NET SDK的内部文件，位于SDK安装目录下的Sdks/Microsoft.NET.Sdk/Sdk/路径中，无需手动创建。
• 确保你的控制台应用目标框架为.NET 8，与待解析项目的框架版本一致，避免版本兼容问题。
• 不要硬编码SDK路径，使用ToolLocationHelper或系统环境变量自动获取路径，提升代码的跨平台兼容性。

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