使用Roslyn开发分析器时如何判断私有字段是否被读取

核心问题原因 #

你当前的实现有两个核心错误：

1. AnalyzeDataFlow 方法要求入参必须是 StatementSyntax 或 ExpressionSyntax 类型，你直接传入 MethodDeclarationSyntax 自然会报错，改为传入方法的 Body 属性（即方法的代码块 BlockSyntax）即可解决。
2. 只遍历类内的方法会漏掉大量字段读取场景：包括其他字段的初始化表达式、构造函数逻辑、属性的get/set访问器、类内lambda/委托、嵌套类型中的引用等。

可行实现方案 #

这里推荐两种实现思路，你可以根据需求选择：

方案1：基于符号引用遍历（性能更好，覆盖场景更全）

不需要做数据流分析，直接遍历所属类的所有语法节点，匹配目标字段的引用，同时判断引用是否为读取操作：

private bool IsFieldRead(SyntaxNodeAnalysisContext context, IFieldSymbol fieldSymbol)
{
    // 先找到字段所属的类型声明
    var classDeclarationSyntax = context.Node.Ancestors().OfType<TypeDeclarationSyntax>().FirstOrDefault();
    if (classDeclarationSyntax == null) return false;

    // 遍历类型内所有标识符节点
    foreach (var identifierNode in classDeclarationSyntax.DescendantNodes().OfType<IdentifierNameSyntax>())
    {
        // 排除字段自己的声明节点
        if (identifierNode.Ancestors().OfType<VariableDeclaratorSyntax>().Any(v => 
            context.SemanticModel.GetDeclaredSymbol(v)?.Equals(fieldSymbol, SymbolEqualityComparer.Default) == true))
        {
            continue;
        }

        // 判断当前标识符是不是指向目标字段
        var symbolInfo = context.SemanticModel.GetSymbolInfo(identifierNode);
        if (!fieldSymbol.Equals(symbolInfo.Symbol, SymbolEqualityComparer.Default))
        {
            continue;
        }

        // 判断是不是读取操作：排除赋值左边的场景
        if (identifierNode.Parent is AssignmentExpressionSyntax assignment 
            && assignment.Left == identifierNode)
        {
            // 只有赋值右边才算读取
            continue;
        }

        // 排除自增自减的单独操作（如果你认为i++也算读取可以删掉这段）
        if (identifierNode.Parent is PostfixUnaryExpressionSyntax or PrefixUnaryExpressionSyntax)
        {
            continue;
        }

        // 命中读取操作
        return true;
    }

    return false;
}

方案2：基于数据流分析（适合需要更精确数据流判断的场景）

如果确实需要用到数据流分析的能力，修改你的原有逻辑，覆盖所有代码块即可：

private bool IsFieldRead(SyntaxNodeAnalysisContext context, IFieldSymbol fieldSymbol)
{
    var classDeclarationSyntax = context.Node.Ancestors().OfType<TypeDeclarationSyntax>().FirstOrDefault();
    if (classDeclarationSyntax == null) return false;

    // 收集类内所有可执行代码块：方法体、构造函数、访问器、表达式体成员等
    var codeBlocks = classDeclarationSyntax.DescendantNodes()
        .Where(n => n is BlockSyntax or ArrowExpressionClauseSyntax)
        .ToImmutableArray();

    foreach (var block in codeBlocks)
    {
        DataFlowAnalysis dataFlowAnalysis;
        try
        {
            dataFlowAnalysis = block is BlockSyntax blockSyntax 
                ? context.SemanticModel.AnalyzeDataFlow(blockSyntax)
                : context.SemanticModel.AnalyzeDataFlow((ArrowExpressionClauseSyntax)block);
        }
        catch (ArgumentException)
        {
            // 部分无法做数据流分析的块直接跳过
            continue;
        }

        if (dataFlowAnalysis.Succeeded && 
            (dataFlowAnalysis.ReadInside.Contains(fieldSymbol) || dataFlowAnalysis.ReadOutside.Contains(fieldSymbol)))
        {
            return true;
        }
    }

    return false;
}

补充注意事项 #

• 用 SymbolEqualityComparer.Default 做符号比对，避免不同编译上下文下符号比对错误。
• 如果需要支持record、struct等类型的字段检测，把匹配类型从 ClassDeclarationSyntax 改为 TypeDeclarationSyntax 即可，上面的代码已经兼容。
• 如果字段被特性、反射调用，这种静态分析无法覆盖的场景属于正常漏报，不属于逻辑错误。

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