Newtonsoft.Json 中如何动态忽略 JsonProperty 属性名配置
2025-05-21 12:27:59作者:鲍丁臣Ursa
在 Newtonsoft.Json 的实际应用中,我们经常会遇到需要动态控制 JSON 属性名称映射的场景。本文将深入探讨如何通过自定义 ContractResolver 来实现忽略 JsonProperty 属性配置的技术方案。
问题背景
在 JSON 序列化/反序列化过程中,我们通常会使用 [JsonProperty] 特性来指定属性在 JSON 中的名称。例如:
public class UserEvent
{
[JsonProperty("s")]
public string ScheduleId { get; set; }
[JsonProperty("i")]
public string EventId { get; set; }
}
默认情况下,这个类会被序列化为类似 {"s": "value1", "i": "value2"} 的 JSON 格式。但有时我们可能需要临时忽略这些自定义名称配置,让属性使用其原始名称进行序列化。
解决方案:自定义 ContractResolver
Newtonsoft.Json 提供了强大的扩展点 ContractResolver,我们可以通过继承 DefaultContractResolver 并重写其 CreateProperty 方法来实现自定义属性名称映射逻辑。
实现步骤
- 创建自定义 ContractResolver:
public class IgnoreJsonPropertyResolver : DefaultContractResolver
{
protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
{
// 首先获取基类的属性配置
JsonProperty property = base.CreateProperty(member, memberSerialization);
// 将属性名重置为成员名称
property.PropertyName = member.Name;
return property;
}
}
- 在序列化/反序列化时使用自定义解析器:
var settings = new JsonSerializerSettings
{
ContractResolver = new IgnoreJsonPropertyResolver()
};
// 序列化
string json = JsonConvert.SerializeObject(userEvent, settings);
// 反序列化
var obj = JsonConvert.DeserializeObject<UserEvent>(json, settings);
进阶用法
如果需要更精细的控制,比如只对特定类型的属性忽略 JsonProperty 配置,可以修改 CreateProperty 方法:
protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
{
JsonProperty property = base.CreateProperty(member, memberSerialization);
// 仅对UserEvent类忽略JsonProperty配置
if (property.DeclaringType == typeof(UserEvent))
{
property.PropertyName = member.Name;
}
return property;
}
应用场景
这种技术特别适用于以下情况:
- 需要临时切换 JSON 格式的 API 兼容场景
- 开发调试时希望看到原始属性名的 JSON 输出
- 在单元测试中验证对象结构
- 需要与不使用 Newtonsoft.Json 的系统交互时
注意事项
- 此方法会全局影响所有属性的名称映射,使用时需谨慎
- 性能考虑:自定义 ContractResolver 会略微增加序列化开销
- 对于大型项目,建议将自定义解析器设计为可配置的
通过这种灵活的方式,开发者可以在不修改原始类定义的情况下,动态控制 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
最新内容推荐
STM32到GD32项目移植完全指南:从兼容性到实战技巧 32位ECC纠错Verilog代码:提升FPGA系统可靠性的关键技术方案 Adobe Acrobat XI Pro PDF拼版插件:提升排版效率的专业利器 IK分词器elasticsearch-analysis-ik-7.17.16:中文文本分析的最佳解决方案 ReportMachine.v7.0D5-XE10:Delphi报表生成利器深度解析与实战指南 开源电子设计自动化利器:KiCad EDA全方位使用指南 Photoshop作业资源文件下载指南:全面提升设计学习效率的必备素材库 Python案例资源下载 - 从入门到精通的完整项目代码合集 CrystalIndex资源文件管理系统:高效索引与文件管理的最佳实践指南 VSdebugChkMatch.exe:专业PDB签名匹配工具全面解析与使用指南
项目优选
收起
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
249
2.48 K
deepin linux kernel
C
24
6
Ascend Extension for PyTorch
Python
88
119
暂无简介
Dart
548
119
React Native鸿蒙化仓库
JavaScript
217
298
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.02 K
600
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
592
126
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
411
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
356
1.75 K
openGauss kernel ~ openGauss is an open source relational database management system
C++
153
204