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

时间:2013-10-03 16:09:58

标签: c# json serialization attributes json.net

我已经很好地阅读了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}
}

谢谢, RAIF

2 个答案:

答案 0 :(得分:2)

如果你不在乎你的JSON中有一些额外的簿记信息,那么将PreserveReferenceHandling中的JsonSerializerSettings选项设置为All(或Objects), @Athari建议。这是让它发挥作用的最简单方法。如果你这样做,你的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; }
}

序列化时,您需要将ReferenceLoopHandling的{​​{1}}选项设置为JsonSerializerSettings,以告知Json.Net在检测到参考循环时不会抛出错误,并继续无论如何序列化(因为我们的转换器将处理它)。

总结一下,这里有一些示例代码演示了转换器的运行情况:

Serialize

这是以上的输出:

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);
    }
}

答案 1 :(得分:0)

您可以将JsonSerializerSettings.PreserveReferencesHandling更改为PreserveReferencesHandling.ObjectsPreserveReferencesHandling.All(您可能还需要更改JsonSerializerSettings.ReferenceLoopHandling以及有关参考的各种JsonPropertyAttribute属性。这将向对象添加$ref JSON属性,并保留交叉链接。

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

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