MessagePack-CSharp 在 Unity 中序列化 Vector3 的解决方案

问题背景

在使用 MessagePack-CSharp 3.0.54-alpha 版本进行 Unity 项目开发时，开发者可能会遇到一个常见问题：尝试序列化包含 UnityEngine.Vector3 类型的自定义类时，系统会抛出 FormatterNotRegisteredException 异常，提示 Vector3 类型未在解析器中注册。

错误分析

这个问题的核心在于 MessagePack 的序列化机制。MessagePack 需要为每种要序列化的类型注册一个格式化器(Formatter)。对于 Unity 内置类型如 Vector3，在 MessagePack-CSharp 3.0.54-alpha 版本中，其格式化器不会自动注册到 StaticCompositeResolver 中。

解决方案

临时解决方案（针对 3.0.54-alpha 版本）

对于当前版本，开发者需要手动将 UnityResolver 及其内置的 Vector3 格式化器注册到 StaticCompositeResolver 中：

StaticCompositeResolver.Instance.Register(
    StandardResolver.Instance,
    UnityResolver.Instance,  // 添加 UnityResolver
    GeneratedResolver.Instance
);

MessagePackSerializer.DefaultOptions = MessagePackSerializerOptions.Standard
                                     .WithResolver(StaticCompositeResolver.Instance)
                                     .WithSecurity(MessagePackSecurity.UntrustedData);

未来版本解决方案

根据 MessagePack-CSharp 开发团队的反馈，这个问题已经在最新的开发版本中得到修复（虽然尚未正式发布）。在未来的版本中，Unity 内置类型的格式化器将会自动注册，开发者无需手动添加。

其他相关问题

在构建 Unity 项目时，开发者可能还会遇到另一个相关错误：

Fatal error in Unity CIL Linker
Mono.Linker.LinkerFatalErrorException: ILLink: error IL1005: MessagePack.ImmutableCollection.ImmutableCollectionGetFormatterHelper.GetFormatter(Type)

这个错误表明项目缺少对 System.Collections.Immutable 程序集的引用。解决方案是在 Unity 项目中添加对该程序集的引用，或者通过 NuGet 安装相应的包。

最佳实践建议

1. 版本选择：如果可能，等待 MessagePack-CSharp 发布包含自动注册 Unity 类型的新版本。

2. 类型注册：对于自定义类型，确保使用 MessagePackAnalyzer 生成相应的格式化器代码。

3. 构建配置：在 Unity 的 IL2CPP 构建中，确保所有依赖项都正确配置，特别是对于系统程序集的引用。

4. 错误处理：在序列化/反序列化代码中添加适当的错误处理，以捕获和处理可能的格式化器注册异常。

总结

MessagePack-CSharp 是一个强大的序列化库，但在 Unity 环境中使用时需要注意一些特殊配置。当前版本需要手动注册 Unity 内置类型的格式化器，而这个问题将在未来版本中得到改进。开发者应根据项目需求选择合适的解决方案，并关注库的更新以获取更好的开发体验。