如何使用Roslyn APIs读取ASP.NET Core项目的SpaRoot属性值？

好问题！Roslyn的MSBuildWorkspace确实支持读取项目文件中的MSBuild属性，包括你需要的SpaRoot。不过默认情况下Roslyn不会自动加载所有MSBuild项目细节，所以需要用特定方法获取底层的MSBuild项目对象。

前置准备 #

首先确保你的项目引用了必要的NuGet包：

• Microsoft.CodeAnalysis.Workspaces.MSBuild：提供Roslyn与MSBuild的集成能力
• Microsoft.Build.Locator：帮助定位系统中的MSBuild版本，避免版本冲突

完整实现代码 #

修改你的现有代码，通过GetMSBuildProjectAsync()方法获取项目的MSBuild实例，然后读取SpaRoot属性：

static async Task Main(string[] args)
{
    string solutionFile = @"C:\Test\my-solution.sln";
    
    // 初始化MSBuild定位器，避免版本兼容问题
    MSBuildLocator.RegisterDefaults();
    
    using (var workspace = MSBuildWorkspace.Create())
    {
        // 可选：订阅事件排查加载错误
        workspace.WorkspaceFailed += (sender, e) => 
            Console.WriteLine($"Workspace加载错误: {e.Diagnostic.Message}");
        
        var solution = await workspace.OpenSolutionAsync(solutionFile);
        string projectName = "some-project";
        var project = solution.Projects.Single(p => p.Name == projectName);
        
        // 获取底层的MSBuild Project对象
        var msbuildProject = await project.GetMSBuildProjectAsync();
        if (msbuildProject != null)
        {
            // 读取SpaRoot属性的计算后的值
            string spaRoot = msbuildProject.GetPropertyValue("SpaRoot");
            
            if (!string.IsNullOrEmpty(spaRoot))
            {
                Console.WriteLine($"获取到SpaRoot路径: {spaRoot}");
                // 在这里使用该路径生成SPA代码即可
            }
            else
            {
                Console.WriteLine("项目中未定义SpaRoot属性");
            }
        }
        else
        {
            Console.WriteLine("无法加载MSBuild项目详情");
        }
    }
}

关键细节说明 #

1. MSBuildLocator.RegisterDefaults()：这一步很关键，它会自动定位系统中安装的MSBuild版本，避免因版本不匹配导致的项目加载失败。
2. GetMSBuildProjectAsync()：这个方法异步获取项目的MSBuild原生对象，包含了csproj中定义的所有属性（包括通过条件、导入文件定义的属性）。
3. 属性读取备选方案：如果GetPropertyValue()返回空值，你可以直接遍历EvaluatedProperties集合查找目标属性，确保拿到计算后的最终值：

   var spaRootProperty = msbuildProject.EvaluatedProperties
       .FirstOrDefault(p => p.Name.Equals("SpaRoot", StringComparison.OrdinalIgnoreCase));
   if (spaRootProperty != null)
   {
       string spaRoot = spaRootProperty.EvaluatedValue;
       // 使用该值
   }
   

这种方法不仅适用于SpaRoot，还可以读取任何csproj中定义的MSBuild属性，比如TargetFramework、TypeScriptCompileBlocked等，完全可以替代你当前的硬编码路径方案。

内容的提问来源于stack exchange，提问作者vinicius.ras