T2FGame.CodeGen 1.0.5

T2FGame.CodeGen

T2FGame 代码生成基础框架，提供 Source Generator 开发所需的通用工具和抽象。

为什么使用 netstandard2.0？

这是 Source Generator 的强制要求，不是可选项。

技术原因

┌─────────────────────────────────────────────────────────────────┐
│                    编译时环境 (Compile Time)                      │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│   Visual Studio / dotnet build / Rider                          │
│         │                                                       │
│         ▼                                                       │
│   ┌─────────────────────────────────────────────────────────┐   │
│   │                    Roslyn Compiler                       │   │
│   │   运行在 .NET Framework 4.7.2 或 netstandard2.0 兼容环境   │   │
│   └─────────────────────────────────────────────────────────┘   │
│         │                                                       │
│         ▼  加载                                                  │
│   ┌─────────────────────────────────────────────────────────┐   │
│   │            Source Generator DLL                          │   │
│   │            必须是 netstandard2.0                          │   │
│   └─────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

如果使用更高版本会怎样？

<TargetFramework>net9.0</TargetFramework>

结果：

• Visual Studio 无法加载生成器 → 编译错误
• dotnet build 在某些环境下失败
• IDE 智能提示失效

但这不意味着功能受限

生成器可以使用 C# 12 语法（通过 LangVersion）和 PolySharp polyfill， 同时生成使用 .NET 9 特性的代码（如 FrozenDictionary）。

项目结构

T2FGame.CodeGen/
├── Abstractions/           # 核心抽象
│   ├── GeneratorContext.cs # 生成上下文
│   ├── GeneratedSource.cs  # 生成的源文件
│   ├── ICodeGenerator.cs   # 生成器接口
│   ├── ICodeEmitter.cs     # 发射器接口
│   └── ISymbolAnalyzer.cs  # 符号分析器接口
│
├── Builders/               # 代码构建器
│   ├── CodeBuilder.cs      # 通用代码构建器
│   ├── ClassBuilder.cs     # 类构建器
│   └── SwitchExpressionBuilder.cs # Switch 表达式构建器
│
├── Templates/              # 模板系统
│   ├── ICodeTemplate.cs    # 模板接口
│   ├── FileHeaderTemplate.cs   # 文件头模板
│   └── NamespaceTemplate.cs    # 命名空间模板
│
├── Analyzers/              # Roslyn 分析工具
│   ├── TypeAnalyzer.cs     # 类型分析
│   ├── AttributeAnalyzer.cs # 特性分析
│   ├── MethodAnalyzer.cs   # 方法分析
│   └── ProtobufAnalyzer.cs # Protobuf 分析
│
├── Models/                 # 共享模型
│   ├── EquatableArray.cs   # 可比较数组（增量生成器缓存）
│   └── TypeModel.cs        # 类型模型
│
└── Extensions/             # 扩展方法
    ├── SymbolExtensions.cs # ISymbol 扩展
    └── StringExtensions.cs # 字符串工具

使用示例

创建代码构建器

var builder = new CodeBuilder();

// 文件头
builder.AppendLines(FileHeaderTemplate.Instance.Render(new FileHeaderModel
{
    GeneratorName = "MyGenerator",
    GeneratorVersion = "1.0.0",
    Usings = new[] { "System", "System.Collections.Generic" }
}));

// 命名空间和类
using (builder.Namespace("MyNamespace"))
{
    builder.Summary("自动生成的类");
    builder.GeneratedCodeAttribute("MyGenerator", "1.0.0");

    using (builder.Class("public sealed", "GeneratedClass"))
    {
        // 字段
        builder.AppendLine("private readonly int _value;");

        // 方法
        using (builder.Method("public int GetValue()"))
        {
            builder.AppendLine("return _value;");
        }
    }
}

string code = builder.ToString();

使用 ClassBuilder 流式 API

var classBuilder = new ClassBuilder("MyClass")
    .Sealed()
    .Implements("IMyInterface")
    .GeneratedCodeAttribute("MyGenerator", "1.0.0")
    .Field("int", "_count", accessibility: "private", isReadonly: true)
    .Property("int", "Count", hasGetter: true, hasSetter: false)
    .Method("public void Increment()", b =>
    {
        b.AppendLine("_count++;");
    });

classBuilder.Build(builder);

分析 Roslyn 符号

// 分析返回类型
var asyncInfo = TypeAnalyzer.AnalyzeAsyncType(methodSymbol.ReturnType);
if (asyncInfo.Kind == AsyncKind.TaskOfT)
{
    var resultType = asyncInfo.ResultType;
    // 处理 Task<T> 返回类型
}

// 获取特性参数
var attr = AttributeAnalyzer.GetAttribute(symbol, "MyAttribute");
var value = AttributeAnalyzer.GetConstructorArgument<int>(attr, 0);

// 检查 Protobuf 消息
if (ProtobufAnalyzer.IsProtobufMessage(type))
{
    var parserExpr = ProtobufAnalyzer.GetParserExpression(type);
}

扩展生成器

创建新的 Source Generator 项目时：

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <LangVersion>12.0</LangVersion>
    <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
    <IsRoslynComponent>true</IsRoslynComponent>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" PrivateAssets="all" />
    <ProjectReference Include="..\T2FGame.CodeGen\T2FGame.CodeGen.csproj" PrivateAssets="all" />
  </ItemGroup>
</Project>

许可证

MIT License