MessagePack-CSharp 中实现 OneOf 类型的序列化方案

背景介绍

在 MessagePack-CSharp 项目中，开发者经常需要处理复杂的数据类型序列化问题。其中，OneOf 类型作为一种能够表示多个可能类型的联合体，在业务场景中非常实用。然而，MessagePack 默认并不直接支持 OneOf 类型的序列化和反序列化。

解决方案概述

通过自定义 MessagePack 格式化器(Formatter)和解析器(Resolver)，我们可以实现对 OneOf 类型的完整支持。核心思路是利用 MessagePack 的扩展机制，为 OneOf 类型创建专门的序列化逻辑。

实现细节

1. 自定义解析器(Resolver)

首先需要创建一个 OneOfResolver，它负责为 OneOf 类型提供对应的格式化器：

public class OneOfResolver : IFormatterResolver
{
    public static readonly IFormatterResolver Instance = new OneOfResolver();
    
    public IMessagePackFormatter<T> GetFormatter<T>()
    {
        if (!typeof(IOneOf).IsAssignableFrom(typeof(T)))
        {
            return null;
        }
        
        return FormatterCache<T>.Formatter;
    }
    
    private static class FormatterCache<T> where T : IOneOf
    {
        public static readonly IMessagePackFormatter<T> Formatter = 
            (IMessagePackFormatter<T>)Activator.CreateInstance(
                typeof(OneOfDynamicFormatter<>).MakeGenericType(typeof(T)));
    }
}

2. 自定义格式化器(Formatter)

然后实现具体的格式化逻辑，处理序列化和反序列化过程：

public class OneOfDynamicFormatter<T> : IMessagePackFormatter<T> where T : IOneOf
{
    private static readonly Type[] GenericArguments = typeof(T).GetGenericArguments();
    
    public void Serialize(ref MessagePackWriter writer, T value, MessagePackSerializerOptions options)
    {
        writer.WriteArrayHeader(2);
        
        var valueType = value.Value.GetType();
        var typeIndex = Array.IndexOf(GenericArguments, valueType);
        
        writer.Write(typeIndex);
        MessagePackSerializer.Serialize(valueType, ref writer, value.Value, options);
    }
    
    public T Deserialize(ref MessagePackReader reader, MessagePackSerializerOptions options)
    {
        if (reader.ReadArrayHeader() != 2)
            throw new InvalidOperationException("Invalid OneOf format.");
        
        var typeIndex = reader.ReadInt32();
        if (typeIndex < 0 || typeIndex >= GenericArguments.Length)
            throw new InvalidOperationException("Invalid OneOf variant.");
        
        var targetType = GenericArguments[typeIndex];
        var deserializedValue = MessagePackSerializer.Deserialize(targetType, ref reader, options);
        
        var method = typeof(T).GetMethod($"FromT{typeIndex}", BindingFlags.Public | BindingFlags.Static)
            ?? throw new InvalidOperationException($"Unable to find method FromT{typeIndex} on {typeof(T)}");
        
        return (T)method.Invoke(null, new[] { deserializedValue });
    }
}

3. 注册解析器

最后将自定义解析器注册到 MessagePack 的解析器链中：

MessagePackSerializer.DefaultOptions = MessagePackSerializerOptions.Standard
    .WithResolver(
        CompositeResolver.Create(
            OneOfResolver.Instance,
            ContractlessStandardResolver.Instance
        ));

技术要点

1. 序列化格式：采用数组格式存储，第一个元素是类型索引，第二个元素是实际值。

2. 性能优化：

   • 使用静态缓存存储泛型参数，避免重复计算
   • 采用类型安全的静态缓存模式，而非 ConcurrentDictionary

3. 类型安全：

   • 严格校验类型索引范围
   • 运行时检查确保方法调用安全

4. 兼容性：

   • 支持任意类型的 OneOf 组合
   • 与 MessagePack 现有体系无缝集成

使用示例

dynamic[] values = ["Hello", 42, true, new Customer("123", "Customer 123"), new NotFound()];

foreach (var value in values)
{
    OneOf<string, int, bool, Customer, NotFound> oneOfInstance = value;
    
    var result = MessagePackSerializer.Serialize(oneOfInstance);
    var deserialized = MessagePackSerializer.Deserialize<OneOf<string, int, bool, Customer, NotFound>>(result);
    
    Console.WriteLine($"Original: {oneOfInstance.Value}, Deserialized: {deserialized.Value}");
}

总结

通过自定义 MessagePack 格式化器，我们实现了对 OneOf 类型的完整支持。这种方案具有以下优势：

1. 无需修改现有 OneOf 类型定义
2. 序列化格式紧凑高效
3. 完全兼容 MessagePack 生态系统
4. 类型安全，运行时检查完善

这种模式不仅适用于 OneOf 类型，也可以作为其他特殊类型序列化方案的参考实现。开发者可以根据实际需求调整序列化格式或优化性能表现。