How to force Newtonsoft Json to serialize all properties? (Strange behavior with “Specified” property)

by

This behavior is mentioned, very briefly, in the Json.NET 4.0.1 release notes: New feature – Added XmlSerializer style Specified property support. The XmlSerializer functionality is in turn described in MinOccurs Attribute Binding Support:

[For optional fields] Xsd.exe generates a public field of type bool whose name is the element field’s name with Specified appended. For example, if the element field’s name is startDate, the bool field’s name becomes startDateSpecified. When serializing an object to XML, the XmlSerializer class checks the value of the bool field to determine whether to write the element.

I feel as though this functionality should be documented here, but is not. You might want to open a documentation issue with Newtonsoft.

Since you don’t want this behavior, if you are using Json.NET 11.0.1 or later, you can disable it for all classes by instantiating your own DefaultContractResolver and settting DefaultContractResolver.IgnoreIsSpecifiedMembers = true:

public static class JsonContractResolvers
{
    // Newtonsoft recommends caching and reusing contract resolvers for best performance:
    // https://www.newtonsoft.com/json/help/html/Performance.htm#ReuseContractResolver
    // But be sure not to modify IgnoreIsSpecifiedMembers after the contract resolver is first used to generate a contract.

    public static readonly DefaultContractResolver IgnoreIsSpecifiedMembersResolver =
        new DefaultContractResolver { IgnoreIsSpecifiedMembers = true };
}

Then pass it to JsonConvert as follows:

var settings = new JsonSerializerSettings { ContractResolver = JsonContractResolvers.IgnoreIsSpecifiedMembersResolver };
var json = JsonConvert.SerializeObject(testObject, Formatting.Indented, settings);

Or to create a JToken do:

var jToken = JToken.FromObject(testObject, JsonSerializer.CreateDefault(settings));

If you are using an earlier version, you will need to create and cache a custom contract resolver:

public static class JsonContractResolvers
{
    public static readonly DefaultContractResolver IgnoreIsSpecifiedMembersResolver =
        new IgnoreSpecifiedContractResolver();
}

internal class IgnoreSpecifiedContractResolver : DefaultContractResolver
{
    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        var property = base.CreateProperty(member, memberSerialization);
        property.GetIsSpecified = null;
        property.SetIsSpecified = null;
        return property;
    }
}

More Related Contents:

  1. TypeNameHandling caution in Newtonsoft Json
  2. JSON.NET Error Self referencing loop detected for type
  3. Does Json.NET cache types’ serialization information?
  4. Cannot deserialize the JSON array (e.g. [1,2,3]) into type ‘ ‘ because type requires JSON object (e.g. {“name”:”value”}) to deserialize correctly
  5. How to deserialize an array of values with a fixed schema to a strongly typed data class?
  6. Json.Net Serialization of Type with Polymorphic Child Object
  7. Detect if deserialized object is missing a field with the JsonConvert class in Json.NET
  8. Json.net serialize/deserialize derived types?
  9. How to ignore JsonProperty(PropertyName = “someName”) when serializing json?
  10. Json.Net: Serialize/Deserialize property as a value, not as an object
  11. Exclude property from serialization via custom attribute (json.net)
  12. Newtonsoft.JSON cannot convert model with TypeConverter attribute
  13. How to serialize/deserialize a custom collection with additional properties using Json.Net
  14. Not ableTo Serialize Dictionary with Complex key using Json.net
  15. JSON.NET Parser *seems* to be double serializing my objects
  16. Custom Deserialization using Json.NET
  17. JSON.Net Self referencing loop detected
  18. Serialize Property, but Do Not Deserialize Property in Json.Net
  19. Force JSON.NET to include milliseconds when serializing DateTime (even if ms component is zero)
  20. Can Newtonsoft Json.NET skip serializing empty lists?
  21. Serializing null in JSON.NET
  22. Cannot deserialize the current JSON array (e.g. [1,2,3])
  23. Ignoring null fields in Json.net
  24. Repeated serialization and deserialization creates duplicate items
  25. Serializing an interface/abstract object using NewtonSoft.JSON
  26. Json.NET: Deserializing nested dictionaries
  27. JSonNet boolean serialization
  28. Json.net deserialization null guid case
  29. Configure Json.NET serialization settings on a class level
  30. JSON.NET Serializes Empty JSON

Leave a Comment