反序列化关系模型的 Newtonsoft.Json 问题

Question

我有一个简单的关系模型，其父子关系如下：

    public class Parent
    {
        public Parent(int id)
        {
            Id = id;
        }

        public int Id { get; private set; }
        public IList<Child> Children { get; set; } = new List<Child>();
    }

    public class Child
    {
        public Parent Parent { get; set; }
    }

我创建了一个小对象图，其中包含共享同一父级的两个子级的列表：

    var parent = new Parent(1);
    var child1 = new Child {Parent = parent};
    var child2 = new Child {Parent = parent};
    parent.Children.Add(child1);
    parent.Children.Add(child2);

    var data = new List<Child> {child1, child2};

接下来，我使用SerializeObject对其进行序列化：

    var settings = new JsonSerializerSettings
    {
        PreserveReferencesHandling = PreserveReferencesHandling.All
    };
    var json = Newtonsoft.Json.JsonConvert.SerializeObject(data, Formatting.Indented, settings);

据我所知，生成的 json 看起来不错：

{
  "$id": "1",
  "$values": [
    {
      "$id": "2",
      "Parent": {
        "$id": "3",
        "Id": 1,
        "Children": {
          "$id": "4",
          "$values": [
            {
              "$ref": "2"
            },
            {
              "$id": "5",
              "Parent": {
                "$ref": "3"
              }
            }
          ]
        }
      }
    },
    {
      "$ref": "5"
    }
  ]
}

但是，当我反序列化 json 时，我没有得到预期的对象，因为对于第二个孩子，Parent 属性为空，导致第二个断言失败：

    var data2 = Newtonsoft.Json.JsonConvert.DeserializeObject<IList<Child>>(json, settings);
    Debug.Assert(data2[0].Parent != null);
    Debug.Assert(data2[1].Parent != null);

没有Parent的构造函数不会出现这个问题，第二个孩子的Parent属性有预期值。

有什么想法吗？

Answer 1

参数化构造函数不能很好地与PreserveReferencesHandling 一起工作，因为存在一个先天先有鸡的问题：在反序列化程序需要创建目的。所以需要有一种方法让它创建一个空对象，然后再填写适当的信息。

这是一个已知的限制，是documented:

注意：
通过非默认构造函数设置值时，无法保留引用。对于非默认构造函数，必须在父值之前创建子值，以便将它们传递给构造函数，从而无法跟踪引用。 ISerializable 类型是一个类的示例，其值由非默认构造函数填充，不适用于 PreserveReferencesHandling。

要解决模型的问题，您可以在 Parent 类中创建一个私有的无参数构造函数，并用 [JsonConstructor] 标记它。然后用[JsonProperty] 标记Id 属性，这将允许Json.Net 使用私有setter。所以你会有：

public class Parent
{
    public Parent(int id)
    {
        Id = id;
    }

    [JsonConstructor]
    private Parent()
    { }

    [JsonProperty]
    public int Id { get; private set; }
    public IList<Child> Children { get; set; } = new List<Child>();
}

顺便说一句，由于您的所有列表都没有在对象之间共享，因此您可以使用PreserveReferencesHandling.Objects 而不是PreserveReferencesHandling.All。这将使 JSON 更小一些，但仍会保留您关心的引用。

这里的工作演示：https://dotnetfiddle.net/cLk9DM

Answer 2

我还没有测试过这个，但我觉得如果你把设置放入序列化器和反序列化器中它会解决它：

var settings = new JsonSerializerSettings
{
    PreserveReferencesHandling = PreserveReferencesHandling.All
};
var json = Newtonsoft.Json.JsonConvert.SerializeObject(data, Formatting.Indented, settings);
var data2 = Newtonsoft.Json.JsonConvert.DeserializeObject<IList<Child>>(json, settings);

Answer 3

第二次尝试：

我重现了这个问题，然后把Parent的构造函数改成无参，Id属性改成可设置，然后就成功了。不知道为什么，但我想这是 Newtonsoft 选择如何构建事物的方式中的一些错误，特别是因为顺序对于 PreserveReferencesHandling 很重要。

public class Parent
{
    public int Id { get; set; }
    public IList<Child> Children { get; set; } = new List<Child>();
}

和

var parent = new Parent { Id = 1 };