理解/获取符号类型?

时间:2016-06-13 02:44:22

标签: c# roslyn roslyn-code-analysis

public void SomeMethod(string sampleString) 
{   var helloworld = sampleString; }

是否可以确定特定符号是局部变量,类字段还是方法的参数?例如如果我在sampleString上调用FindSymbolAtPosition,我能告诉sampleString符号是方法的参数还是变量?

编辑:要求是必须使用编码时间,因为我使用roslyn构建的静态代码分析工具

4 个答案:

答案 0 :(得分:3)

您无法通过属性直接获取它,因为在var helloworld = sampleString;中,如果sampleString是参数,则该语句没有上下文。但你可以从方法的上下文中得到它:

static bool IsParameter(IdentifierNameSyntax name)
{
    SyntaxNode node = name;
    while (node != null && !(node is MethodDeclarationSyntax))
    {
        node = node.Parent;
    }

    var method = node as MethodDeclarationSyntax;
    if (method != null)
    {
        return method
            .ParameterList
            .Parameters
            .Any(p => p.Identifier.Text.Equals(name.Identifier.Text));
    }

    return false;            
}

使用.Parent获取变量的方法上下文,并检查.ParameterList中的任何参数是否与标识符匹配。

更新代码以证明其有效:

SyntaxTree tree = CSharpSyntaxTree.ParseText(
    @"using System;
    using System.Collections;
    using System.Linq;
    using System.Text;

    namespace HelloWorld
    {
        class Program
        {
            static void Main(string i)
            {
                var j = ""1"";
                var k = i + j;
            }
        }
    }");

var root = (CompilationUnitSyntax)tree.GetRoot();
var ns = root.Members[0] as NamespaceDeclarationSyntax;
var cls = ns.Members[0] as ClassDeclarationSyntax;
var method = cls.Members[0] as MethodDeclarationSyntax;
var statement = method.Body.Statements[1] as LocalDeclarationStatementSyntax;
var variable = statement.Declaration.Variables[0];
var binary = variable.Initializer.Value as BinaryExpressionSyntax;
var vari = binary.Left as IdentifierNameSyntax;
var varj = binary.Right as IdentifierNameSyntax;
Console.WriteLine(IsParameter(vari));   //True
Console.WriteLine(IsParameter(varj));  //False

编辑根据@JeroenVannevel的评论,我们可以使用SemanticModel.GetSymbolInfo

var compilation = CSharpCompilation.Create("test", new[] { tree });                
var semanticModel = compilation.GetSemanticModel(tree, true);
var symboli = semanticModel.GetSymbolInfo(vari);
var symbolj = semanticModel.GetSymbolInfo(varj);
//check symboli.Symbol.OriginalDefinition.Kind == SymbolKind.Parameter

答案 1 :(得分:0)

通过语法或文本比较标识符是错误的,想象一下IdentifierNameSyntaxMemberAccessExpressionSyntax的名称并且与identifier具有相同的parameter,那么你会错误地认为它是parameter,即使它是member。您应该使用SemanticModel来确定SymbolKind是什么。您可以在声明上使用SemanticModel.GetDeclaredSymbol,在符号使用上使用SemanticModel.GetSymbolInfo().Symbol。获得ISymbol之后,很容易确定其类型。请记住,不同的符号有自己的“子类型”,例如ITypeSymbol具有TypeKind属性,用于确定类型是ClassStruct,{{1 }},Interface等,所以你应该检查一下。

答案 2 :(得分:-2)

您可以使用以下代码获取类和参数的字段信息。但请注意,方法字段的检测不可用。此代码使用反射来查询程序集信息并枚举和比较结果。

static class Program
{
    static void Main(string[] args)
    {

        SomeMethod("Hello, World!!!");

        Type testType = typeof(Program);
        FieldInfo[] fieldInfo = testType.GetFields();
        MethodInfo methodInfo = testType.GetMethod("SomeMethod");

        Console.WriteLine("Parameter type:{0}", TypeOfField(fieldInfo, methodInfo, "sampleString"));
        Console.WriteLine("Parameter type:{0}", TypeOfField(fieldInfo, methodInfo, "classField"));
        Console.WriteLine("Parameter type:{0}", TypeOfField(fieldInfo, methodInfo, "helloWorld"));
        Console.WriteLine("Parameter type:{0}", TypeOfField(fieldInfo, methodInfo, "nonexistentVariable"));

    }

    public static string classField = "Hello, World!!!";

    public static void SomeMethod(string sampleString)
    {
        string helloWorld = sampleString;
    }

    public static string TypeOfField(FieldInfo[] fieldInfo, MethodInfo methodInfo, string fieldName)
    {
        if (IsClassField(fieldInfo, fieldName))
        {
            return "Class Field";
        }
        else if (IsParameter(methodInfo, fieldName))
        {
            return "Parameter";
        }
        else
        {
            return "Cannot determine";
        }
    }

    private static bool IsClassField(FieldInfo[] fieldInfo, string classFieldName)
    {
        bool isClassField = false;

        foreach (var item in fieldInfo)
        {
            if (item.Name == classFieldName)
            {
                isClassField = true;
                break;
            }
        }
        return isClassField;
    }

    private static bool IsParameter(MethodInfo methodInfo, string parameterName)
    {
        bool isParameter = false;
        ParameterInfo[] paramInfo = methodInfo.GetParameters();
        foreach (var item in paramInfo)
        {
            if (item.Name == parameterName)
            {
                isParameter = true;
                break;
            }
        }
        return isParameter;
    }
}

答案 3 :(得分:-3)

您可以区分是处理类字段还是方法参数,或者使用关键字this来处理局部变量。如果你有一个名为sampleString的类字段字符串,并且你想引用类字段而不是局部变量/方法参数,那么你将使用this.sampleString引用它。您可以将局部变量/方法参数称为sampleString而不使用关键字(this)。就局部变量和方法参数而言,您无法在同一方法中使用具有相同名称的局部变量和方法参数。使用上面的代码,您将引用sampleString参数。