Question

我正在使用Roslyn，我有以下课程：

var source = @"
    using System;
    class MyClass : MyBaseClass {
      static void Main(string[] args) {
        Console.WriteLine(""Hello, World!"");
      }
    }";

// Parsing
SyntaxTree tree = CSharpSyntaxTree.ParseText(source);

// This uses an internal function (working)
// That gets the first node of type `SimpleBaseTypeSyntax`
SimpleBaseTypeSyntax simpleBaseType = GetNBaseClassNode(tree);

获取基类名称

我成功访问了包含我需要的节点SimpleBaseTypeSyntax。事实上，如果我使用语法资源管理器，我得到：

节点IdentifierToken包含我需要的所有内容Text，Value和ValueText属性为"MyBaseClass"！

但是，在语法资源管理器中，我可以看到所有这些值，但我无法以编程方式访问它们。

所以我尝试以编程方式检索节点：

IdentifierNameSyntax identifierNode =
  simpleBaseType.ChildNodes().OfType<IdentifierNameSyntax>().First();
SyntaxToken identifier = simpleBaseType.Identifier;
string name = identifier.Text;

但是name是空字符串。与identifier.Value和identifier.ValueText相同。

我做错了什么？也许我做错了，所以你将如何检索基类名称？

另一种尝试：使用语义模型

我开始认为我需要这类信息的语义模型：

IdentifierNameSyntax identifierNode =
  simpleBaseType .ChildNodes().OfType<IdentifierNameSyntax>().First();

SemanticModel semanticModel =
  CSharpCompilation.Create("Class")
   .AddReferences(MetadataReference.CreateFromFile(
     typeof(object).Assembly.Location))
       .AddSyntaxTrees(tree).GetSemanticModel(tree);

SymbolInfo symbolInfo = this.semanticModel.GetSymbolInfo(identifierNode);
string name = symbolInfo.Symbol.Name;

由于symbolInfo.Symbol为null，因此会引发异常。

Answer 1

我实际上不知道为什么你不能通过BaseTypeSyntax将GetSymbolInfo()传递给语义模型，但它也为我返回null而没有错误。

无论如何，这是一种有效的方法：

var tree = CSharpSyntaxTree.ParseText(@"
using System;
class MyBaseClass
{
}
class MyClass : MyBaseClass {
  static void Main(string[] args) {
    Console.WriteLine(""Hello, World!"");
  }
}");

var Mscorlib = PortableExecutableReference.CreateFromAssembly(typeof(object).Assembly);
var compilation = CSharpCompilation.Create("MyCompilation",
    syntaxTrees: new[] { tree }, references: new[] { Mscorlib });
var model = compilation.GetSemanticModel(tree);

var myClass = tree.GetRoot().DescendantNodes().OfType<ClassDeclarationSyntax>().Last();
var myClassSymbol = model.GetDeclaredSymbol(myClass);
var baseTypeName = myClassSymbol.BaseType.Name;

你会想在这里使用语义模型，因为你无法可靠地判断你是在语法级别处理接口还是基类型。

Answer 2

我可以看到您正在尝试使用Roslyn API构建分析器。您知道还有其他方法可以测试您的分析仪逻辑吗？使用单元测试文件而不是直接在分析仪内部使用源。

使用这个想法，您可以使用Visual Studio提供的模板完全构建分析器，您必须从DiagnosticAnalyzer继承并创建分析代码逻辑。

根据您的情况，您应该查看ClassDeclaration并轻松访问Node内的BaseTypes属性。

        public bool SomeTriedDiagnosticMethod(SyntaxNodeAnalysisContext nodeContext)
    {
        var classDeclarationNode = nodeContext.Node as ClassDeclarationSyntax;
        if (classDeclarationNode == null) return false;
        var baseType = classDeclarationNode.BaseList.Types.FirstOrDefault(); //  Better use this in all situations to be sure code won't break
        var nameOfFirstBaseType = baseType.Type.ToString();  
        return nameOfFirstBaseType == "BaseType";

    }

Answer 3

    protected static bool IsWebPage(SyntaxNodeAnalysisContext context, ClassDeclarationSyntax classDeclaration)
    {
        INamedTypeSymbol iSymbol = context.SemanticModel.GetDeclaredSymbol(classDeclaration) as INamedTypeSymbol;
        INamedTypeSymbol symbolBaseType = iSymbol?.BaseType;

        while (symbolBaseType != null)
        {
            if (symbolBaseType.ToString() == "System.Web.UI.Page")
                return true;
            symbolBaseType = symbolBaseType.BaseType;
        }

        return false;
    }

Answer 4

这是我的助手类，可查找所有属性，类名称，类名称空间和基类。

public class CsharpClass
{
    public string Name { get; set; }
    public string Namespace { get; set; }
    public List<CsharpProperty> Properties { get; set; }
    public List<string> BaseClasses { get; set; }

    public class CsharpProperty
    {
        public string Name { get; set; }
        public string Type { get; set; }

        public CsharpProperty(string name, string type)
        {
            Name = name;
            Type = type;
        }
    }

    public CsharpClass()
    {
        Properties = new List<CsharpProperty>();
        BaseClasses = new List<string>();
    }
}

public static class CsharpClassParser
{
    public static CsharpClass Parse(string content)
    {
        var csharpClass = new CsharpClass();
        var tree = CSharpSyntaxTree.ParseText(content);
        var members = tree.GetRoot().DescendantNodes().OfType<MemberDeclarationSyntax>();

        foreach (var member in members)
        {
            if (member is PropertyDeclarationSyntax property)
            {
                csharpClass.Properties.Add(new CsharpClass.CsharpProperty(
                    property.Identifier.ValueText, property.Type.ToString()));
            }

            if (member is NamespaceDeclarationSyntax namespaceDeclaration)
            {
                csharpClass.Namespace = namespaceDeclaration.Name.ToString();
            }

            if (member is ClassDeclarationSyntax classDeclaration)
            {
                csharpClass.Name = classDeclaration.Identifier.ValueText;

                csharpClass.BaseClasses = GetBaseClasses(classDeclaration).ToList();
            }

            //if (member is MethodDeclarationSyntax method)
            //{
            //    Console.WriteLine("Method: " + method.Identifier.ValueText);
            //}
        }

        return csharpClass;
    }

    private static IEnumerable<string> GetBaseClasses(ClassDeclarationSyntax classDeclaration)
    {
        if (classDeclaration == null)
        {
            return null;
        }

        if (classDeclaration.BaseList == null)
        {
            return null;
        }

        return classDeclaration.BaseList.Types.Select(x = > x.Type.ToString());
    }
}

用法：

const string content = @"
namespace Acme.Airlines.AirCraft
{
    public class AirCraft
    {
        public virtual string Name { get; set; }

        public virtual int Code { get; set; }

        public AirCraft()
        {

        }
    }
}";

var csharpClass = CsharpClassParser.Parse(content);

Console.WriteLine(csharpClass.Name);
Console.WriteLine(csharpClass.Namespace);
Console.WriteLine(csharpClass.Properties.Count);
Console.WriteLine(csharpClass.BaseClasses.Count);

如何通过Roslyn获取类的基类名称？

获取基类名称

另一种尝试：使用语义模型

4 个答案: