JSON.NET serialize JObject while ignoring null properties

by

You can use a recursive helper method like the one below to remove the null values from your JToken hierarchy prior to serializing it.

using System;
using Newtonsoft.Json.Linq;

public static class JsonHelper
{
    public static JToken RemoveEmptyChildren(JToken token)
    {
        if (token.Type == JTokenType.Object)
        {
            JObject copy = new JObject();
            foreach (JProperty prop in token.Children<JProperty>())
            {
                JToken child = prop.Value;
                if (child.HasValues)
                {
                    child = RemoveEmptyChildren(child);
                }
                if (!IsEmpty(child))
                {
                    copy.Add(prop.Name, child);
                }
            }
            return copy;
        }
        else if (token.Type == JTokenType.Array)
        {
            JArray copy = new JArray();
            foreach (JToken item in token.Children())
            {
                JToken child = item;
                if (child.HasValues)
                {
                    child = RemoveEmptyChildren(child);
                }
                if (!IsEmpty(child))
                {
                    copy.Add(child);
                }
            }
            return copy;
        }
        return token;
    }

    public static bool IsEmpty(JToken token)
    {
        return (token.Type == JTokenType.Null);
    }
}

Demo:

string json = @"
{
    ""Foo"": {
        ""P1"": null,
        ""P2"": ""hello world"",
        ""P3"": null,
        ""P4"": {
            ""P1"": 1,
            ""P2"": null,
            ""P3"": null
        },
        ""FooArray"": [
            {
                ""F1"": null,
                ""F2"": null,
                ""F3"": null
            }
        ]
    },
    ""Bar"": null
}";

JToken token = JsonHelper.RemoveEmptyChildren(JToken.Parse(json));
Console.WriteLine(token.ToString(Formatting.Indented));

Output: 

{
  "Foo": {
    "P2": "hello world",
    "P4": {
      "P1": 1
    },
    "FooArray": [
      {}
    ]
  }
}

Fiddle: https://dotnetfiddle.net/wzEOie

Notice that, after removing all null values, you will have an empty object in the FooArray, which you may not want. (And if that object were removed, then you’d have an empty FooArray, which you also may not want.) If you want to make the helper method more aggressive in its removal, you can change the IsEmpty function to this:

    public static bool IsEmpty(JToken token)
    {
        return (token.Type == JTokenType.Null) ||
               (token.Type == JTokenType.Array && !token.HasValues) ||
               (token.Type == JTokenType.Object && !token.HasValues);
    }

With that change in place, your output would look like this instead:

{
  "Foo": {
    "P2": "hello world",
    "P4": {
      "P1": 1
    }
  }
}

Fiddle: https://dotnetfiddle.net/ZdYogJ

More Related Contents:

  1. parse JSON using json.net c# [closed]
  2. How can I parse JSON with C#?
  3. Deserializing JSON data to C# using JSON.NET
  4. Can I specify a path in an attribute to map a property in my class to a child property in my JSON?
  5. Casting interfaces for deserialization in JSON.NET
  6. How to show the “paste Json class” in visual studio 2012 when clicking on Paste Special?
  7. “Self Referencing Loop Detected” exception with JSON.Net
  8. Unexpected character encountered while parsing value
  9. Deserialize json array stream one item at a time
  10. Order of serialized fields using JSON.NET
  11. Json.NET serialize object with root name
  12. How to Deserialize JSON data?
  13. How do I enumerate through a JObject?
  14. How to make JSON.Net serializer to call ToString() when serializing a particular type?
  15. Newtonsoft Json.Net serialize JObject doesn’t ignore nulls, even with the right settings
  16. JSON.net serialize directly from oledbconnection
  17. multiple JsonProperty Name assigned to single property
  18. Json.NET custom serialization with JsonConverter – how to get the “default” behavior
  19. Send JSON via POST in C# and Receive the JSON returned?
  20. Deserializing heterogenous JSON array into covariant List using Json.NET
  21. JSON deserialization – Map array indices to properties with JSON.NET
  22. Deserialize json object with dynamic items in C#
  23. Deserialize specific enum into system.enum in Json.Net
  24. Force JsonConvert.SerializeXmlNode to serialize node value as an Integer or a Boolean
  25. json net leading zeros (disable base-cast)
  26. Deserializing JSON into an object with Json.NET
  27. Null-coalescing operator returning null for properties of dynamic objects
  28. Is there a way in Json.NET serialization to distinguish between “null because not present” and “null because null”?
  29. NewtonSoft.Json Serialize and Deserialize class with property of type IEnumerable
  30. Json.net serialization of custom collection implementing IEnumerable

Leave a Comment