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 类型组合。通过合理的缓存和优化,保证了序列化性能,同时保持了代码的简洁性和可维护性。
登录后查看全文
热门项目推荐
- QQwen3-Next-80B-A3B-InstructQwen3-Next-80B-A3B-Instruct 是一款支持超长上下文(最高 256K tokens)、具备高效推理与卓越性能的指令微调大模型00
- QQwen3-Next-80B-A3B-ThinkingQwen3-Next-80B-A3B-Thinking 在复杂推理和强化学习任务中超越 30B–32B 同类模型,并在多项基准测试中优于 Gemini-2.5-Flash-Thinking00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0266cinatra
c++20实现的跨平台、header only、跨平台的高性能http库。C++00AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GOT-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).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
143
1.91 K

deepin linux kernel
C
22
6

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

React Native鸿蒙化仓库
C++
192
273

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

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

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
64

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K

Elasticsearch
国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8