首页
/ Newtonsoft.Json 反序列化时意外追加数据的解决方案

Newtonsoft.Json 反序列化时意外追加数据的解决方案

2025-05-21 12:38:44作者:羿妍玫Ivan

问题现象

在使用 Newtonsoft.Json 进行游戏存档数据反序列化时,开发者遇到了一个奇怪的现象:当反序列化包含嵌套字典结构的 JSON 数据时,某些列表中的元素会被意外地追加,而不是简单地覆盖原有数据。

具体表现为:在反序列化后,missions 列表中出现了额外的元素,数量恰好等于 ActionStageSaveData 类中初始化 missions 列表时指定的元素数量。例如,如果初始化代码为 new() { new(), new(), new() },则反序列化后会额外添加 3 个元素。

问题根源

这个问题的根本原因在于 Newtonsoft.Json 的默认反序列化行为。Newtonsoft.Json 默认使用 ObjectCreationHandling.Auto 设置,这意味着:

  1. 对于已存在的集合和对象,Json.NET 会尝试重用它们
  2. 反序列化过程会将 JSON 中的数据添加到现有集合中,而不是替换整个集合
  3. 这种行为对于某些场景可能有用,但在大多数情况下会导致意外的数据追加

解决方案

要解决这个问题,我们需要修改 Newtonsoft.Json 的反序列化设置,明确指定对象创建处理方式:

var settings = new JsonSerializerSettings
{
    ObjectCreationHandling = ObjectCreationHandling.Replace
};
loadedData = JsonConvert.DeserializeObject<GameData>(dataToLoad, settings);

使用 ObjectCreationHandling.Replace 设置后,Json.NET 将:

  1. 在反序列化时创建新对象,而不是重用现有对象
  2. 完全替换目标集合,而不是向其中添加元素
  3. 确保反序列化结果与原始 JSON 数据完全一致

深入理解 ObjectCreationHandling

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

  1. Auto(默认):根据情况自动决定是重用还是替换对象
  2. Reuse:尽可能重用现有对象和集合
  3. Replace:总是创建新对象并替换现有集合

在大多数业务场景中,特别是涉及数据持久化和恢复的场景,Replace 是最安全的选择,因为它能确保反序列化结果与序列化前的数据完全一致。

最佳实践建议

  1. 明确指定序列化设置:不要依赖默认设置,特别是对于重要数据的序列化/反序列化
  2. 考虑使用 DTO 模式:为序列化设计专用的数据传输对象,避免业务逻辑与序列化逻辑耦合
  3. 单元测试验证:编写单元测试验证序列化/反序列化的正确性
  4. 文档记录设置:在项目文档中记录使用的 JSON 序列化设置,方便团队协作

总结

Newtonsoft.Json 的默认反序列化行为可能会导致数据意外追加的问题,特别是在处理嵌套集合时。通过明确设置 ObjectCreationHandling.Replace,开发者可以确保反序列化过程按预期工作,避免数据不一致的问题。理解并正确配置序列化设置是使用任何 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