JSON serialize properties on class inheriting list [duplicate]

by

Your basic difficulty here is that JSON has two types of container: an object, and an array. From the standard:

  • An array is an ordered collection of values. An array begins with [ (left bracket) and ends with ] (right bracket). Values are separated by , (comma).

  • An object is an unordered set of name/value pairs. An object begins with { (left brace) and ends with } (right brace).

To force a collection’s properties to be serialized, mark it with [JsonObject]:

[JsonObject]
public class TestResultListModel : List<TestResultModel>
{
    public int TotalTestCases { get { return base.Count; } }

    public int TotalSuccessful { get { return base.FindAll(t => t.Successful).Count; } }
}

Of course, if you do this, the items will not be serialized, because a JSON container can have properties, or items — but not both. If you want both, you will need to add a synthetic array property to hold the items — which can be private if you want.

[JsonObject] will also cause base class properties such as Capacity to be serialized, which you likely do not want. To suppress base class properties, use MemberSerialization.OptIn. Thus your final class should look something like:

[JsonObject(MemberSerialization = MemberSerialization.OptIn)]
public class TestResultListModel : List<TestResultModel>
{
    [JsonProperty]
    public int TotalTestCases { get { return base.Count; } }

    [JsonProperty]
    // Using Enumerable.Count() is more memory efficient than List.FindAll()
    public int TotalSuccessful { get { return this.Count(t => t.Successful); } }

    [JsonProperty]
    TestResultModel[] Items
    {
        get
        {
            return this.ToArray();
        }
        set
        {
            if (value != null)
                this.AddRange(value);
        }
    }
}

This gives JSON that looks like:

{
  "TotalTestCases": 4,
  "TotalSuccessful": 2,
  "Items": [
    {
      "Successful": false,
      "ErrorMessage": "STRING"
    },
    {
      "Successful": true,
      "ErrorMessage": "STRING"
    },
    {
      "Successful": false,
      "ErrorMessage": "STRING"
    },
    {
      "Successful": true,
      "ErrorMessage": "STRING"
    }
  ]
}

It is possibly more work than it’s worth, since these properties could be reconstructed easily on the client side. (The question Why not inherit from List? suggests avoiding this sort of design.)

More Related Contents:

  1. How to write a JSON file in C#?
  2. What is the difference between PreserveReferencesHandling and ReferenceLoopHandling in Json.Net?
  3. Set default global json serializer settings
  4. JSON Deserialization – String Is Automatically Converted To Int
  5. Is there a way in Json.NET serialization to distinguish between “null because not present” and “null because null”?
  6. Create a strongly typed c# object from json object with ID as the name
  7. JSON.Net throws StackOverflowException when using [JsonConvert()]
  8. How to parse huge JSON file as stream in Json.NET?
  9. Searching for a specific JToken by name in a JObject hierarchy
  10. Unexpected character encountered while parsing value
  11. Parsing JSON Object with variable properties into strongly typed object
  12. Order of serialized fields using JSON.NET
  13. Json.NET serialize object with root name
  14. Deserialize nested JSON into C# objects
  15. Serialize Property, but Do Not Deserialize Property in Json.Net
  16. Self referencing loop detected – Getting back data from WebApi to the browser
  17. Selectively use default JSON converter
  18. Why are some members missing when trying to print an object by serializing to JSON?
  19. Cannot deserialize JSON array into type – Json.NET
  20. Newtonsoft Json Deserialize Dictionary as Key/Value list from DataContractJsonSerializer
  21. Repeated serialization and deserialization creates duplicate items
  22. How do you Add or Update a JProperty Value in a JObject
  23. Modify existing object with new partial JSON data using Json.NET
  24. Accessing properties with a dot in their name
  25. json deserialize from legacy property names
  26. Load multiple concatenated JSON objects from stream
  27. ASP.NET Core API only returning first result of list
  28. Json.NET JSONPath query not returning expected results
  29. Streaming large list of data as JSON format using Json.net
  30. Web API complex parameter properties are all null

Leave a Comment