首页
/ Newtonsoft.Json 中如何防止默认值被 JSON 的 null 覆盖

Newtonsoft.Json 中如何防止默认值被 JSON 的 null 覆盖

2025-05-21 04:38:54作者:翟江哲Frasier

在配置驱动的应用程序开发中,我们经常需要为类属性设置合理的默认值。然而,当使用 Newtonsoft.Json 进行反序列化时,如果 JSON 数据中包含显式的 null 值,这些默认值会被意外覆盖。本文将深入探讨这个问题的成因及解决方案。

问题现象

假设我们有一个应用程序配置类,其中某个属性已经设置了默认值:

public class AppConfig
{
    [JsonProperty("dataValidationConfig")]
    public IDataValidationConfig DataValidationConfig { get; set; }
        = DataValidationConfigFactory.CreateBlankConfigObject();
}

当遇到如下 JSON 数据时:

{
    "dataValidationConfig": null
}

默认情况下,Newtonsoft.Json 会将 DataValidationConfig 属性设置为 null,覆盖掉我们精心设计的默认值。这在许多业务场景中都是不期望的行为。

问题本质

这种现象源于 Newtonsoft.Json 的默认反序列化行为:它会严格遵循 JSON 数据中的值,包括显式的 null。虽然这在某些情况下是合理的(如需要清除现有值),但在配置管理场景中,我们更希望保留那些已经初始化的非 null 值。

解决方案

Newtonsoft.Json 提供了 NullValueHandling 设置来控制对 null 值的处理方式。要保留已初始化的默认值,我们可以这样配置:

var settings = new JsonSerializerSettings
{
    NullValueHandling = NullValueHandling.Ignore
};

var config = JsonConvert.DeserializeObject<AppConfig>(jsonString, settings);

配置详解

NullValueHandling.Ignore 选项告诉序列化器:

  1. 当 JSON 中的值为 null 时,不修改目标对象的对应属性
  2. 保留属性原有的值(包括构造函数或属性初始化器中设置的值)

应用场景

这种配置特别适合以下情况:

  • 配置文件的增量更新(只修改显式指定的字段)
  • 插件系统的默认参数保持
  • 需要保护核心业务逻辑默认值的场景
  • 分层配置(基础配置+覆盖配置)的实现

进阶用法

除了全局设置外,我们还可以在单个属性上应用此行为:

public class AppConfig
{
    [JsonProperty("dataValidationConfig", NullValueHandling = NullValueHandling.Ignore)]
    public IDataValidationConfig DataValidationConfig { get; set; }
        = DataValidationConfigFactory.CreateBlankConfigObject();
}

这种方式提供了更细粒度的控制,适合混合场景(某些属性需要保留默认值,而另一些则需要接受 null)。

注意事项

  1. 此设置只影响反序列化过程中的 null 值处理
  2. 对于值类型(如 int, bool 等),null 会被转换为默认值(0, false 等)
  3. 如果需要完全控制反序列化行为,可以考虑实现自定义的 JsonConverter

总结

通过合理配置 NullValueHandling,我们可以优雅地解决 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