Protobuf-Unity 项目教程

1. 项目的目录结构及介绍

protobuf-unity/
├── Assets/
│   ├── Editor/
│   │   ├── ProtobufImporter.cs
│   │   └── ProtobufUnity.cs
│   ├── Plugins/
│   │   ├── Google.Protobuf.dll
│   │   └── protobuf-net.dll
│   ├── Scripts/
│   │   ├── ExampleMessage.proto
│   │   └── ExampleUsage.cs
│   └── Resources/
│       └── config.json
├── Packages/
│   └── manifest.json
├── ProjectSettings/
│   └── ProjectVersion.txt
└── README.md

• Assets/: Unity 项目的资源目录，包含所有资源文件。
  • Editor/: 包含自定义的 Unity 编辑器脚本，用于处理 Protobuf 文件的导入和生成。
  • Plugins/: 包含所需的 Protobuf 库文件。
  • Scripts/: 包含示例 Protobuf 文件和使用示例代码。
  • Resources/: 包含项目的配置文件。
• Packages/: 包含 Unity 项目的包管理文件。
• ProjectSettings/: 包含 Unity 项目的设置文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件主要是 ExampleUsage.cs，位于 Assets/Scripts/ 目录下。该文件展示了如何在 Unity 中使用生成的 Protobuf 类进行序列化和反序列化。

using UnityEngine;
using Google.Protobuf;

public class ExampleUsage : MonoBehaviour
{
    void Start()
    {
        ExampleMessage message = new ExampleMessage
        {
            Id = 1,
            Name = "Test"
        };

        byte[] bytes = message.ToByteArray();
        ExampleMessage deserializedMessage = ExampleMessage.Parser.ParseFrom(bytes);

        Debug.Log($"Deserialized Message: ID={deserializedMessage.Id}, Name={deserializedMessage.Name}");
    }
}

3. 项目的配置文件介绍

项目的配置文件是 config.json，位于 Assets/Resources/ 目录下。该文件包含了项目的配置信息，例如 Protobuf 文件的路径和生成选项。

{
    "protobufFilesPath": "Assets/Scripts",
    "outputPath": "Assets/Generated",
    "options": {
        "generateCSharp": true,
        "generateJson": false
    }
}

• protobufFilesPath: Protobuf 文件的存放路径。
• outputPath: 生成的 C# 文件的输出路径。
• options: 生成选项，例如是否生成 C# 文件和 JSON 文件。

以上是 protobuf-unity 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。