c# 如何实现代码生成器

实现 C# 代码生成器的方法有很多，但下面我将介绍一种比较常用的方式，主要依赖Roslyn分析器。下面是完整攻略：

1. 安装 Roslyn 的 NuGet 包

首先需要安装 Roslyn 的 NuGet 包：Microsoft.CodeAnalysis.CSharp。可以在 Visual Studio 的 NuGet 面板中搜索该包进行安装。安装成功后，你将拥有使用Roslyn生成、分析和修改C#代码的能力。

2. 编写代码模板

代码生成器的主要作用是根据特定模板生成代码，因此需要编写代码模板。例如，下面是一个简单的模板，它定义了一个名为 MyClass 的类，其中包含一个 SayHello 方法：

namespace MyNamespace 
{
    public class MyClass 
    {
        public void SayHello() 
        {
            Console.WriteLine("Hello, World!");
        }
    }
}

3. 创建代码生成器

创建一个函数，它接受一个参数为代码模板字符串。首先，需要创建一个 SyntaxTree 对象，来解析代码模板字符串：

string template = "...";   // 编写的代码模板

SyntaxTree templateSyntaxTree = CSharpSyntaxTree.ParseText(template);

4. 遍历模板树并修改节点

接下来，需要遍历 templateSyntaxTree 对象，找到要修改的节点，例如上面模板中的类名 MyClass，方法名 SayHello 和方法体中的 Console.WriteLine 语句。一旦找到了这些节点，就可以使用 Roslyn 的 API 进行修改，从而生成新的代码：

var root = templateSyntaxTree.GetRoot();

// 遍历语法树并修改节点
var classNode = root.DescendantNodes().OfType<ClassDeclarationSyntax>().FirstOrDefault();
classNode = classNode.WithIdentifier(SyntaxFactory.Identifier("MyNewClass"));

var methodNode = root.DescendantNodes().OfType<MethodDeclarationSyntax>().FirstOrDefault();
methodNode = methodNode.WithIdentifier(SyntaxFactory.Identifier("MyNewMethod"));
methodNode = methodNode.WithBody(
    SyntaxFactory.Block(
        SyntaxFactory.ParseStatement("Console.WriteLine(\"Hello, Roslyn!\");")
    )
);

// 生成新的语法树
var newRoot = root.ReplaceNode(classNode, methodNode);

上述代码中，使用了 DescendantNodes 方法来遍历整个语法树，并使用 OfType 进行类型过滤，以获取要修改的节点。然后，使用 WithIdentifier 和 WithBody 方法来修改名称和方法体。

最后，使用 ReplaceNode 方法来生成一个新的语法树，其中包含修改过的节点。

5. 用生成的代码替换代码模板

最后，将上述代码生成新的代码，即可实现代码自动生成：

// 生成新的代码
string newCode = newRoot.ToFullString();

Console.WriteLine(newCode);

这里将新的语法树转换为字符串，从而得到最终生成的代码。

示例

下面是一个简单示例，它使用上述方法自动生成一个新的 C# 文件，其中定义了一个名为 GeneratedClass 的类，该类包含一个名为 SayHello 的方法：

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using System.IO;
using System.Linq;

namespace CodeGeneratorDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            string template = @"
                namespace GeneratedNamespace 
                {
                    public class GeneratedClass 
                    {
                        public void SayHello() 
                        {
                            Console.WriteLine(""Hello, World!""); 
                        }
                    }
                }";

            SyntaxTree templateSyntaxTree = CSharpSyntaxTree.ParseText(template);
            var root = templateSyntaxTree.GetRoot();

            // 遍历语法树并修改节点
            var classNode = root.DescendantNodes().OfType<ClassDeclarationSyntax>().FirstOrDefault();
            classNode = classNode.WithIdentifier(SyntaxFactory.Identifier("MyNewClass"));

            var methodNode = root.DescendantNodes().OfType<MethodDeclarationSyntax>().FirstOrDefault();
            methodNode = methodNode.WithIdentifier(SyntaxFactory.Identifier("MyNewMethod"));
            methodNode = methodNode.WithBody(
                SyntaxFactory.Block(
                    SyntaxFactory.ParseStatement("Console.WriteLine(\"Hello, Roslyn!\");")
                )
            );

            // 生成新的语法树
            var newRoot = root.ReplaceNode(classNode, methodNode);

            // 生成新的代码
            string newCode = newRoot.ToFullString();

            // 写入新的文件
            File.WriteAllText("GeneratedCode.cs", newCode);
        }
    }
}

运行这段代码后，你将在项目的根目录下找到一个新的 GeneratedCode.cs 文件，其中包含生成的代码。