PbLite 0.2.2

PbLite

面向 C# / Unity / .NET 高性能游戏场景的 Protobuf Wire Format 兼容序列化框架。

零分配、AOT 友好，适用于游戏客户端与服务端的高频通信场景。

✨ Features

🆚 Why PbLite?

PbLite 针对这些场景重新设计：

• 编译期代码生成 — Source Generator 生成 Serializer，无 Runtime Reflection、无 Runtime Model、无 DynamicMethod
• IBufferWriter<byte> 直接写入 — 序列化直接写入目标 Buffer（Pipelines / ArrayPool / Socket Buffer），无 MemoryStream、无临时 byte[]、无中间缓存
• GetSize + Serialize — 嵌套消息先通过 GetSize 计算长度再写入正确的 varint，兼容任何 IBufferWriter 实现
• AOT 友好 — 无 Reflection / Reflection.Emit，支持 Unity IL2CPP / WebGL / iOS / Native AOT
• 灵活注册 — 不限制消息注册方式，支持 MessageId Registry 和 Type Registry

标准 Protobuf Reader 可正常读取 PbLite 生成的数据。

Quick Start

1. Define Message

手写 C# class：

[PbContract]
public partial class ChatMessage
{
    [PbMember(1)]
    public long PlayerId;

    [PbMember(2)]
    public string Content = "";
}

或通过 PbGen 从 .proto 生成：

# 安装工具
dotnet tool install -g PbLite.ProtoGen

# 从 proto 生成 C# class
pblite-gen messages.proto -o ./Generated

生成的类会自动被 Source Generator 生成对应的 Serializer。

2. Initialize Registry

Source Generator 会生成 PbLiteGeneratedSerializers partial 类，调用 Register() 即可将所有 Serializer 注册到 SerializerRegistry：

// 注册当前程序集所有生成的 Serializer
PbLiteGeneratedSerializers.Register();

注册后通过 SerializerRegistry.Get(Type) 获取 Serializer：

var serializer = SerializerRegistry.Get(typeof(ChatMessage));

游戏服务端通常用 MessageId 而非 Type 定位消息：

// 遍历已注册的 Serializer，按 MsgId 建立映射
foreach (var (type, serializer) in SerializerRegistry.All)
{
    var msgId = MsgIdMap.Get(type);
    messageRegistry.Add(msgId, serializer);
}

3. Serialize

var message = new ChatMessage
{
    PlayerId = 10001,
    Content = "Hello PbLite"
};

var writer = new ArrayBufferWriter<byte>();
var serializer = SerializerRegistry.Get(typeof(ChatMessage));
serializer.Serialize(writer, message);
// writer.WrittenSpan 即为序列化结果

4. Deserialize

var reader = new ProtoReader(new ReadOnlySequence<byte>(writer.WrittenSpan));
var serializer = SerializerRegistry.Get(typeof(ChatMessage));
var message = (ChatMessage)serializer.Deserialize(ref reader, null);

proto3 兼容性

已支持

不支持

游戏场景下基本上用不到

License

MIT License