使用Roslyn读取解决方案引用项目时缺失本地不可用项目的问题

我明白你遇到的困扰了——用Roslyn的MSBuildWorkspace加载解决方案时，那些本地文件缺失的项目不会出现在solution.Projects集合里，因为Roslyn默认只保留成功加载的项目实例。不过我们可以通过监听工作区的加载失败事件，轻松捕获这些“丢失”的项目信息。

解决方案：监听WorkspaceFailed事件获取失败项目 #

MSBuildWorkspace提供了WorkspaceFailed事件，会在项目加载失败时触发。我们可以订阅这个事件，筛选出项目加载失败的诊断信息，从而记录下那些无法加载的项目路径和具体原因。

修改后的代码示例：

MSBuildWorkspace workspace = MSBuildWorkspace.Create();
workspace.LoadMetadataForReferencedProjects = true;

// 用来存储加载失败的项目信息（路径+错误消息）
var failedProjects = new List<(string ProjectPath, string ErrorMessage)>();

// 订阅工作区失败事件，捕获项目加载失败的情况
workspace.WorkspaceFailed += (sender, args) =>
{
    // 只筛选项目加载失败类型的诊断信息
    if (args.Diagnostic.Kind == WorkspaceDiagnosticKind.FailedProjectLoad)
    {
        string projectPath = args.Diagnostic.ProjectId?.FilePath ?? "未知路径";
        failedProjects.Add((projectPath, args.Diagnostic.Message));
    }
};

// 加载解决方案（这里用Result做同步处理，实际项目建议用await异步调用）
Solution solution = workspace.OpenSolutionAsync("你的解决方案路径.sln").Result;

// 处理成功加载的项目
foreach (var p in solution.Projects)
{
    // 这里编写你的项目处理逻辑
    Console.WriteLine($"已加载项目：{p.FilePath}");
}

// 处理加载失败的项目
foreach (var failed in failedProjects)
{
    Console.WriteLine($"加载失败项目：{failed.ProjectPath}，错误原因：{failed.ErrorMessage}");
}

关键细节说明： #

• WorkspaceDiagnosticKind.FailedProjectLoad是专门标记项目加载失败的诊断类型，通过这个筛选可以精准锁定我们需要的信息。
• 即使项目加载失败，args.Diagnostic.ProjectId?.FilePath通常也能拿到该项目的原始路径，方便你定位缺失的文件。
• 如果需要更详细的错误细节，args.Diagnostic还包含错误级别、位置等属性，可以按需扩展使用。

这样一来，你既能处理成功加载的项目，也能追踪到那些因为文件缺失等原因无法加载的项目了。

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