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

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

2025-06-04 04:27:29作者:羿妍玫Ivan

在 MessagePack-CSharp 项目中,开发者经常需要处理复杂类型的序列化和反序列化问题。其中,OneOf 这种联合类型(discriminated union)的处理尤为特殊。本文将介绍一种无需使用 UnionAttribute 的 OneOf 类型序列化解决方案。

OneOf 类型的特点

OneOf 是一种可以包含多个不同类型值的容器类型,它类似于 C# 中的联合类型。例如 OneOf<string, int, bool> 可以包含字符串、整数或布尔值中的任意一种。这种类型在 API 设计中非常有用,可以表示一个字段可能有多种不同类型的值。

传统解决方案的局限性

MessagePack-CSharp 通常使用 UnionAttribute 来标记联合类型,但这种方式需要预先定义所有可能的类型,不够灵活。我们需要一种更通用的解决方案,能够动态处理任何 OneOf 类型。

自定义序列化方案

我们通过实现自定义的 IFormatterResolver 和 IMessagePackFormatter 来解决这个问题。核心思路是:

  1. 序列化时存储类型索引和实际值
  2. 反序列化时根据索引重建 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 = 
            new OneOfDynamicFormatter<T>();
    }
}

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);
        return (T)method.Invoke(null, new[] { deserializedValue });
    }
}

性能优化考虑

  1. 使用静态缓存替代 ConcurrentDictionary,减少查找开销
  2. 预先缓存泛型参数类型数组,避免重复反射调用
  3. 合理配置解析器组合,避免重复解析

使用示例

// 配置解析器
MessagePackSerializer.DefaultOptions = MessagePackSerializerOptions.Standard
    .WithResolver(
        CompositeResolver.Create(
            OneOfResolver.Instance,
            ContractlessStandardResolver.Instance
        ));

// 序列化示例
OneOf<string, int, bool, Customer, NotFound> oneOf = new Customer("123", "Test");
var bytes = MessagePackSerializer.Serialize(oneOf);

// 反序列化示例
var deserialized = MessagePackSerializer.Deserialize<OneOf<string, int, bool, Customer, NotFound>>(bytes);

序列化格式说明

序列化后的数据采用数组格式:

  • 第一个元素是类型索引(整数)
  • 第二个元素是实际值

例如:

  • [0,"Hello"] 表示字符串 "Hello"
  • [3,{"Id":"123","Name":"Test"}] 表示 Customer 对象

总结

这种自定义序列化方案为 MessagePack-CSharp 提供了处理 OneOf 类型的灵活方式,无需预先定义 UnionAttribute,能够自动适应各种 OneOf 类型组合。通过合理的缓存和优化,保证了序列化性能,同时保持了代码的简洁性和可维护性。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
202
2.17 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
208
285
pytorchpytorch
Ascend Extension for PyTorch
Python
61
94
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
977
575
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
550
83
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
1.2 K
133