web-dev-qa-db-ja.com

JavaScriptSerializerはnull /デフォルト値のプロパティを除外できますか？

JavaScriptSerializerを使用して、一部のエンティティオブジェクトをシリアル化しています。

問題は、パブリックプロパティの多くにnullまたはデフォルト値が含まれていることです。 JavaScriptSerializerにnullまたはデフォルト値のプロパティを除外させる方法はありますか？

結果のJSONが冗長にならないようにしたいと思います。

c#.netjsonserializationjavascriptserializer
37
frankadelic

私のために働いた解決策：

シリアル化されたクラスとプロパティは、次のように装飾されます。

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

IsRequiredが重要なアイテムでした。

実際のシリアル化は、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;
}
14
frankadelic

参考までに、より簡単なソリューションを使いたい場合は、JavaScriptConverter実装と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();
  }
 }
}

そしてそれを使うには：

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

Json.NET には、nullまたはデフォルト値を自動的に除外するオプションがあります。

5
James Newton-King

JavaScriptConverter を実装し、RegisterConvertersの-​​ JavaScriptSerializer メソッドを使用して登録できます。

4
Vinay Sajip

Googleでこれを見つけた人のために、Newtonsoft.Jsonを使用したシリアル化中にnullをネイティブにスキップできることに注意してください。

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

このコードは、数値型のnullおよびdefault（0）値をブロックします

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();
  }
 }
}
1
Ali B.

つま先を変更せずにDataContractSerializer

ScriptIgnoreAttributeを使用できます

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

0
Sameer