Exclude property from serialization via custom attribute (json.net)

by

Here’s a generic reusable “ignore property” resolver based on the accepted answer:

/// <summary>
/// Special JsonConvert resolver that allows you to ignore properties.  See https://stackoverflow.com/a/13588192/1037948
/// </summary>
public class IgnorableSerializerContractResolver : DefaultContractResolver {
    protected readonly Dictionary<Type, HashSet<string>> Ignores;

    public IgnorableSerializerContractResolver() {
        this.Ignores = new Dictionary<Type, HashSet<string>>();
    }

    /// <summary>
    /// Explicitly ignore the given property(s) for the given type
    /// </summary>
    /// <param name="type"></param>
    /// <param name="propertyName">one or more properties to ignore.  Leave empty to ignore the type entirely.</param>
    public void Ignore(Type type, params string[] propertyName) {
        // start bucket if DNE
        if (!this.Ignores.ContainsKey(type)) this.Ignores[type] = new HashSet<string>();

        foreach (var prop in propertyName) {
            this.Ignores[type].Add(prop);
        }
    }

    /// <summary>
    /// Is the given property for the given type ignored?
    /// </summary>
    /// <param name="type"></param>
    /// <param name="propertyName"></param>
    /// <returns></returns>
    public bool IsIgnored(Type type, string propertyName) {
        if (!this.Ignores.ContainsKey(type)) return false;

        // if no properties provided, ignore the type entirely
        if (this.Ignores[type].Count == 0) return true;

        return this.Ignores[type].Contains(propertyName);
    }

    /// <summary>
    /// The decision logic goes here
    /// </summary>
    /// <param name="member"></param>
    /// <param name="memberSerialization"></param>
    /// <returns></returns>
    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization) {
        JsonProperty property = base.CreateProperty(member, memberSerialization);

        if (this.IsIgnored(property.DeclaringType, property.PropertyName)
        // need to check basetype as well for EF -- @per comment by user576838
        || this.IsIgnored(property.DeclaringType.BaseType, property.PropertyName)) {
            property.ShouldSerialize = instance => { return false; };
        }

        return property;
    }
}

And usage:

var jsonResolver = new IgnorableSerializerContractResolver();
// ignore single property
jsonResolver.Ignore(typeof(Company), "WebSites");
// ignore single datatype
jsonResolver.Ignore(typeof(System.Data.Objects.DataClasses.EntityObject));
var jsonSettings = new JsonSerializerSettings() { ReferenceLoopHandling = ReferenceLoopHandling.Ignore, ContractResolver = jsonResolver };

More Related Contents:

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

Leave a Comment