ASP.NET MVC WebAPI 2.0(非Core)返回空JSON而非序列化对象
核心根因
ItemVM类中定义的firstItem属性没有显式声明public访问修饰符。C#语法中,类成员如果不指定访问修饰符,默认访问级别为private,该属性实际为私有级别。
ASP.NET Web API 2.0默认使用Newtonsoft.Json完成响应序列化,组件默认规则是仅序列化公开级别的属性/字段。即使构造函数中已经为私有属性完成赋值、调试器可以直接读取对象内部私有状态,序列化器也无法访问私有成员的内容,最终输出空对象{}。
之前参考的自定义序列化方案无法生效的原因:CreateProperties方法是Newtonsoft.Json.Serialization.DefaultContractResolver类的受保护方法,只能在继承自该类的自定义序列化解析器中重写,不能直接在业务代码中随意调用重写。这类自定义方案是为处理需要序列化私有成员的极端场景设计的,完全不适配当前问题。
修复操作
- 直接为需要对外返回的
firstItem属性添加public访问修饰符,无需修改其他业务类的定义、无需调整控制器逻辑、无需改动全局序列化配置
public class ItemVM { // 补充缺失的public访问修饰符 public FirstItemVM firstItem { get; set; } public ItemVM() { this.firstItem = FirstItemVM.ToMap( new Entities.Item()); } }
- 修改完成后重启调试,即可看到符合预期的响应内容,返回结构为:
{ "firstItem": { "id": 0, "archived": false, "name": null } }
注意:不要为了解决这个问题全局开启私有成员序列化规则,会带来不必要的序列化冗余和潜在数据泄露风险,所有需要对外输出的视图模型属性,按规范显式标记为public即可。
内容的提问来源于stack exchange,提问作者Zachary Scott
相关产品推荐
相关产品推荐

