¿Puede JavaScriptSerializer excluir propiedades con valores nulos/predeterminados?

Question

Estoy usando JavaScriptSerializer para serializar algunos objetos de entidad.

El problema es que muchas de las propiedades públicas contienen valores nulos o predeterminados. ¿Hay alguna manera de hacer que JavaScriptSerializer excluya las propiedades con valores nulos o predeterminados?

Me gustaría que el JSON resultante sea menos detallado.

Answer 1

La solución que funcionó para mí:

La clase y las propiedades serializado se pueden decorar de la siguiente manera:

[DataContract] 
public class MyDataClass 
{ 
    [DataMember(Name = "LabelInJson", IsRequired = false)] 
    public string MyProperty { get; set; } 
} 

isRequired fue el elemento clave.

La serialización real podría hacerse utilizando DataContractJsonSerializer:

public static string Serialize<T>(T obj) 
{ 
    string returnVal = ""; 
    try 
    { 
    DataContractJsonSerializer serializer = new DataContractJsonSerializer(obj.GetType()); 
    using (MemoryStream ms = new MemoryStream()) 
    { 
     serializer.WriteObject(ms, obj); 
     returnVal = Encoding.Default.GetString(ms.ToArray()); 
    } 
    } 
    catch (Exception /*exception*/) 
    { 
    returnVal = ""; 
    //log error 
    } 
    return returnVal; 
} 

Answer 2

Puede implementar un JavaScriptConverter y registrarlo utilizando el método RegisterConverters de JavaScriptSerializer.

Answer 3

Json.NET tiene opciones para excluir automáticamente los valores nulos o predeterminados.

Answer 4

FYI, si desea seguir con la solución más fácil, esto es lo que solía lograr esto usando una aplicación JavaScriptConverter con el JavaScriptSerializer:

private class NullPropertiesConverter : JavaScriptConverter 
    { 
     public override object Deserialize(IDictionary<string, object> dictionary, Type type, JavaScriptSerializer serializer) 
     { 
      throw new NotImplementedException(); 
     } 

     public override IDictionary<string, object> Serialize(object obj, JavaScriptSerializer serializer) 
     { 
      var jsonExample = new Dictionary<string, object>(); 
      foreach (var prop in obj.GetType().GetProperties()) 
      { 
       //check if decorated with ScriptIgnore attribute 
       bool ignoreProp = prop.IsDefined(typeof(ScriptIgnoreAttribute), true); 

       var value = prop.GetValue(obj, BindingFlags.Public, null, null, null); 
       if (value != null && !ignoreProp) 
        jsonExample.Add(prop.Name, value); 
      } 

      return jsonExample; 
     } 

     public override IEnumerable<Type> SupportedTypes 
     { 
      get { return GetType().Assembly.GetTypes(); } 
     } 
    } 

y luego se usa:

var serializer = new JavaScriptSerializer(); 
    serializer.RegisterConverters(new JavaScriptConverter[] { new NullPropertiesConverter() }); 
    return serializer.Serialize(someObjectToSerialize); 

Answer 5

Sin cambiar toe DataContractSerializer

Puede utilizar ScriptIgnoreAttribute

[1] http://msdn.microsoft.com/en-us/library/system.web.script.serialization.scriptignoreattribute.aspx

Answer 6

Este código es el bloqueo nulo y predeterminado (0) valores para los tipos numéricos

private class NullPropertiesConverter : JavaScriptConverter 
    { 
     public override object Deserialize(IDictionary<string, object> dictionary, Type type, JavaScriptSerializer serializer) 
     { 
      throw new NotImplementedException(); 
     } 

     public override IDictionary<string, object> Serialize(object obj, JavaScriptSerializer serializer) 
     { 
      var jsonExample = new Dictionary<string, object>(); 
      foreach (var prop in obj.GetType().GetProperties()) 
      { 
       //this object is nullable 
       var nullableobj = prop.PropertyType.IsGenericType && prop.PropertyType.GetGenericTypeDefinition() == typeof(Nullable<>); 
       //check if decorated with ScriptIgnore attribute 
       bool ignoreProp = prop.IsDefined(typeof(ScriptIgnoreAttribute), true); 

       var value = prop.GetValue(obj, System.Reflection.BindingFlags.Public, null, null, null); 
       int i; 
       //Object is not nullable and value=0 , it is a default value for numeric types 
       if (!(nullableobj == false && value != null && (int.TryParse(value.ToString(), out i) ? i : 1) == 0) && value != null && !ignoreProp) 
        jsonExample.Add(prop.Name, value); 
      } 

      return jsonExample; 
     } 

     public override IEnumerable<Type> SupportedTypes 
     { 
      get { return GetType().Assembly.GetTypes(); } 
     } 
    } 

Answer 7

Para el beneficio de Aquellos que encuentran esto en google, notan que los nulos pueden omitirse de forma nativa durante la serialización con Newtonsoft.Json

var json = JsonConvert.SerializeObject(
      objectToSerialize, 
      new JsonSerializerSettings {NullValueHandling = NullValueHandling.Ignore});