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 来解决这个问题。核心思路是:
- 序列化时存储类型索引和实际值
- 反序列化时根据索引重建 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 });
}
}
性能优化考虑
- 使用静态缓存替代 ConcurrentDictionary,减少查找开销
- 预先缓存泛型参数类型数组,避免重复反射调用
- 合理配置解析器组合,避免重复解析
使用示例
// 配置解析器
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 类型组合。通过合理的缓存和优化,保证了序列化性能,同时保持了代码的简洁性和可维护性。
登录后查看全文
热门项目推荐
相关项目推荐
HunyuanImage-3.0
HunyuanImage-3.0 统一多模态理解与生成,基于自回归框架,实现文本生成图像,性能媲美或超越领先闭源模型00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0369Hunyuan3D-Part
腾讯混元3D-Part00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++097AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile09
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起

deepin linux kernel
C
22
6

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
202
2.17 K

React Native鸿蒙化仓库
C++
208
285

Ascend Extension for PyTorch
Python
61
94

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
977
575

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1

本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
550
83

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399

本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27

前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。
官网地址:https://matechat.gitcode.com
1.2 K
133