从属性 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属性，则必须编写一些代码。