c# - 使用 Roslyn，从字符串文字参数中找到调用方法

Question

我正在尝试使用 Roslyn 替换实用程序中的一些旧的、缓慢的代码，该实用程序在我们的源代码中搜索未包装在 X() 函数调用中的字符串文字(包装在X() 将被翻译)。

我能够使用语法树非常轻松地获取字符串文字，并确定了大部分它们被包裹在 X() 中的地方。我在做什么:给定一个 LiteralExpressionSyntax 对象，我发现这给了我函数调用，我可以用正则表达式匹配它。

s.Parent.Parent.Parent.ToFullString()

当字符串文字被分成两行时，我很快就遇到了问题。那时我意识到我检查它是否在 X() 调用中的方法很差，因为我必须不断将 .Parent 添加到链中。虽然我可以写一些东西来向后爬树，但这似乎不是正确的方法(而且可能不会表现很好)。

我一直在尝试寻找一种方法，给定一个字符串文字语法节点，以确定它是否是方法调用中的参数。我一直无法找到一种从语法树到语义模型的合适方法来找到我正在寻找的东西。我什至不确定这是否是正确的方法，或者我是否遗漏了一些明显的东西。

我能够使用 SymbolFinder.FindSymbolAtPositionAsync 获取该符号，但遇到同样的问题 - 我不能只传递字符串文字参数的位置，我必须传递(正确的)parent 的位置，我回到了开始的地方。

我希望避免多次遍历语法树，因为这会减慢速度。我可以在大约 1 秒内解析 553 个文件，但一旦我尝试循环以解决这些多行情况，我最多需要 12-13 秒。

以防万一我在这篇中篇小说中迷失了你(抱歉)，这是我希望弄清楚的:对于作为参数传递给方法的字符串文字，是否存在确定该方法是什么的简单方法？

这是一些示例代码 - 我已经用 Convert.ToString 替换了对我的 X() 函数的调用，只是为了模拟我正在搜索的代码(我有添加对我们的一个 DLL 的引用，所以我将调用切换到 Convert.ToString()，这样我就可以在这个例子中引用 mscorlib。

static void TestAttempt()
{

  string source = @"
  Imports System
  Namespace Exceptions
    Public NotInheritable Class ExampleException
      Inherits Validation

      Public Sub New()
        Convert.ToString(""Ignore me 1"")
        Console.WriteLine(""Report me"")
        Console.WriteLine(Convert.ToString(""Ignore me 2""))

        MyBase.New(Convert.ToString(""Ignore me 3, "" & _
                                    ""Because I'm already translated.""))
      End Sub
    End Class
  End Namespace";

  var tree = VisualBasicSyntaxTree.ParseText(source);

  var syntaxRoot = tree.GetRoot();
  int i = 0;

  foreach (var s in syntaxRoot.DescendantNodes().OfType<LiteralExpressionSyntax>())
  {
    // things to skip:
    if (s == null) { continue; }
    if (s.Kind() != SyntaxKind.StringLiteralExpression) { continue; }

    var Mscorlib = PortableExecutableReference.CreateFromFile(@"C:\Windows\Microsoft.NET\Framework\v4.0.30319\mscorlib.dll");
    var compilation = VisualBasicCompilation.Create("MyCompilation", syntaxTrees: new[] { tree }, references: new[] { Mscorlib });
    var model = compilation.GetSemanticModel(tree);

    var symbol = SymbolFinder.FindSymbolAtPositionAsync(model, s.Parent.Parent.Parent.Span.Start, new AdhocWorkspace()).Result;

    if (symbol.ToDisplayString().EndsWith("Convert")) { continue; }

    Console.WriteLine(symbol);
    Console.WriteLine($"  Reported: {s.ToString()}");
    i++;
  }

  Console.WriteLine();
  Console.WriteLine($"Total: {i}");
}

Answer 1

警告说我以前从未使用过 Roslyn，而且我通常在 VB.NET 中编写代码，我想我拼凑了一些似乎可以做你想做的事情(使用 LINQPad 和大量的 Dump() 调用有助于找出发生了什么)。

void TestAttempt()
{

    string source = @"
  Imports System
  Namespace Exceptions
    Public NotInheritable Class ExampleException
      Inherits Validation

      Public Sub New()
        X(""Ignore me 1"")
        Console.WriteLine(""Report me"")
        Console.WriteLine(X(""Ignore me 2""))

        MyBase.New(X(""Ignore me 3, "" & _
                   ""Because I'm already translated.""))
      End Sub
    End Class
  End Namespace";

    var tree = VisualBasicSyntaxTree.ParseText(source);

    var syntaxRoot = tree.GetRoot();
    int i = 0, notWrapped = 0;

    foreach (var s in syntaxRoot.DescendantNodes().OfType<LiteralExpressionSyntax>())
    {
        // things to skip:
        if (s == null) { continue; }
        if (s.Kind() != SyntaxKind.StringLiteralExpression) { continue; }

        if (!IsWrappedInCallToX(s))
        {
            Console.WriteLine($"  Reported: {s.ToString()}");
            notWrapped++;
        }
        i++;
    }

    Console.WriteLine();
    Console.WriteLine($"Total: {i}, Not Wrapped In X: {notWrapped}");
}

bool IsWrappedInCallToX(SyntaxNode node)
{
    var invocation = node as InvocationExpressionSyntax;
    if (invocation != null)
    {
        var exp = invocation.Expression as IdentifierNameSyntax;
        if (exp != null && exp.ToString() == "X")
        {
            return true;
        }
    }
    if (node.Parent != null)
    {
        return IsWrappedInCallToX(node.Parent);
    }
    return false;
}

这导致:

  Reported: "Report me"

Total: 5, Not Wrapped In X: 1

IsWrappedInCallToX 函数只是递归向上查找 X 函数的 InvocationExpressionSyntax 树。我知道你说过“虽然我可以写一些东西来向后爬上树，但这似乎不是正确的方法(而且可能不会表现得很好)”，但对我来说这似乎是正确的方式 - 如果您的代码库的性能很糟糕，也许不是!

同样，我对 Roslyn 一无所知(这听起来很有趣)，所以这很可能是一个糟糕的解决方案! :-)