当List<T>属性为Null或Count=0时的序列化问题及相关类定义
处理List属性为Null或Count=0时的序列化问题
首先先把你的类代码补全并格式化一下,方便后续说明:
public class EncuestaRespuesta { public string idCaso { get; set; } public string tipoEncuesta { get; set; } public string codMovimiento { get; set; } public string motivoRetirada { get; set; } public string duracion { get; set; } public DateTime fechaHora { get; set; } public string gestor { get; set; } public List<RespuestasEncuesta> listRespuestasEncuestas { get; set;} } public class RespuestasEncuesta { public string pregunta { get; set; } public string respuesta { get; set; } }
接下来分两种最常用的序列化库给出针对性解决方案:
一、使用Newtonsoft.Json(Json.NET)
这是.NET生态里最流行的第三方序列化库,不同场景的处理方式如下:
1. 仅忽略Null的列表(空列表仍序列化为[])
直接给listRespuestasEncuestas属性添加特性,指定Null值不参与序列化:
public class EncuestaRespuesta { // 其他属性... [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public List<RespuestasEncuesta> listRespuestasEncuestas { get; set;} }
这样当列表为null时,JSON中不会出现这个属性;如果是空列表(Count=0),会正常序列化为[]。
2. 同时忽略Null和空列表
如果你希望不管是null还是空列表,都不在JSON中输出这个属性,需要用JsonIgnore特性配合JsonIgnoreCondition(需Newtonsoft.Json 12.0及以上版本):
public class EncuestaRespuesta { // 其他属性... [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull | JsonIgnoreCondition.WhenWritingEmpty)] public List<RespuestasEncuesta> listRespuestasEncuestas { get; set;} }
如果你的Json.NET版本较低,可以自定义合约解析器实现相同效果:
public class IgnoreEmptyCollectionsResolver : DefaultContractResolver { protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization) { JsonProperty property = base.CreateProperty(member, memberSerialization); // 判断属性是否为集合类型(排除string) if (property.PropertyType != typeof(string) && typeof(IEnumerable).IsAssignableFrom(property.PropertyType)) { property.ShouldSerialize = instance => { IEnumerable collection = instance.GetType().GetProperty(property.PropertyName).GetValue(instance) as IEnumerable; // 仅当集合不为null且有元素时才序列化 return collection != null && collection.GetEnumerator().MoveNext(); }; } return property; } }
序列化时使用这个解析器:
var settings = new JsonSerializerSettings { ContractResolver = new IgnoreEmptyCollectionsResolver(), NullValueHandling = NullValueHandling.Ignore }; string json = JsonConvert.SerializeObject(yourEncuestaInstance, settings);
3. 将Null列表序列化为空数组
如果希望null的列表也序列化为[]而不是忽略,最简单的方式是在类的构造函数中初始化列表:
public class EncuestaRespuesta { public EncuestaRespuesta() { // 初始化列表为空集合 listRespuestasEncuestas = new List<RespuestasEncuesta>(); } // 其他属性... public List<RespuestasEncuesta> listRespuestasEncuestas { get; set;} }
这样不管有没有给列表赋值,它都不会是null,空状态下自然会序列化为[]。
二、使用System.Text.Json(.NET Core 3.0+ / .NET 5+ 自带)
如果你的项目用的是.NET自带的System.Text.Json,处理方式如下:
1. 仅忽略Null的列表
给属性添加JsonIgnore特性,指定仅当值为Null时忽略:
public class EncuestaRespuesta { // 其他属性... [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] public List<RespuestasEncuesta> listRespuestasEncuestas { get; set;} }
2. 同时忽略Null和空列表
同样用JsonIgnore特性,同时指定忽略Null和空集合:
public class EncuestaRespuesta { // 其他属性... [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull | JsonIgnoreCondition.WhenWritingEmpty)] public List<RespuestasEncuesta> listRespuestasEncuestas { get; set;} }
也可以全局配置这个规则,作用于所有序列化对象:
var options = new JsonSerializerOptions { DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull | JsonIgnoreCondition.WhenWritingEmpty }; string json = JsonSerializer.Serialize(yourEncuestaInstance, options);
3. 将Null列表序列化为空数组
和Newtonsoft.Json的方式一致,在构造函数中初始化列表即可,无需额外配置。
内容的提问来源于stack exchange,提问作者Kiquenet
相关产品推荐
相关产品推荐

