MessagePack-CSharp 在 Unity WebGL 平台的使用指南

前言

MessagePack-CSharp 是一个高效的二进制序列化库，特别适合游戏开发中的网络通信和数据存储场景。本文将重点介绍在 Unity WebGL 平台使用 MessagePack-CSharp 时需要注意的关键事项和解决方案。

WebGL 平台的限制

Unity 的 WebGL 平台由于其运行环境特殊，存在以下限制：

1. 不支持动态代码生成（JIT）
2. 不支持反射式序列化
3. 需要提前生成所有序列化代码

这些限制意味着在 WebGL 平台上，MessagePack 必须完全依赖 AOT（Ahead-Of-Time）编译生成的代码。

常见问题与解决方案

FormatterNotRegisteredException 错误

这是 WebGL 平台最常见的错误，表示某个类型的序列化器未被正确注册。解决方案包括：

1. 确保所有需要序列化的类型都标记了 [MessagePackObject] 特性
2. 检查 MessagePack 源生成器是否生成了对应类型的格式化器
3. 确认 GeneratedMessagePackResolver 包含了所有需要的格式化器

类型继承的处理

当使用继承结构时，需要特别注意：

[MessagePackObject]
public class CommonReq
{
    [Key("session_id")]
    public string SessionId { get; set; }
}

[MessagePackObject]
public class StartListenReq : CommonReq {}

所有派生类也必须明确标记 [MessagePackObject] 特性，否则会导致序列化失败。

Unity 版本兼容性问题

从 Unity 6000.20f1 到当前版本 (31f1)，存在一个已知的源生成器工作异常的问题。这个 Bug 会导致：

1. 源生成器生成的代码在构建过程中丢失
2. GeneratedMessagePackResolver 无法正确生成
3. 最终导致运行时序列化失败

目前需要等待 Unity 官方修复此问题。

.NET 8 兼容性注意事项

当服务端使用 .NET 8 而客户端使用 Unity 时，需要注意 List<byte> 的序列化差异：

1. .NET 8 使用 ByteListFormatter，序列化为二进制格式
2. 旧版本使用 ListFormatter<byte>，序列化为数组格式

这种差异会导致跨平台通信时出现反序列化错误。解决方案是升级到 MessagePack-CSharp 3.1.2 或更高版本。

最佳实践建议

1. 类型设计原则：

   • 所有需要序列化的类型必须标记 [MessagePackObject]
   • 所有字段/属性必须明确指定 [Key]
   • 避免使用动态类型和匿名类型

2. 构建配置：

   • 确保源生成器在构建过程中正常运行
   • 检查构建日志是否有生成器相关的错误
   • 在 Player Settings 中启用 "Allow 'unsafe' Code"

3. 调试技巧：

   • 使用 MessagePackSerializer.SerializeToJson 检查序列化结果
   • 在开发阶段启用详细的日志记录
   • 对比服务端和客户端的类型定义是否完全一致

结语

在 Unity WebGL 平台使用 MessagePack-CSharp 虽然有一些限制，但通过遵循上述建议和解决方案，仍然可以实现高效的二进制序列化。关键是要理解 WebGL 平台的限制，并确保所有序列化相关的代码都能在 AOT 编译环境下正常工作。随着 Unity 和 MessagePack-CSharp 的持续更新，这些兼容性问题将会得到进一步改善。