MemoryPack在Unity中使用自定义格式化器的注意事项

理解MemoryPack的自定义格式化功能

MemoryPack作为一款高性能的序列化库，提供了强大的自定义格式化功能。开发者可以通过实现MemoryPackFormatter<T>接口来为特定类型创建自定义的序列化和反序列化逻辑。这在处理Unity特有类型（如AnimationCurve）或自定义数据结构时特别有用。

Unity中的限制与解决方案

虽然MemoryPack支持泛型属性标记，但在Unity环境中存在一个关键限制：Unity不支持在属性上使用泛型特性。这意味着类似[OrdinalIgnoreCaseStringDictionaryFormatter<int>]这样的泛型属性标记无法在Unity中正常工作。

然而，这并不意味着Unity完全不能使用自定义格式化器。开发者仍然可以通过以下方式实现自定义格式化：

1. 全局注册方式：通过MemoryPackFormatterProvider.Register<T>方法在运行时注册格式化器
2. 非泛型属性标记：使用非泛型的自定义属性标记

实际应用示例

以下是一个在Unity中成功使用自定义格式化器的完整示例：

// 自定义类型
public class ExternalObj
{
    public int x = 1;
    public int y = 2;
    public string s = "hello";
}

// 自定义格式化器
[Preserve]
public sealed class ExternalObjFormatter : MemoryPackFormatter<ExternalObj>
{
    [Preserve]
    public override void Serialize<TBufferWriter>(ref MemoryPackWriter<TBufferWriter> writer, ref ExternalObj? value)
    {
        if (value == null)
        {
            writer.WriteNullObjectHeader();
            return;
        }

        writer.WriteUnmanagedWithObjectHeader(3, value.@x, value.@y);
        writer.WriteString(value.@s);
    }

    [Preserve]
    public override void Deserialize(ref MemoryPackReader reader, ref ExternalObj? value)
    {
        if (!reader.TryReadObjectHeader(out var count))
        {
            value = null;
            return;
        }

        if (count != 3) MemoryPackSerializationException.ThrowInvalidPropertyCount(3, count);

        reader.ReadUnmanaged(out int x, out int y);
        var s = reader.ReadString();

        if (value == null)
        {
            value = new ExternalObj();
        }

        value.x = x;
        value.y = y;
        value.s = s;
    }
}

// 注册格式化器
MemoryPackFormatterProvider.Register<ExternalObj>(new ExternalObjFormatter());

最佳实践建议

1. 优先使用运行时注册：在Unity中，推荐使用MemoryPackFormatterProvider.Register方法在运行时注册自定义格式化器
2. 注意IL2CPP兼容性：确保为自定义格式化器添加[Preserve]特性，以保证IL2CPP编译时不会被剥离
3. 处理空值情况：在自定义格式化器中妥善处理null值情况
4. 版本兼容性：考虑序列化数据的版本兼容性，特别是当数据结构可能发生变化时

总结

虽然Unity对MemoryPack的某些高级功能（如泛型属性标记）支持有限，但通过合理的设计和替代方案，开发者仍然可以充分利用MemoryPack的强大序列化能力。理解这些限制并掌握正确的使用方法，可以帮助开发者在Unity项目中高效地实现复杂对象的序列化和反序列化需求。