如何基于已有IMethodSymbol在新SemanticModel中获取其刷新后的正确实例

解决方案 #

核心是使用Roslyn提供的SymbolKey机制跨编译实例定位符号，不需要重复原有符号获取流程：
SymbolKey是Roslyn为每个符号生成的与编译实例无关的唯一标识，可直接在新编译中解析得到对应的新符号实例。

完整实现代码 #

IMethodSymbol methodSymbol = ...;
if (methodSymbol.DeclaringSyntaxReferences.Length == 0)
{
    // 为原方法符号生成跨编译唯一标识
    var methodSymbolKey = methodSymbol.GetSymbolKey();
    
    var syntaxTree = ...;
    var newCompilation = semanticModel.Compilation.AddSyntaxTrees(syntaxTree);
    semanticModel = newCompilation.GetSemanticModel(semanticModel.SyntaxTree);
    
    // 在新编译实例中解析标识，获得刷新后的方法符号
    var resolveResult = methodSymbolKey.Resolve(newCompilation);
    methodSymbol = (IMethodSymbol)resolveResult.Symbol;
}

注意事项 #

• 如果解析结果的Symbol属性为空，可通过resolveResult.CandidateReason和resolveResult.CandidateSymbols排查匹配失败原因，只要新增的语法树是该方法的正确声明，常规场景下都能直接拿到匹配的符号实例。
• 解析得到的新符号实例会自动关联你新增的语法树声明，DeclaringSyntaxReferences属性会返回对应值。

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