首页
/ Newtonsoft.Json中对象创建处理机制解析

Newtonsoft.Json中对象创建处理机制解析

2025-05-21 17:17:33作者:龚格成

问题现象分析

在使用Newtonsoft.Json进行JSON反序列化时,开发者可能会遇到一个看似奇怪的现象:当一个类包含没有setter的属性时,在嵌套对象结构中该属性的值无法被正确反序列化。具体表现为:

  1. 直接反序列化包含只读属性的类时工作正常
  2. 但当这个类作为另一个类的属性时,只读属性的值却无法被正确设置
  3. 具有setter的属性则无论在任何情况下都能正常工作

根本原因探究

这一现象背后的核心原因在于Newtonsoft.Json的默认对象创建处理机制(ObjectCreationHandling)。该机制默认为Auto模式,在这种模式下:

  1. 对于反序列化过程中的对象属性,如果目标属性已经有一个实例存在,序列化器会尝试重用这个现有实例
  2. 只有当属性为null时,才会创建新实例
  3. 对于只读属性(没有setter),序列化器无法通过属性赋值来修改其值
  4. 对于构造函数参数,只有在创建新实例时才会被使用

解决方案

要解决这个问题,有以下几种方法:

方法一:修改全局序列化设置

var settings = new JsonSerializerSettings
{
    ObjectCreationHandling = ObjectCreationHandling.Replace
};
var obj = JsonConvert.DeserializeObject<Three>(json, settings);

方法二:为特定属性添加特性

public class Three
{
    public One One { get; set; } = new();
    
    [JsonProperty(ObjectCreationHandling = ObjectCreationHandling.Replace)]
    public Two Two { get; set; } = new();
}

方法三:修改类设计

如果可能,为只读属性添加setter是最直接的解决方案:

public int Foo { get; private set; } = foo;

深入理解ObjectCreationHandling

Newtonsoft.Json提供了三种对象创建处理模式:

  1. Auto:默认模式,尽可能重用现有对象实例
  2. Reuse:总是重用现有对象实例
  3. Replace:总是创建新实例替换现有对象

在大多数情况下,Auto模式提供了最佳的性能和内存使用效率,因为它减少了不必要的对象创建。然而,这也正是导致本文所述问题的原因。

最佳实践建议

  1. 在设计DTO(数据传输对象)时,优先考虑使用可写属性
  2. 如果确实需要只读属性,确保理解Newtonsoft.Json的行为
  3. 对于复杂的对象图,考虑显式指定ObjectCreationHandling策略
  4. 在性能敏感的场景中,重用对象可能带来好处,但要注意副作用

总结

Newtonsoft.Json的这一设计体现了在灵活性和可预测性之间的权衡。理解这一机制有助于开发者在实际项目中做出更合理的设计决策,避免出现意外的反序列化行为。特别是在处理不可变对象或只读属性时,需要特别注意对象创建策略的影响。

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

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
163
2.05 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
60
16
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
199
279
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
951
557
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
96
15
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
77
70
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
17
0