12月21日，车评人@陈震同学的小红书、B站等平台账号恢复正常，没有违规、封禁等标识，账号的关注、留言等功能也恢复正常，但暂时没发布新内容。 但其微博...
2025-12-22 2
.NET Core 处理 WebAPI JSON 返回烦人的null为空
火币pro官网下载
2022年10月21日 11:01 96
Connor
（给DotNet加星标，提升.Net技能）
前言
项目开发中不管是前台还是后台都会遇到烦人的null，数据库表中字段允许空值，则代码实体类中对应的字段类型为可空类型Nullable<>，如int?，DateTime?，null值字段序列化返回的值都为null，前台对应字段赋值需要做null值判断，怎么才能全局把null替换为空。
本文分享WebAPI接口服务统一返回null替换为空的方法。
一、分析问题
.NET Core中使用Newtonsoft.Json进行序列化，WebAPI接口返回格式通过Startup.cs类全局设置。想是否可以通过配置把null替换为空值？于是找到了Newtonsoft.Json在序列化和反序列化期间如何处理空值和默认值的属性，具体配置代码如下：
publicvoidConfigureServices(IServiceCollection services)
//配置Mvc + json 序列化
services.AddMvc
.AddNewtonsoftJson(options =>
//数据格式首字母小写 不使用驼峰
options.SerializerSettings.ContractResolver = newCamelCasePropertyNamesContractResolver;
//使用默认方式，不更改元数据的key的大小写
//options.SerializerSettings.ContractResolver = new DefaultContractResolver;
// 忽略循环引用
options.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
// 设置时间格式
options.SerializerSettings.DateFormatString = "yyyy-MM-dd HH:mm:ss";
展开全文
//忽略空值 不包含属性的null序列化
//options.SerializerSettings.NullValueHandling = NullValueHandling.Ignore;
//忽略默认值和null 1、不包含属性默认值和null
//options.SerializerSettings.DefaultValueHandling = DefaultValueHandling.Igno
1、空值的处理
序列化和反序列化时需要忽略值为null的属性，设置NullValueHandling的值
NullValueHandling.Ignore 序列化和反序列化对象时忽略空值
NullValueHandling.Include 序列化和反序列化对象时包含空值
2、默认值的处理
序列化和反序列化时需要忽略默认值属性，设置DefaultValueHandling的值
DefaultValueHandling.Ignore 序列化和反序列化时忽略默认值
DefaultValueHandling.Include序列化和反序列化时包含默认值
3、示例代码
/*包含属性的默认值与null序列化*/
"Name": null,
"NickName": null,
"Age": 0,
"Sex": 0
/*不包含属性的默认值序列化*/
"Name": "Hello World",
"Age": 24
/*不包含属性的null序列化*/
"Name": "Hello World",
"Age": 28,
"Sex": 0
通过上面的分析：一种是不包含属性的默认值序列化，另一种是不包含属性的null序列化，都不能满足目前的需求接口统一返回的null序列化为空。
二、解决问题
1、项目WebAPI默认返回的JSON结果格式如下：
"code": 0,
"msg": "查询成功",
"data": {
"id": 1,
"title": "炎炎夏日暖暖肚",
"describe": "",
"author": null,
"authorId": null,
"linkSource": null,
"author_Picture": null,
"content": "炎炎夏日，很多人喜欢吃些寒凉的食物解暑，可这种做法非常伤身。",
2、需要解决的问题把所有的null替换为空，具体如下图所示：
3、解决方案
需要自己写一个NullToEmptyStringResolver类，然后重写CamelCasePropertyNamesContractResolver，但是该方法只能解决string类型null→""的问题，对其他可空类型无效，比如:int?、DateTime?等。
publicclassNullToEmptyStringResolver: CamelCasePropertyNamesContractResolver
///<summary>
///创建属性
///</summary>
///<param name="type">类型 </param>
///<param name="memberSerialization">序列化成员 </param>
///<returns></returns>
protectedoverrideIList<JsonProperty> CreateProperties( Type type, MemberSerialization memberSerialization)
returntype.GetProperties.Select(c =>
varjsonProperty = base.CreateProperty(c, memberSerialization);
jsonProperty.ValueProvider = newNullToEmptyStringValueProvider(c);
returnjsonProperty;
}).ToList;
publicclassNullToEmptyStringValueProvider: IValueProvider
privatereadonlyPropertyInfo _memberInfo;
///<summary>
///构造函数
///</summary>
///<param name="memberInfo"></param>
publicNullToEmptyStringValueProvider( PropertyInfo memberInfo)
_memberInfo = memberInfo;
///<summary>
///获取Value
///</summary>
///<param name="target"></param>
///<returns></returns>
publicobjectGetValue( objecttarget )
varresult = _memberInfo.GetValue(target);
if(_memberInfo.PropertyType == typeof( string) && result == null)
result = string.Empty;
returnresult;
///<summary>
///设置Value
///</summary>
///<param name="target"></param>
///<param name="value"></param>
publicvoidSetValue( objecttarget, objectvalue)
_memberInfo.SetValue(target, value);
在Startup.cs代码里面修改，标记为红色的代码，如下所示：
//配置MVC+JSON序列化
services
.AddMvc( options=> {options.EnableEndpointRouting = false;})
.AddNewtonsoftJson( options=>
//使用默认方式，不更改元数据的key的大小写
//options.SerializerSettings.ContractResolver = new DefaultContractResolver;
//数据格式首字母小写 不使用驼峰 小驼峰firstName 大驼峰 FirstName
//options.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver;
options.SerializerSettings.ContractResolver = newNullToEmptyStringResolver;
// 忽略循环引用
options.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
// 设置时间格式
options.SerializerSettings.DateFormatString = "yyyy-MM-dd HH:mm:ss";
//忽略空值 不包含属性的null序列化
//options.SerializerSettings.NullValueHandling = NullValueHandling.Ignore;
//忽略默认值和null 1、不包含属性默认值和null
//options.SerializerSettings.DefaultValueHandling = DefaultValueHandling.Igno
修改完配置，重新运行完成，实现null替换为空的效果，运行结果如下所示：
"code": 0,
"msg": "查询成功！",
"data": {
"id": 1,
"title": "炎炎夏日暖暖肚",
"describe": "",
"author": "",
"authorId": "",
"linkSource": "",
"author_Picture": "",
"source": 0,
"content": "炎炎夏日，很多人喜欢吃些寒凉的食物解暑，可这种做法非常伤身。"
三、总结
.NET Core下Newtonsoft.Json序列化时字符串null替换成空，通过ContractResolver类为属性添加一些序列化设置、自定义属性名、设置时间格式、有选择性的序列化属性等，实现WebAPI返回JSON格式统一化。
- EOF -
点击标题可跳转
性能超四倍的高性能.NET二进制序列化库
.NET Core 中的日志与分布式链路追踪
WebAPI解决发布后每隔一段时间请求变缓慢
看完本文有收获？请转发分享给更多人
推荐关注「DotNet」，提升.Net技能
点赞和在看就是最大的支持❤️
相关文章
- 详细阅读
-
日本H3火箭在飞行途中第二级发动机燃烧提前停止详细阅读
日本宇宙航空研究开发机构22日发射一枚H3火箭，火箭在飞行途中第二级发动机燃烧提前停止。目前正在确认情况。 当地时间12月22日10时51分左右，日本...
2025-12-22 1
-
美国对台军售，除口头抗议外，我们该如何痛打反击？详细阅读
12月18日，美国国务院批准对台军售111亿美元，这是史上最大的一笔。主要涉及82辆海马斯火箭炮，60辆M109A7自行火炮，420枚战术弹道导弹，1...
2025-12-22 1
-
一百枚导弹从天而降，美军发起斩首行动，特朗普下令，释放信息量大详细阅读
深夜的中东上空，几十架战机携带着一百枚巡航导弹悄无声息地逼近目标，随着白宫下达的攻击指令，导弹如同暴雨般从天而降，精准命中几处关键设施。这不是电影里的...
2025-12-22 1
-
“小洛熙事件”涉事医院小儿胸心外科住院部已关闭，胸心外科手术已暂停详细阅读
12月22日，据第一财经，记者致电宁波大学附属妇女儿童医院获悉，目前该院小儿胸心外科住院部已关闭，手术也已暂停。 据媒体此前报道，近日，宁波邓女士在网...
2025-12-22 1
-
江畅同志突发心梗，不幸逝世详细阅读
湖北大学12月20日发布讣告：中国共产党优秀党员，著名伦理学家、湖北大学人文社会科学资深教授、湖北大学高等人文研究院名誉院长、哲学学院教授江畅同志因突...
2025-12-22 1
-
高市早苗政府叫嚣拥核，中美俄第一时间表态，鲁比奥的回应堪称“绝杀”！详细阅读
近来，东亚的地缘政治局势愈发紧张，加之历史遗留问题与现实权力竞争，使得本地区的安全形势日趋复杂。在这样的背景下，日本国内关于核武器的讨论再度被推上风口...
2025-12-22 1
-
今天凌晨，俄罗斯遭遇袭击！详细阅读
当地时间今天（12月22日）凌晨，俄罗斯南部克拉斯诺达尔边疆区官方通过社交媒体证实，乌克兰无人机袭击导致当地两艘船只和两个码头受损，并引发火灾，过火面...
2025-12-22 1
发表评论