我如何使json.net序列化从列表< t>的班级成员

Question

i创建了一个类PagedResult<T> : List<T>，其中包含一些添加的成员，以便与我们的一个组件一起使用。但是，当我运行JSON DESERIALIZER时，它只会将列表序列序列。如果我用[JsonObject]和[JsonProperty]标记派生类，则它将仅序列化派生类的成员而不是列表。我如何获得两者？

Answer 1

默认情况下，json.net将把实现IEnumerable作为数组的任何类都视为。您可以通过使用[JsonObject]属性来装饰课程来覆盖此行为，但是如您所见，只有对象属性才能序列化。该列表本身不会被序列化，因为它不是通过公共财产暴露的（而不是通过GetEnumerator()方法暴露）。

如果您愿意，可以按照@konrad的建议，并在派生类上提供公共财产以揭示列表，或者可以编写自定义的JsonConverter来序列化整个过程，如您所见。后一种方法的示例如下。

假设您的PagedResult<T>类看起来像这样：

class PagedResult<T> : List<T>
{
    public int PageSize { get; set; }
    public int PageIndex { get; set; }
    public int TotalItems { get; set; }
    public int TotalPages { get; set; }
}

您可以这样做一个转换器：

class PagedResultConverter<T> : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return (objectType == typeof(PagedResult<T>));
    }
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        PagedResult<T> result = (PagedResult<T>)value;
        JObject jo = new JObject();
        jo.Add("PageSize", result.PageSize);
        jo.Add("PageIndex", result.PageIndex);
        jo.Add("TotalItems", result.TotalItems);
        jo.Add("TotalPages", result.TotalPages);
        jo.Add("Items", JArray.FromObject(result.ToArray(), serializer));
        jo.WriteTo(writer);
    }
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        JObject jo = JObject.Load(reader);
        PagedResult<T> result = new PagedResult<T>();
        result.PageSize = (int)jo["PageSize"];
        result.PageIndex = (int)jo["PageIndex"];
        result.TotalItems = (int)jo["TotalItems"];
        result.TotalPages = (int)jo["TotalPages"];
        result.AddRange(jo["Items"].ToObject<T[]>(serializer));
        return result;
    }
}

（还请注意，这种方法不需要[JsonObject]和[JsonProperty]属性，因为有关序列化的知识已封装在转换器类中。）

这是一个演示，显示了动作中的转换器：

class Program
{
    static void Main(string[] args)
    {
        PagedResult<string> result = new PagedResult<string> { "foo", "bar", "baz" };
        result.PageIndex = 0;
        result.PageSize = 10;
        result.TotalItems = 3;
        result.TotalPages = 1;
        JsonSerializerSettings settings = new JsonSerializerSettings();
        settings.Converters.Add(new PagedResultConverter<string>());
        settings.Formatting = Formatting.Indented;
        string json = JsonConvert.SerializeObject(result, settings);
        Console.WriteLine(json);
    }
}

输出：

{
  "PageSize": 10,
  "PageIndex": 0,
  "TotalItems": 3,
  "TotalPages": 1,
  "Items": [
    "foo",
    "bar",
    "baz"
  ]
}

Answer 2

我想到的最简单的解决方法是将内部元素公开为派生类的另一属性：

[JsonProperty]
public IEnumerable<T> Elements {
    get 
    { 
       return this; 
    }
}

Answer 3

如果您不想编写自定义JsonConverter或使用JSON属性（JSONObjectAttribute），则可以简单地使用扩展方法：

class PagedResult<T> : List<T>
{
    public int PageSize { get; set; }
    public int PageIndex { get; set; }
    public int TotalItems { get; set; }
    public int TotalPages { get; set; }
}
public static class Extensions
{
    public static string ToPagedJson<T>(this PagedResult<T> pagedResult)
    {
         return JsonConvert.SerializeObject(new
         {
             PageSize = pagedResult.PageSize,
             PageIndex = pagedResult.PageIndex,
             TotalItems = pagedResult.TotalItems,
             TotalPages = pagedResult.TotalPages
             Items = pagedResult
         });
    }
}