JavaScriptSerializer 可以排除具有空值/默认值的属性吗？

Posted 2023-03-31

【中文标题】JavaScriptSerializer 可以排除具有空值/默认值的属性吗？

【英文标题】：Can JavaScriptSerializer exclude properties with null/default values?

【发布时间】：2010-11-26 03:25:58

【问题描述】：

我正在使用 javascriptSerializer 序列化一些实体对象。

问题是，许多公共属性包含空值或默认值。有没有办法让 JavaScriptSerializer 排除具有 null 或默认值的属性？

我希望生成的 JSON 不那么冗长。

【参考方案1】：

仅供参考，如果您想使用更简单的解决方案，以下是我使用带有 JavaScriptSerializer 的 JavaScriptConverter 实现来完成此操作的方法：

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);

【讨论】：

应该指出，如果你也想要字段，代码就丢失了

如果你想知道前面的评论在说什么：***.com/questions/295104/…

您也可以通过首先检查 ignoreProp 并且不获取值，除非它为 false 来稍微加快速度。

很好的解决方案！如果您没有得到任何结果，请记住在您的对象属性上使用 get;set; 以便反射以在 GetProperties() 中返回它们，

【参考方案2】：

对我有用的解决方案：

序列化的类和属性将被修饰如下：

[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;

【讨论】：

对于 DataContractJsonSerializer，您需要在 DataMember 上将 EmitDefaultValue 设置为 false

这看起来很有趣，但需要更多解释，特别是第一个代码

【参考方案3】：

为了那些在 google 上找到这个的人的利益，请注意，在使用 Newtonsoft.Json 进行序列化期间可以原生跳过空值

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

【参考方案4】：

你可以实现一个JavaScriptConverter并使用JavaScriptSerializer的RegisterConverters方法注册它。

【参考方案5】：

Json.NET 具有自动排除空值或默认值的选项。

【讨论】：

OP 询问的是 JavaScriptSerializer，而不是 json.net。

@JustinR。看起来他是 Json.NET 的作者，这可能就是原因

【参考方案6】：

此代码是数字类型的块 null 和默认 (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();
  
 

【参考方案7】：

不改变toe DataContractSerializer

你可以使用 ScriptIgnoreAttribute

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

【讨论】：

ScriptIgnore 如果您想始终忽略某个属性，则很有用，但如果您只想忽略具有空值的属性但如果它们具有实值则包含它们，则不适用。