Serializing null in JSON.NET

by

Okay, I think I’ve come up with a solution (my first solution wasn’t right at all, but then again I was on the train). You need to create a special contract resolver and a custom ValueProvider for Nullable types. Consider this:

public class NullableValueProvider : IValueProvider
{
    private readonly object _defaultValue;
    private readonly IValueProvider _underlyingValueProvider;


    public NullableValueProvider(MemberInfo memberInfo, Type underlyingType)
    {
        _underlyingValueProvider = new DynamicValueProvider(memberInfo);
        _defaultValue = Activator.CreateInstance(underlyingType);
    }

    public void SetValue(object target, object value)
    {
        _underlyingValueProvider.SetValue(target, value);
    }

    public object GetValue(object target)
    {
        return _underlyingValueProvider.GetValue(target) ?? _defaultValue;
    }
}

public class SpecialContractResolver : DefaultContractResolver
{
    protected override IValueProvider CreateMemberValueProvider(MemberInfo member)
    {
        if(member.MemberType == MemberTypes.Property)
        {
            var pi = (PropertyInfo) member;
            if (pi.PropertyType.IsGenericType && pi.PropertyType.GetGenericTypeDefinition() == typeof (Nullable<>))
            {
                return new NullableValueProvider(member, pi.PropertyType.GetGenericArguments().First());
            }
        }
        else if(member.MemberType == MemberTypes.Field)
        {
            var fi = (FieldInfo) member;
            if(fi.FieldType.IsGenericType && fi.FieldType.GetGenericTypeDefinition() == typeof(Nullable<>))
                return new NullableValueProvider(member, fi.FieldType.GetGenericArguments().First());
        }

        return base.CreateMemberValueProvider(member);
    }
}

Then I tested it using:

class Foo
{
    public int? Int { get; set; }
    public bool? Boolean { get; set; }
    public int? IntField;
}

And the following case:

[TestFixture]
public class Tests
{
    [Test]
    public void Test()
    {
        var foo = new Foo();

        var settings = new JsonSerializerSettings { ContractResolver = new SpecialContractResolver() };

        Assert.AreEqual(
            JsonConvert.SerializeObject(foo, Formatting.None, settings), 
            "{\"IntField\":0,\"Int\":0,\"Boolean\":false}");
    }
}

Hopefully this helps a bit…

Edit – Better identification of the a Nullable<> type

Edit – Added support for fields as well as properties, also piggy-backing on top of the normal DynamicValueProvider to do most of the work, with updated test

More Related Contents:

  1. How to deserialize an array of values with a fixed schema to a strongly typed data class?
  2. Detect if deserialized object is missing a field with the JsonConvert class in Json.NET
  3. How to serialize/deserialize a custom collection with additional properties using Json.Net
  4. Custom Deserialization using Json.NET
  5. Cannot deserialize JSON array into type – Json.NET
  6. How to apply indenting serialization only to some properties?
  7. Ignoring null fields in Json.net
  8. Deserializing JSON into an object with Json.NET
  9. How do you do a deep copy of an object in .NET? [duplicate]
  10. Deserializing polymorphic json classes without type information using json.net
  11. Casting interfaces for deserialization in JSON.NET
  12. Serialize Class containing Dictionary member
  13. “Self Referencing Loop Detected” exception with JSON.Net
  14. How can I encrypt selected properties when serializing my objects?
  15. Fast and compact object serialization in .NET
  16. Converting newtonsoft code to System.Text.Json in .net core 3. what’s equivalent of JObject.Parse and JsonProperty
  17. How do you find out when you’ve been loaded via XML Serialization?
  18. Using JSON.NET to return ActionResult [duplicate]
  19. How to make JSON.Net serializer to call ToString() when serializing a particular type?
  20. How can I ignore a property when serializing using the DataContractSerializer?
  21. Json.NET custom serialization with JsonConverter – how to get the “default” behavior
  22. Send JSON via POST in C# and Receive the JSON returned?
  23. Checking if an object is a number in C#
  24. Using JSON.net, how do I prevent serializing properties of a derived class, when used in a base class context?
  25. How to apply ObjectCreationHandling.Replace to selected properties when deserializing JSON?
  26. Json.NET serialize by depth and attribute
  27. How to serialize an Exception object in C#?
  28. Can JavaScriptSerializer exclude properties with null/default values?
  29. How do I get formatted and indented JSON in .NET using C#?
  30. Configure Json.NET serialization settings on a class level

Leave a Comment