Mediator项目中的Roslyn分析器诊断位置验证问题解析

在Mediator项目的3.0.0-preview.62版本中，开发者遇到了一个与Roslyn分析器相关的技术问题。这个问题表现为在使用Rider 2025.1 IDE时，虽然dotnet build命令能够成功执行，但IDE中却显示Roslyn分析器错误，导致代码高亮显示异常。

问题现象

开发者在使用Mediator.SourceGenerator时，多个项目引用了该生成器，而一个名为"Common"的项目引用了Mediator.Abstractions（用于共享消息和管道）。在这种情况下，IDE会报告"IncrementalMediatorGenerator"生成器未能成功生成源代码的错误。

错误信息明确指出："Reported diagnostic 'MSG0005' has a source location in file '.../EstimateMessage.cs', which is not part of the compilation being analyzed"。这表明分析器试图报告一个诊断信息，但该诊断指向的文件并不在当前分析的编译单元中。

技术背景

这个问题涉及到Roslyn编译器的几个关键技术点：

1. 增量生成器(Incremental Generator)：Mediator使用了Roslyn的增量源代码生成技术，这种技术可以高效地处理源代码变更。

2. 诊断位置验证：Roslyn编译器对诊断信息的位置有严格验证，确保报告的问题确实属于当前编译上下文。

3. 多项目引用场景：当解决方案包含多个相互引用的项目时，生成器需要正确处理跨项目的类型引用和诊断报告。

问题根源

问题的根本原因在于生成器试图在一个项目的编译上下文中报告另一个项目中文件的诊断信息。具体来说：

1. 生成器检测到Common项目中的EstimateMessage.cs文件存在问题（MSG0005错误）

2. 但生成器是在引用Common项目的其他项目中运行的

3. 当生成器尝试报告这个跨文件的诊断时，Roslyn的验证机制阻止了这一操作

解决方案

项目维护者在3.0.0-preview.64版本中修复了这个问题。修复的核心思路可能是：

1. 限制诊断报告的范围，确保只报告当前编译单元内的文件问题

2. 或者对于跨项目引用的情况，采用不同的错误报告机制

3. 也可能是改进了生成器对多项目解决方案的处理逻辑

开发者启示

这个问题给开发者带来几点重要启示：

1. 源代码生成器的边界：生成器需要明确其工作边界，特别是在多项目解决方案中

2. IDE与CLI的差异：有时命令行构建成功但IDE显示错误，这可能与IDE的实时分析特性有关

3. 版本更新重要性：及时更新依赖版本可以避免已知问题的困扰

对于使用Mediator或其他源代码生成技术的开发者来说，理解生成器的工作范围和限制条件非常重要，特别是在复杂的多项目解决方案中。当遇到类似问题时，检查生成器版本并考虑更新到最新版本通常是有效的解决策略。