使用Roslyn重命名接口失效问题排查

我想要重命名一个类、它的基类以及它实现的接口。例如将代码：

public class CustomerDAL : DALBase, ICustomerDAL

修改为：

public class CustomerRepository : RepositoryBase, ICustomerRepository

为此我编写了如下CSharpSyntaxRewriter：

public class RenameBaseClassAndInterface : CSharpSyntaxRewriter
{
    public override SyntaxNode VisitClassDeclaration(ClassDeclarationSyntax node)
    {
        if (node.Identifier.Text.Contains("DAL"))
        {
            string className = node.Identifier.Text.Replace("DAL", "Repository");

            node = node.ReplaceToken(node.Identifier, SyntaxFactory.Identifier(className));

            if (node.BaseList != null && node.BaseList.Types != null)
            {
                foreach (BaseTypeSyntax baseTypeSyntax in node.BaseList.Types)
                {
                    TypeSyntax typeSyntax = baseTypeSyntax.Type;
                    IdentifierNameSyntax identifierNameSyntax = (IdentifierNameSyntax)typeSyntax;
                    if (identifierNameSyntax.Identifier.ToString() == "DALBase")
                    {
                        node = node.ReplaceToken(identifierNameSyntax.Identifier, SyntaxFactory.Identifier("RepositoryBase"));
                    }
                    else if (identifierNameSyntax.Identifier.ToString().Contains("DAL"))
                    {
                        string repositoryInterfaceName = identifierNameSyntax.Identifier.ToString().Replace("DAL", "Repository");
                        node = node.ReplaceToken(identifierNameSyntax.Identifier, SyntaxFactory.Identifier(repositoryInterfaceName));
                    }
                }
            }
        }

        return base.VisitClassDeclaration(node);
    }
}

但实际得到的结果是：

public class CustomerRepository : RepositoryBase, ICustomerDAL

即ICustomerDAL并未被重命名为ICustomerRepository。我可以单步调试代码，看到执行了重命名接口的代码且无错误，但就是不生效。我怀疑是在旧节点上执行重命名而非新节点，但找不到问题所在。请问有什么解决思路吗？

问题根源在于Roslyn语法节点是不可变对象，你每次调用ReplaceToken后会生成新的节点实例，但循环中使用的baseTypeSyntax始终是来自原始节点的BaseList.Types集合，后续替换操作针对的是旧节点的引用，无法作用到已更新的新节点上，导致只有第一个替换（DALBase→RepositoryBase）生效。

下面提供两种可行的修复方案：

方案1：逐次更新节点引用 #

先收集所有需要替换的类型标识，然后逐个替换并更新节点引用，确保每次修改都作用到最新的节点实例：

public override SyntaxNode VisitClassDeclaration(ClassDeclarationSyntax node)
{
    if (node.Identifier.Text.Contains("DAL"))
    {
        // 重命名类名
        string className = node.Identifier.Text.Replace("DAL", "Repository");
        node = node.ReplaceToken(node.Identifier, SyntaxFactory.Identifier(className));

        if (node.BaseList != null && node.BaseList.Types.Any())
        {
            // 收集所有包含DAL的类型标识
            var targetIdentifiers = node.BaseList.Types
                .Select(t => t.Type as IdentifierNameSyntax)
                .Where(id => id != null && id.Identifier.Text.Contains("DAL"))
                .ToList();

            // 逐个替换，每次替换后更新node引用
            foreach (var idName in targetIdentifiers)
            {
                string newTypeName = idName.Identifier.Text.Replace("DAL", "Repository");
                node = node.ReplaceToken(idName.Identifier, SyntaxFactory.Identifier(newTypeName));
            }
        }
    }

    return base.VisitClassDeclaration(node);
}

方案2：重新构建BaseList #

更可靠的方式是直接生成新的BaseList集合，替换所有需要修改的类型，彻底避免旧节点引用的问题：

public override SyntaxNode VisitClassDeclaration(ClassDeclarationSyntax node)
{
    if (!node.Identifier.Text.Contains("DAL"))
        return base.VisitClassDeclaration(node);

    // 重命名类名
    var newClassName = node.Identifier.Text.Replace("DAL", "Repository");
    var updatedNode = node.ReplaceToken(node.Identifier, SyntaxFactory.Identifier(newClassName));

    if (updatedNode.BaseList == null)
        return base.VisitClassDeclaration(updatedNode);

    // 生成新的基类/接口列表
    var newBaseTypes = updatedNode.BaseList.Types.Select(baseType =>
    {
        if (baseType.Type is IdentifierNameSyntax idName)
        {
            string typeName = idName.Identifier.Text;
            if (typeName.Contains("DAL"))
            {
                string newTypeName = typeName.Replace("DAL", "Repository");
                var newIdName = idName.ReplaceToken(idName.Identifier, SyntaxFactory.Identifier(newTypeName));
                return baseType.WithType(newIdName);
            }
        }
        return baseType;
    }).ToList();

    // 替换原有的BaseList
    var newBaseList = updatedNode.BaseList.WithTypes(SyntaxFactory.SeparatedList(newBaseTypes));
    updatedNode = updatedNode.WithBaseList(newBaseList);

    return base.VisitClassDeclaration(updatedNode);
}

关键说明 #

Roslyn的语法节点设计为不可变，任何修改都会返回新实例。你之前的循环中，第一次替换生成新节点后，后续循环的identifierNameSyntax还是属于原始节点，对它的修改不会同步到新节点上，因此只有第一个替换生效。通过上述两种方式，确保所有修改都作用到最新的节点实例，就能解决接口未被重命名的问题。

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