Newtonsoft.Json 中数组反序列化的特殊行为解析

现象描述

在使用 Newtonsoft.Json 进行 JSON 数据反序列化时，开发者可能会遇到一个有趣的现象：当目标类中的数组属性已经初始化了默认值，而 JSON 数据中也包含同名数组时，最终结果不是简单的覆盖，而是将两部分的数组合并在一起。

示例代码分析

让我们通过一个具体示例来观察这一行为：

class TestForJsonArray
{
    public List<double> TestArray { get; set; } = new List<double> { 1, 1 }; // 初始化默认值
}

string testString = @"{""TestArray"" : [2,2]}";
var testModel = JsonConvert.DeserializeObject<TestForJsonArray>(testString);
string testModelString = JsonConvert.SerializeObject(testModel);

开发者预期的输出是 {"TestArray":[2.0,2.0]}，但实际得到的却是 {"TestArray":[1.0,1.0,2.0,2.0]}。

行为差异对比

值得注意的是，System.Text.Json 的表现与 Newtonsoft.Json 不同。在相同场景下，System.Text.Json 会直接覆盖数组内容，而不是合并：

// 使用 System.Text.Json 的结果
{"TestArray":[2,2]}

技术原理

这种差异源于 Newtonsoft.Json 的设计理念和默认配置。Newtonsoft.Json 在反序列化时，默认会保留目标对象已有的集合内容，并将反序列化得到的新元素添加到集合中，而不是清空原有集合。

这种行为可以通过 ObjectCreationHandling 设置来控制。Newtonsoft.Json 提供了三种处理方式：

1. Auto：默认行为，对于集合类型会重用现有实例
2. Reuse：总是重用现有实例
3. Replace：总是创建新实例替换现有实例

解决方案

如果希望 Newtonsoft.Json 的行为与 System.Text.Json 一致，可以采用以下两种方式：

方法一：修改类定义

class TestForJsonArray
{
    public List<double> TestArray { get; set; } // 不初始化默认值
}

方法二：使用 JsonProperty 特性

class TestForJsonArray
{
    [JsonProperty(ObjectCreationHandling = ObjectCreationHandling.Replace)]
    public List<double> TestArray { get; set; } = new List<double> { 1, 1 };
}

方法三：全局设置

var settings = new JsonSerializerSettings
{
    ObjectCreationHandling = ObjectCreationHandling.Replace
};
var testModel = JsonConvert.DeserializeObject<TestForJsonArray>(testString, settings);

设计思考

Newtonsoft.Json 的这种默认行为有其设计考量。在某些场景下，合并数组可能正是开发者期望的行为，比如：

1. 配置合并：将默认配置与用户自定义配置合并
2. 数据聚合：将多个来源的数据合并到一个集合中
3. 增量更新：在已有数据基础上添加新数据

最佳实践建议

1. 明确集合初始化意图：如果确实需要空集合，应在构造函数中初始化，而不是属性初始化器
2. 保持一致性：项目中应统一使用一种 JSON 库，避免混用导致行为不一致
3. 文档注释：对于可能引起混淆的集合属性，添加注释说明其行为

总结

Newtonsoft.Json 在反序列化集合类型时的默认合并行为体现了其灵活的设计理念。理解这一特性有助于开发者更好地控制数据反序列化过程，避免意外行为。根据具体需求选择合适的处理方式，可以使代码更加健壮和可维护。