Question

我创建了一个类PagedResult<T> : List<T>，其中包含一些已添加的成员，以便使用我们的某个组件。但是，当我运行json反序列化器时，它只序列化列表。如果我用[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
         });
    }
}

如何让json.net序列化从List <t>？</t>派生的类的成员

3 个答案: