MessagePack-CSharp在Unity IL2CPP模式下处理自定义类型序列化的解决方案

2025-06-04 01:59:19作者：苗圣禹Peter

问题背景

在使用MessagePack-CSharp进行Unity项目开发时，当切换到IL2CPP编译模式后，开发者可能会遇到一个常见的序列化问题：尝试序列化包含自定义类型数组的对象时，会抛出"Not supported primitive object resolver"异常。这个问题在Mono模式下通常不会出现，但在IL2CPP模式下却会引发错误。

问题分析

问题的核心在于MessagePack-CSharp的PrimitiveObjectFormatter对于非基本类型的处理机制。在IL2CPP环境下，当尝试序列化一个包含自定义类型（如AirSimYawMode、AirSimPose等）的对象数组时，序列化器无法自动识别这些自定义类型，导致序列化失败。

解决方案

要解决这个问题，我们需要创建一个自定义的解析器(Resolver)和格式化器(Formatter)，专门用于处理包含自定义类型的对象数组。以下是实现步骤：

1. 创建自定义格式化器

首先，我们需要实现一个IMessagePackFormatter<object[]>接口的自定义格式化器，明确指定如何处理各种类型的数据：

public class CustomObjectArrayFormatter : IMessagePackFormatter<object[]>
{
    public void Serialize(ref MessagePackWriter writer, object[] value, MessagePackSerializerOptions options)
    {
        writer.WriteArrayHeader(value.Length);
        foreach (var item in value)
        {
            switch (item)
            {
                case int intValue:
                    writer.Write(intValue);
                    break;
                case float floatValue:
                    writer.Write(floatValue);
                    break;
                case bool boolValue:
                    writer.Write(boolValue);
                    break;
                case string stringValue:
                    writer.Write(stringValue);
                    break;
                case AirSimYawMode yawMode:
                    options.Resolver.GetFormatterWithVerify<AirSimYawMode>().Serialize(ref writer, yawMode, options);
                    break;
                case AirSimVector vector:
                    options.Resolver.GetFormatterWithVerify<AirSimVector>().Serialize(ref writer, vector, options);
                    break;
                case AirSimQuaternion quaternion:
                    options.Resolver.GetFormatterWithVerify<AirSimQuaternion>().Serialize(ref writer, quaternion, options);
                    break;
                case AirSimPose pose:
                    options.Resolver.GetFormatterWithVerify<AirSimPose>().Serialize(ref writer, pose, options);
                    break;
                default:
                    throw new InvalidOperationException("Unsupported type encountered: " + item.GetType());
            }
        }
    }

    public object[] Deserialize(ref MessagePackReader reader, MessagePackSerializerOptions options)
    {
        var len = reader.ReadArrayHeader();
        var result = new object[len];
        for (int i = 0; i < len; i++)
        {
            var type = reader.NextMessagePackType;
            switch (type)
            {
                case MessagePackType.Integer:
                    result[i] = reader.ReadInt32();
                    break;
                case MessagePackType.Float:
                    result[i] = reader.ReadSingle();
                    break;
                case MessagePackType.Boolean:
                    result[i] = reader.ReadBoolean();
                    break;
                case MessagePackType.String:
                    result[i] = reader.ReadString();
                    break;
                default:
                    throw new InvalidOperationException("Unsupported MessagePackType encountered: " + type);
            }
        }
        return result;
    }
}

2. 注册自定义解析器

接下来，我们需要在应用程序启动时注册这个自定义解析器：

var customize = CompositeResolver.Create(
    new IMessagePackFormatter[] { new CustomObjectArrayFormatter() },
    new[] { StandardResolver.Instance }
);

StaticCompositeResolver.Instance.Register(
    customize,
    MessagePack.Resolvers.StandardResolver.Instance,
    MessagePack.Resolvers.GeneratedResolver.Instance
);

技术要点

类型安全处理：自定义格式化器中通过switch-case语句明确处理每种支持的类型，确保类型安全。
性能考虑：直接调用writer.Write方法处理基本类型，避免不必要的反射开销。
扩展性：当需要支持新的自定义类型时，只需在格式化器中添加相应的case分支即可。
错误处理：对于不支持的类型，抛出明确的异常信息，便于调试。

实际应用

在实际项目中，这种解决方案特别适用于RPC框架或网络通信场景，其中请求/响应对象可能包含各种不同类型的参数。例如：

[MessagePackObject]
public class RpcRequest
{
   [Key(0)] public int type { get; set; }
   [Key(1)] public int id { get; set; }
   [Key(2)] public string method { get; set; }
   [Key(3)] public object[] _Param { get; set; }
}