来自属性的 Json.Net 自定义序列化

Question

我已经很好地阅读了 json.net 上的文档，但我的想法已经不多了。我有一种情况，我有孩子提到那里的父母。所以

public class ObjA
{
  public int Id {get;set}
  public string OtherStuff {get;set}
  public ObjB MyChild {get;set}
}

public class ObjB
{
  public int Id {get;set}
  public string OtherStuff {get;set}
  public ObjA MyParent {get;set}
}

这不会序列化。所以我可以做 [JsonIgnore] 但我宁愿做 [JsonIdOnly] 其中 ObjB，而不是对 MyParent 进行序列化或完全跳过 MyParent 显示 MyParentId:123 的 json 属性。所以

{OjbA:{
    Id:123,
    OtherStuff:some other stuff,
    MyChild:{
        Id:456,
        OtherStuff:Some other stuff,
        MyParentId:123,
        }
    }
 }

我知道我可以为一个类型编写一个自定义转换器。问题是我希望这仅在指定时发生，否则我将无法序列化 ObjA。换句话说，我只需要在我用属性装饰它时才会发生这种情况。所以

public class ObjB
{
  public int Id {get;set}
  public string OtherStuff {get;set}
  [JsonIdOnly]
  public ObjA MyParent {get;set}
}

Answer 1

如果您不关心 JSON 中是否包含一些额外的簿记信息，请按照 @Athari 的建议将 JsonSerializerSettings 中的 PreserveReferenceHandling 选项设置为 All（或 Objects）。这是使其工作的最简单方法。如果这样做，您的 JSON 将如下所示：

{
  "$id": "1",
  "Id": 123,
  "OtherStuff": "other stuff A",
  "MyChild": {
    "$id": "2",
    "Id": 456,
    "OtherStuff": "other stuff B",
    "MyParent": {
      "$ref": "1"
    }
  }
}

也就是说，有一种方法可以完成您最初想要的操作，使用自定义 JsonConverter。您可以做的是制作一个转换器，该转换器将接受任何具有 Id 属性的对象。然后，对于那些只希望将其序列化为 Id 的地方，您可以使用 [JsonConverter] 属性装饰这些属性。然后自定义转换器将用于这些情况，但不是其他情况。以下是转换器的外观：

class IdOnlyConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return objectType.IsClass;
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        writer.WriteStartObject();
        writer.WritePropertyName("Id");
        writer.WriteValue(GetId(value));
        writer.WriteEndObject();
    }

    private int GetId(object obj)
    {
        PropertyInfo prop = obj.GetType().GetProperty("Id", typeof(int));
        if (prop != null && prop.CanRead)
        {
            return (int)prop.GetValue(obj, null);
        }
        return 0;
    }

    public override bool CanRead 
    { 
        get { return false; } 
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

要使用转换器，您需要按照概述的方式设置类。请注意 MyParent 是如何用一个属性装饰的，以告诉 Json.Net 使用该属性的自定义转换器。

public class ObjA
{
    public int Id { get; set; }
    public string OtherStuff { get; set; }
    public ObjB MyChild { get; set; }
}

public class ObjB
{
    public int Id { get; set; }
    public string OtherStuff { get; set; }
    [JsonConverter(typeof(IdOnlyConverter))]
    public ObjA MyParent { get; set; }
}

序列化时，您需要将JsonSerializerSettings 的ReferenceLoopHandling 选项设置为Serialize，以告诉Json.Net 如果检测到引用循环不要抛出错误，并继续序列化（因为我们的转换器会处理的）。

总而言之，这里有一些示例代码演示了转换器的实际应用：

class Program
{
    static void Main(string[] args)
    {
        ObjA a = new ObjA();
        a.Id = 123;
        a.OtherStuff = "other stuff A";

        ObjB b = new ObjB();
        b.Id = 456;
        b.OtherStuff = "other stuff B";
        b.MyParent = a;

        a.MyChild = b;

        JsonSerializerSettings settings = new JsonSerializerSettings
        {
            ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Serialize,
            Formatting = Newtonsoft.Json.Formatting.Indented
        };

        string json = JsonConvert.SerializeObject(a, settings);
        Console.WriteLine(json);
    }
}

这是上面的输出：

{
  "Id": 123,
  "OtherStuff": "other stuff A",
  "MyChild": {
    "Id": 456,
    "OtherStuff": "other stuff B",
    "MyParent": {
      "Id": 123
    }
  }
}

Answer 2

您可以将JsonSerializerSettings.PreserveReferencesHandling 更改为PreserveReferencesHandling.Objects 或PreserveReferencesHandling.All（您可能还需要更改JsonSerializerSettings.ReferenceLoopHandling 和有关引用的各种JsonPropertyAttribute 属性）。这将向对象添加$ref JSON 属性，并保留交叉链接。

您可以使用自定义IReferenceResolver 修改$ref 属性的文本。

但是，如果您需要更复杂的引用解析，就像您建议的那样，没有$ref 属性，那么您将不得不编写一些代码。