是否有办法JSON.. net序列化list的子类它也有额外的性质

本文关键字：子类 list JSON net 序列化 是否 | 更新日期: 2023-09-27 17:54:11

好的，我们使用Newtonsoft的JSON。NET产品，我非常喜欢它。但是，对于分层位置，我有一个简单的类结构，大致如下所示:


public class Location {
    public string Name { get; set; }
    public LocationList Locations { get; set; }
}
// Note: LocationList is simply a subclass of a List<T>
// which then adds an IsExpanded property for use by the UI.
public class LocationList : List<Location> {
    public bool IsExpanded { get; set; }
}
public class RootViewModel {
    public LocationList RootLocations{ get; set; }
}

…当我将它们序列化为JSON时，一切都很好，除了LocationList类上的IsExpanded属性被排除在外。只有列表的内容被序列化。

现在这是我设想的一个好的格式。从本质上讲，这与LocationList不是List<Location>的子类，而只是一个具有List<Location>类型的属性Items的普通对象是一样的。

{
  "Locations" : {
    "IsExpanded" : true,
    "Items" : [
      {
        "Name" : "Main Residence",
        "Locations" : {
          "IsExpanded" : true,
          "Items" : [
            {
              "Name" : "First Floor",
              "Locations" : {
                "IsExpanded" : false,
                "Items" : [
                  {
                    "Name" : "Livingroom"
                  },
                  {
                    "Name" : "Dining Room"
                  },
                  {
                    "Name" : "Kitchen"
                  }
                ]
              }
            },
            {
              "Name" : "Second Floor",
              "Locations" : {
                "IsExpanded" : false,
                "Items" : [
                  {
                    "Name" : "Master Bedroom"
                  },
                  {
                    "Name" : "Guest Bedroom"
                  }
                ]
              }
            },
            {
              "Name" : "Basement"
            }
          ]
        }
      }
    ]
  }
}

现在我也明白了Newtonsoft的产品是可扩展的，因为他们专门讨论了如何为特定的数据类型编写自己的自定义序列化器，这正是我在这里想要的。然而，他们没有任何好的代码示例来说明如何做到这一点。

如果我们(SO社区)能够弄清楚这一点，从技术上讲，通过使用上述格式，我们应该能够序列化List的任何子类(或其衍生/类似对象)，前提是它们没有一个名为Items的属性(在我看来，这首先是一个糟糕的设计，因为它会像垃圾一样令人困惑!)也许我们甚至可以让Newtonsoft在他们的序列化器中本地滚动这样的东西!

所以说…有人知道如何定制序列化器/反序列化器来区别对待这个对象吗?

是否有办法JSON.. net序列化list的子类它也有额外的性质

通常当我发现自己在与这样的事情作斗争时，它告诉我应该考虑另一种方法。在这种情况下，我建议使用以下视图模型结构作为替代方案:

public class Location
{
    public bool IsExpanded { get; set; }
    public string Name { get; set; }
    public List<Location> Locations { get; set; }
}
public class ViewModel
{
    public List<Location> RootLocations { get; set; }
}

Ok…这就是我的想法。我必须编写自己的json转换器。我基本上用它来创建一个内联JObject，它的属性结构是我想让它们持久保存的，然后我持久保存那个。然后，当我读出它时，执行相反的操作。

然而，缺点是它不使用反射或任何其他类似的东西，所以这只适用于我必须逐个属性手工编码的特定类型(在这种情况下只有两个，所以这很好!)，它也不利用我必须手动重新模拟的DefaultValues处理，这意味着属性基本上被忽略，除非我反思它们。不过，这种方法还是管用的。完美?不，但是……事情很少是这样的!

当然，欢迎和鼓励评论!

public class LocationListJsonConverter : JsonConverter
{
    public override bool CanConvert(System.Type objectType)
    {
        return objectType == typeof(LocationList);
    }
    public override object ReadJson(JsonReader reader, System.Type objectType, object existingValue, JsonSerializer serializer)
    {
        var locationList = (existingValue as LocationList) ?? new LocationList();
        var jLocationList = JObject.ReadFrom(reader);
        locationList.IsExpanded = (bool)(jLocationList["IsExpanded"] ?? false);
        var jLocations = jLocationList["_Items"];
        if(jLocations != null)
        {
            foreach(var jLocation in jLocations)
            {
                var location = serializer.Deserialize<Location>(new JTokenReader(jLocation));
                locationList.Add(location);
            }
        }
        return locationList;
    }
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var locationList = value as LocationList;
        JObject jLocationList = new JObject();
        if(locationList.IsExpanded)
            jLocationList.Add("IsExpanded", true);
        if(locationList.Count > 0)
        {
            var jLocations = new JArray();
            foreach(var location in locationList)
            {
                jLocations.Add(JObject.FromObject(location, serializer));
            }
            jLocationList.Add("_Items", jLocations);
        }
        jLocationList.WriteTo(writer);
    }
}

我需要一个名为FieldGroup的类，它也有一些属性来分组一些字段。我首先是这样做的。

public class FieldGroup : List<Field>{ ... }

有连载的问题。所以我像下面这样修改了这个类。所以我可以处理它，就像从List派生的类*FieldGroup一样。

public class FieldGroup : IPrintable, IEnumerable<Field>
{
    public PrintFormat GroupFormat { get; set; } = new PrintFormat();
    public List<Field> Fields { get; set; } = new List<Field>();
    public Field this[int index]
    {
        get => Fields[index];
        set => Fields[index] = value;
    }
    public void Add(Field field)
    {
        Fields.Add(field);
    }
    public IEnumerator<Field> GetEnumerator()
    {
        return new FieldEnumerator(Fields);
    }
    IEnumerator IEnumerable.GetEnumerator()
    {
        return GetEnumerator();
    }
    ...
}
相关文章：