UnityCodeGen 使用教程

UnityCodeGen 使用教程

项目介绍

UnityCodeGen 是一个用于 Unity 编辑器的代码生成库。通过定义继承自 ICodeGenerator 的生成器，可以在 Unity 编辑器上自动生成代码。该库的主要特点包括：

• 在编辑器上平滑地实现代码生成。
• 编译时自动生成代码。

项目快速启动

安装

1. 打开 Unity 编辑器，进入 Window > Package Manager。
2. 点击 + 按钮，选择 Add package from git URL。
3. 输入以下 URL：

   https://github.com/AnnulusGames/UnityCodeGen.git?path=/Assets/UnityCodeGen
   

或者，打开 Packages/manifest.json 文件，在 dependencies 块中添加以下内容：

{
  "dependencies": {
    "com.annulusgames.unity-codegen": "https://github.com/AnnulusGames/UnityCodeGen.git?path=/Assets/UnityCodeGen"
  }
}

使用

1. 在任意 Editor 文件夹下创建一个 C# 文件，并实现一个继承自 ICodeGenerator 的类。
2. 以下是一个生成空 Sample 类的示例：

using UnityCodeGen;

[Generator] // 添加 Generator 属性
public class SampleGenerator : ICodeGenerator // 继承 ICodeGenerator
{
    public void Execute(GeneratorContext context) // 实现 Execute 方法
    {
        context.AddCode("Sample");
    }
}

应用案例和最佳实践

案例一：自动生成数据类

假设我们有一个数据类 PlayerData，我们希望在编译时自动生成该类的代码：

[Generator]
public class PlayerDataGenerator : ICodeGenerator
{
    public void Execute(GeneratorContext context)
    {
        context.AddCode("public class PlayerData { public string Name; public int Level; }");
    }
}

最佳实践

• 确保生成的代码符合项目规范。
• 使用 Generator 属性标记所有自定义生成器类。
• 在 Execute 方法中，使用 context.AddCode 方法添加生成的代码。

典型生态项目

UnityCodeGen 生态

UnityCodeGen 可以与其他 Unity 插件和工具结合使用，例如：

• Unity Addressable Assets System：自动生成地址able资源的代码。
• Unity DOTS (Data-Oriented Technology Stack)：自动生成 ECS 组件代码。

通过这些结合使用，可以进一步提高开发效率和代码质量。

---

以上是 UnityCodeGen 的基本使用教程，希望对你有所帮助。