Newtonsoft.Json 派生类反序列化中 $type 属性的位置问题解析
2025-05-21 17:12:05作者:卓艾滢Kingsley
背景介绍
在使用 Newtonsoft.Json 进行 JSON 反序列化时,开发者经常会遇到需要处理继承关系的情况。当我们需要将 JSON 数据反序列化为基类,但实际希望得到派生类实例时,通常会使用 $type 元数据属性来指定具体类型。然而,这个属性的位置有时会影响反序列化的结果。
问题现象
考虑以下类结构:
class Base { public string Name { get; set; } }
class Derived : Base { }
当使用如下 JSON 进行反序列化时:
{"Name":"test","$type":"Derived, AssemblyName"}
结果会得到 Base 类型的实例,而不是预期的 Derived 类型。
但如果将 $type 属性放在首位:
{"$type":"Derived, AssemblyName","Name":"test"}
则能正确得到 Derived 类型的实例。
技术原理
这个现象背后的原因是 Newtonsoft.Json 默认的元数据处理方式。默认情况下,序列化器采用"按需读取"的策略处理 $type 属性,这意味着:
- 当
$type不是第一个属性时,序列化器会先开始创建对象 - 在遇到
$type属性前,已经基于声明的目标类型(Base)创建了实例 - 后续发现
$type时,对象已经创建完成
解决方案
Newtonsoft.Json 提供了 MetadataPropertyHandling 设置来控制这一行为:
var settings = new JsonSerializerSettings {
TypeNameHandling = TypeNameHandling.All,
MetadataPropertyHandling = MetadataPropertyHandling.ReadAhead
};
设置 ReadAhead 后,序列化器会:
- 先缓冲整个 JSON 对象
- 查找
$type属性 - 根据找到的类型信息创建正确类型的实例
性能考量
需要注意的是,启用 ReadAhead 模式会带来一定的性能开销:
- 需要额外的内存来缓冲 JSON 数据
- 增加了处理时间,特别是在处理大对象时
因此,建议仅在确实需要时才启用此模式。在可以控制 JSON 结构的情况下,将 $type 属性放在首位是更高效的解决方案。
最佳实践
- 如果可能,保持
$type作为 JSON 对象的第一个属性 - 当无法控制 JSON 结构时,使用
MetadataPropertyHandling.ReadAhead - 对于性能敏感场景,考虑预处理 JSON 数据来调整属性顺序
总结
理解 Newtonsoft.Json 处理类型元数据的方式对于正确实现多态反序列化至关重要。通过合理配置 MetadataPropertyHandling 或调整 JSON 结构,可以确保派生类型被正确识别和实例化,同时平衡性能和功能需求。
登录后查看全文
热门项目推荐
相关项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
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).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
248
2.46 K
deepin linux kernel
C
24
6
仓颉编译器源码及 cjdb 调试工具。
C++
116
89
React Native鸿蒙化仓库
JavaScript
217
297
暂无简介
Dart
546
119
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.01 K
595
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
409
Ascend Extension for PyTorch
Python
86
118
仓颉编程语言运行时与标准库。
Cangjie
124
102
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
592
122