贯彻省委“支点建设”战略部署，落实市委“五个中心”建设重要要求，市发展和改革委员会（以下简称市发改委）如何在打造全国经济中心中当好牵头者、走好跃升路？...
2026-05-27 4
.NET Core 处理 WebAPI JSON 返回烦人的null为空
火币pro官网下载
2022年10月21日 11:01 99
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技能
点赞和在看就是最大的支持❤️
相关文章
- 详细阅读
-
2比0完胜澳大利亚队 U17国足将与日本队争冠详细阅读
北京时间5月20日凌晨，U17国足在U17亚洲杯半决赛中2比0击败澳大利亚队，成功晋级最终决赛。决赛中，他们的对手为日本队。 本场比赛，U17国足在...
2026-05-20 6
-
演员黄子仟发生车祸意外去世详细阅读
5月19日，曾出演过多部微短剧的演员黄子仟被传意外离世，年仅24岁。红星新闻记者从相关渠道获悉，黄子仟于今年5月11日发生车祸，送医后经抢救无效去世。...
2026-05-20 6
-
广西一蛋糕店竟用柳州地震营销 负责人：已发朋友圈道歉，深刻反省，市监局已来过详细阅读
5月19日，有网传信息显示，广西桂林市七星区一蛋糕店在朋友圈发布的文案中写道：“比520更早到来的，是柳州5.2级地震的震动”。随后，该蛋糕店删除了相...
2026-05-20 6
-
伊朗作出让步！同意浓缩铀转移至俄罗斯，若美还不满意，只能背水一战详细阅读
5月18日，伊朗外交部对外公布全新停火方案，并经由巴基斯坦转交美方。本次方案虽与前期提案大体相近，但在浓缩铀处置方式上做出策略调整，释放出差异化博弈信...
2026-05-20 6
-
莫氏鸡煲顺德新店火爆开业， 否认10万元加盟费传闻详细阅读
4月30日，据九派新闻，针对网传 “加盟费10万元、每月管理费2万元” 的说法，莫氏鸡煲创始人莫叔的儿子明确否认。 他表示，网传的加盟费用和加盟协议都...
2026-04-30 10
-
来沪游客吐槽“走路也罚款”！上海交管还原真相：占用非机动车道行走，轻微首违仅予警告，有法度有温度详细阅读
“去上海前也没人告诉我走路也罚款！”五一假期将至，一则贴文引起大家的关注，某位游客自述在上海街头因误入非机动车道被交警开具警告单。不少计划节日期间来沪...
2026-04-30 6
-
欧洲人权组织：以军训练狗强奸巴勒斯坦人详细阅读
瓦吉迪被赤身裸体绑在金属床上时，第一个以色列士兵走进来了。他没有说话，也没有蒙住瓦吉迪的眼睛，事后瓦吉迪回忆，那人似乎很享受他的恐惧。 强奸发生得很快...
2026-04-30 10
发表评论