如果您不关心您的 JSON 中是否包含一些额外的簿记信息,请按照 @Athari 的建议将PreserveReferenceHandling
选项设置JsonSerializerSettings
为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; }
}
序列化时,您需要设置ReferenceLoopHandling
选项JsonSerializerSettings
toSerialize
告诉 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
}
}
}