有没有办法对 List的子类进行 JSON.NET 序列化？那还有额外的属性吗？

Question

好的，我们正在使用 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 的子类，而只是一个具有名为 Items 属性的常规对象。改为 List 类型。

{
  "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 在他们的序列化器中本地滚动这样的东西！

也就是说...有人知道如何自定义序列化器/反序列化器以不同方式处理该对象吗？

中号

Answer 1

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

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

Answer 2

好吧...这就是我的想法。我必须编写自己的 JsonConverter。我基本上使用它来创建一个内联 JObject，该 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);

    }

}

Answer 3

我需要一个名为 FieldGroup 的类，该类还具有一些属性来对某些字段进行分组。我首先是这样做的。

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

正如帖子所说，序列化有问题。 所以我修改了该类，如下所示。因此我可以像从 List< 派生的 *FieldGroup 类一样处理它。 /strong>。

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

    ...
}