使用C# Roslyn删除SyntaxNode遇空引用异常，求解决方案

异常原因 #

你遇到的System.ArgumentNullException（参数名Name），主要源于两种情况：

• 筛选出的待删除节点集合为空，或包含了无法直接删除的节点（如根节点、存在父子层级依赖的节点）
• 盲目遍历所有DescendantNodes()，导致包含了语法上不允许单独移除的节点类型

正确删除节点的步骤 #

1. 精准筛选目标节点 #

避免遍历所有节点，先指定要删除的节点类型（比如IdentifierNameSyntax、MethodDeclarationSyntax），确保筛选逻辑不会返回无效节点：

var syntaxTree = CSharpSyntaxTree.ParseText(textFile);
var root = syntaxTree.GetRoot();

// 示例：筛选所有值为"Test"的标识符节点
var nodesToRemove = root.DescendantNodes()
    .OfType<IdentifierNameSyntax>()
    .Where(node => node.Identifier.ValueText == "Test")
    .ToList(); // 转为List避免延迟执行导致的遍历问题

// 非空再执行删除
if (nodesToRemove.Any())
{
    root = root.RemoveNodes(nodesToRemove, SyntaxRemoveOptions.KeepNoTrivia);
}

2. 处理语法树不可变特性 #

Roslyn语法节点是不可变的，每次修改都会生成新节点，必须重新赋值root。如果删除节点后会导致父节点语法无效（比如空方法体），需要同时修改父节点：

// 示例：删除方法体内的"Test"节点后，清理空方法体
var methodsWithTest = root.DescendantNodes()
    .OfType<MethodDeclarationSyntax>()
    .Where(m => m.Body?.DescendantNodes().OfType<IdentifierNameSyntax>().Any(n => n.Identifier.ValueText == "Test") == true);

foreach (var method in methodsWithTest)
{
    var cleanedBody = method.Body.RemoveNodes(
        method.Body.DescendantNodes().OfType<IdentifierNameSyntax>().Where(n => n.Identifier.ValueText == "Test"),
        SyntaxRemoveOptions.KeepNoTrivia);
    
    // 如果方法体为空，替换为带分号的形式或移除方法体
    var updatedMethod = cleanedBody.Statements.Any() 
        ? method.WithBody(cleanedBody) 
        : method.WithBody(null).WithSemicolonToken(SyntaxFactory.Token(SyntaxKind.SemicolonToken));
    
    root = root.ReplaceNode(method, updatedMethod);
}

3. 替代过时的TrackedNodes #

现在Roslyn推荐用SyntaxAnnotation跟踪节点，替代旧的TrackedNodes：

// 给目标节点添加标记
var annotatedRoot = root.ReplaceNodes(
    root.DescendantNodes().OfType<IdentifierNameSyntax>().Where(n => n.Identifier.ValueText == "Test"),
    (original, _) => original.WithAdditionalAnnotations(new SyntaxAnnotation("RemoveTarget")));

// 获取标记节点并删除
var nodesToRemove = annotatedRoot.GetAnnotatedNodes("RemoveTarget").ToList();
root = annotatedRoot.RemoveNodes(nodesToRemove, SyntaxRemoveOptions.KeepNoTrivia);

常见注意事项 #

• 不要尝试删除根节点，DescendantNodes()默认不包含根节点，但需确保筛选逻辑不会误包含
• 避免延迟执行：LINQ的Where是延迟执行的，需转为List确保在删除前获取完整节点集合
• 检查语法有效性：删除节点后要确保剩余语法树符合C#语法规范，避免出现空块、缺失必填元素等问题

内容的提问来源于stack exchange，提问作者Recep Şen