WebApi-JSON序列化循环引用
Overview
最近被序列化,循环引用的问题,让我浑身酸爽。遇到这种异常是在搭建WebApi的时候,当我返回Linq实例类集合的时候出现的。
下定决心要解决这个问题。循环引用引起的原因是:
比如说:我现在有两个 类 A 和 B 现在 A类中有B类类型的属性存放着B类的对象,而B类中有一个属性,存放置A类型的字段。结果,进行序列化的时候,序列化A的时候,因为要序列化这B类对象的属性,然后去序列化B类型的对象,B类型的对象有一个属性放置A类型的对象,然后又去序列化A ,如此循环往复。
说的可能有点抽象,下面我们还是来看代码吧。
会引发异常的代码
一个简陋的Parent类
namespace 序列化循环引用
{
public class Parent
{
public string Name { get; set; }
public string Age { get; set; }
public string Gender { get; set; }
public Child Child { get; set; }
}
}
一个更简陋的Child类
namespace 序列化循环引用
{
public class Child
{
public string Name { get; set; }
public Parent Parent { get; set; }
}
}
PS:这两个简陋的类,看起来平淡无奇,但是这里有两个地方需要注意一下,Parent类中,有一个【Child】类型的属性,Child类中有个【Parent】类型的数据。然后下面我要进行一个脑残而又神奇的操作。
private void Form1_Load(object sender, EventArgs e)
{
Child child = new Child();
Parent person = new Parent() { Name = "鲁迅认识的那只猹", Age = "18", Gender = "男", Child = child };
child.Name = "Test";
child.Parent = person;
JavaScriptSerializer jss = new JavaScriptSerializer();
string value = jss.Serialize(jss);
Console.WriteLine(value);
}
代码看上去没有问题,但是如果运行程序就会抛出异常
为什么要做这种脑残的操作
我们自己设计的话,当然我想大家,一般情况下是不会这么做的。除非想找一下刺激。但是这种看似脑残的操作,在ORM框架中被广泛的应用,所以说这个操作有些时候并不脑残。
建立一个测试用数据库 表结构如下
填充了一些数据
User表
Department 表
查看Linq生成的实体类
Department
[global::System.Data.Linq.Mapping.TableAttribute(Name="dbo.[User]")]
public partial class User : INotifyPropertyChanging, INotifyPropertyChanged
{
private static PropertyChangingEventArgs emptyChangingEventArgs = new PropertyChangingEventArgs(String.Empty);
private int _Id;
private string _Username;
private string _Password;
private int _DepartmentId;
private EntityRef<Department> _Department;
/*************省略其他代码****************/
}
User
[global::System.Data.Linq.Mapping.TableAttribute(Name="dbo.Department")]
public partial class Department : INotifyPropertyChanging, INotifyPropertyChanged
{
private static PropertyChangingEventArgs emptyChangingEventArgs = new PropertyChangingEventArgs(String.Empty);
private int _DepartmentId;
private string _Name;
private EntityRef<User> _User;
/*************省略其他代码****************/
}
分析
我们看到 【User】表中引用了【Department】的对象,而【Department】中引用了【User】中的对象,如果我们这样进行序列化的话,一定会出现很有意思的事情 。
为什么微软要这么做呢,先来看看官方的解释。
Provides for deferred loading and relationship maintenance for the singleton side of a one-to-many relationship in a LINQ to SQL application.
为在LINQ到SQL应用程序的一对多关系的单例方面提供延迟加载和关系维护。(感谢有道词典...)
延迟加载我们在写代码的时候可能没有什么感觉,但是关系维护
这一点大家应该深有体会。比如说下面的代码:
TestDBDataContext db = new TestDBDataContext();
var result = from a in db.Users
where 1 == 1
select new
{
用户名 = a.Username,
密码 = a.Password,
部门名称 = a.Department.Name
};
通过【User】实体类,可以快速的关联到【Department】的属性,从而拿到数据。配合我们VS强大的智能感知,可以进行爽快的开发。正是因为这点ORM框架才做出了看似有点问题的设计。
解决问题
上面的讲解,是为了省事,建立了一个Winfrom的项目,到了解决问题的时候了我们需要建立一个【WebApi】的项目。
以下的配置将是我们解决问题的时候的默认配置。
public static class WebApiConfig
{
public static void Register(HttpConfiguration config)
{
/*************省略的不相干的代码*******************/
//干掉Xml序列化
config.Formatters.Remove(config.Formatters.XmlFormatter);
}
}
获取User表的数据
public class TestController : ApiController
{
public IEnumerable<object> GetAllUser()
{
Models.DBDataContext db = new Models.DBDataContext();
return db.Users;
}
}
在浏览器中进行浏览,会出现以下的错误页面,其中会有一条类似下面的错误信息
Self referencing loop detected with type 'TestApi.Models.User'. Path '[0].Department.Users
referencing loop 是关键,告诉我们出现了循环引用.
因为ORM框架出于开发效率的设计,造成了我们序列化的时候,循环引用的问题。经过网上资料的查找找到了如下的解决方案。
- 使用匿名类,手动的避免循环引用的状况
- 使用【[Newtonsoft.Json.JsonIgnore]】特性,标识引用对象,不进行序列化
- 更改WebApi的配置,忽略循环引用的序列化【推荐】
1 使用匿名类
public class TestController : ApiController
{
public IEnumerable<object> GetAllUser()
{
Models.DBDataContext db = new Models.DBDataContext();
//return db.Users;
var result = from a in db.Users
select new
{
a.Username,
a.Password,
a.Department.Name
};
return result;
}
}
/*
输出结果
[{"Username":"鲁迅认识的那只猹","Password":"123456","Name":"人事部"},{"Username":"被鲁迅认识的那只猹","Password":"123456","Name":"人事部"},{"Username":"猹","Password":"123456","Name":"财务部"}]
*/
因为使用了匿名类,匿名类中也没有出现,会出现循环引用的情况,所以这是一种解决方案。
2 使用[Newtonsoft.Json.JsonIgnore]特性标记
public IEnumerable<Models.User> GetAllUser()
{
Models.DBDataContext db = new Models.DBDataContext();
return db.Users;
}
直接像上面这么写肯定是报错了,我们需要对Linq生成的实体类稍微做一下修改
[global::System.Data.Linq.Mapping.TableAttribute(Name="dbo.[User]")]
public partial class User : INotifyPropertyChanging, INotifyPropertyChanged
{
/*************省略的不相干的代码*******************/
/*标记 Department 属性在序列化的时候忽略掉*/
[Newtonsoft.Json.JsonIgnore]
[global::System.Data.Linq.Mapping.AssociationAttribute(Name="Department_User", Storage="_Department", ThisKey="Id", OtherKey="DepartmentId", IsForeignKey=true)]
public Department Department
{
get
{
return this._Department.Entity;
}
set
{
Department previousValue = this._Department.Entity;
if (((previousValue != value)
|| (this._Department.HasLoadedOrAssignedValue == false)))
{
this.SendPropertyChanging();
if ((previousValue != null))
{
this._Department.Entity = null;
previousValue.User = null;
}
this._Department.Entity = value;
if ((value != null))
{
value.User = this;
this._Id = value.DepartmentId;
}
else
{
this._Id = default(int);
}
this.SendPropertyChanged("Department");
}
}
}
/*************省略的不相干的代码*******************/
}
再次运行,成功序列化
[{"Id":1,"Username":"鲁迅认识的那只猹","Password":"123456","DepartmentId":1},{"Id":2,"Username":"被鲁迅认识的那只猹","Password":"123456","DepartmentId":1},{"Id":3,"Username":"猹","Password":"123456","DepartmentId":2}]
3 直接进行配置为忽略循环引用 【推荐】
public static class WebApiConfig
{
public static void Register(HttpConfiguration config)
{
/*************省略的不相干的代码*******************/
//干掉Xml序列化
config.Formatters.Remove(config.Formatters.XmlFormatter);
//设置JSON序列化遇到循环引用的处理方式
config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
}
}
运行程序,成功序列化
[{"Id":1,"Username":"鲁迅认识的那只猹","Password":"123456","DepartmentId":1,"Department":{"DepartmentId":1,"Name":"人事部"}},{"Id":2,"Username":"被鲁迅认识的那只猹","Password":"123456","DepartmentId":1,"Department":{"DepartmentId":2,"Name":"财务部"}},{"Id":3,"Username":"猹","Password":"123456","DepartmentId":2,"Department":null}]
结语
关于JSON序列化出现循环引用的问题的解决方案,一共有三种
使用匿名类
使用特性标识
直接进制WebApi配置
,这几种推荐结合的使用,并不是说一种方法可以解决所有的问题,还是要视情况而定,选择最适合的。本文就到此为止,文中有任何纰漏之处,还望大家多多指出,以免误导大家。
WebApi-JSON序列化循环引用的更多相关文章
- [MVC_Json序列化]MVC之Json序列化循环引用
在做MVC项目时,难免会遇到Json序列化循环引用的问题,大致错误如下 错误1:序列化类型为“...”的对象时检测到循环引用. 错误2:Self referencing loop detected f ...
- 解决.Net MVC EntityFramework Json 序列化循环引用问题.
以前都是到处看博客,今天小菜也做点贡献,希望能帮到大家. 废话不多说,直接进入正题. 用过.net MVC的同学应该都被json序列化报循环引用错误这个问题骚扰过.网上有一些解决办法,但是都治标不治本 ...
- 小解系列-自关联对象.Net MVC中 json序列化循环引用问题
自关联对象在实际开发中用的还是比较多,例如常见的树形菜单.本文是自己实际的一个小测试,可以解决循环引用对象的json序列化问题,文笔不好请多见谅,如有错误请指出,希望有更好的解决方案,一起进步. 构造 ...
- 关于json序列化循环引用导致出错
以下是错误信息: Caused by: java.lang.IllegalStateException: circular reference error Offending field: meth ...
- Json序列化循环引用的问题
今天在发布接口的时候出突然出现了一个问题,报错代码为: 1 An exception has occurred while using the formatter 'JsonMediaTypeForm ...
- 解决MVC Json序列化的循环引用问题/EF Json序列化循引用问题---Newtonsoft.Json
1..Net开源Json序列化工具Newtonsoft.Json中提供了解决序列化的循环引用问题: 方式1:指定Json序列化配置为 ReferenceLoopHandling.Ignore 方式2: ...
- Atitit.json xml 序列化循环引用解决方案json
Atitit.json xml 序列化循环引用解决方案json 1. 循环引用1 2. 序列化循环引用解决方法1 2.1. 自定义序列化器1 2.2. 排除策略1 2.3. 设置序列化层次,一般3级别 ...
- EF webapi json序列化 表间相互引用 无限循环问题解决方案
WebApiConfig.cs中加入 如下代码即可解决无限循环问题 var json = config.Formatters.JsonFormatter; // 解决json序列化时的循环引用问题 j ...
- EntityFramework Model有外键时,Json提示循环引用 解决方法
正文之前先说两句,距离上篇博客已将近两个月,这方面的学习和探索并没有停止,而是前进道路上遇上了各种各样的问题,需要不断的整理.反思和优化,这段时间的成果,将在最近陆续整理发出来. 个人感觉国内心态太浮 ...
随机推荐
- 阿里云的OCS缓存机制
OCS简介 OCS( Open Cache Service)为分布式高速缓存服务,主要实现热点数据的快速响应: OCS支持Key/Value的数据结构,兼容memcachebinary protoco ...
- 简单理解 NP, P, NP-complete和NP-Hard
P是一类可以通过确定性图灵机(以下简称 图灵机)在多项式时间(Polynomial time)内解决的问题集合. NP是一类可以通过非确定性图灵机( Non-deterministic Turing ...
- phpcm nginx 伪静态文件
rewrite ^/show-([0-9]+)-([0-9]+)-([0-9]+).html /index.php?m=content&c=index&a=show&catid ...
- 倍增 Tarjan 求LCA
...
- Linux基础-host文件解析
任务目标:为集群内的机器设定主机名,利用/etc/hosts文件来解析自己的集群中所有的主机名, 相应的集群的配置应该改成使用主机名的方式 使用 hostnamectl set-hostname 设定 ...
- 【译】第九篇 Replication:复制监视器
本篇文章是SQL Server Replication系列的第九篇,详细内容请参考原文. 复制监视器允许你查看复制配置组件的健康状况.这一篇假设你遵循前八篇,并且你已经有一个合并发布和事务发布.启动复 ...
- UNIX环境高级编程 第7章 进程环境
本章涉及C/C++程序中main函数是如何被调用的.命令行参数如何传递给main函数.程序的内存空间布局.程序如何使用环境变量.程序如何终止退出. main函数 C程序或C++程序总是从main函数开 ...
- c++ STL 常用容器元素类型相关限制 指针 引用
c++ 的 STL 中主要有 vector , list, map, set , multimap,multiset 这些容器完全支持使用内置类型和指针(指针注意内存泄露问题). 就是说乱用智能指针 ...
- beego项目运行过程
一:首先man.go,整个程序的入口 func main() { beego.Run() } 然后beego.run()代码 // Run beego application. // beego.Ru ...
- 【navicat112_premium】navicat112_premium数据库连接工具安装过程
此工具及其方便,可以连接mysql.oracle.sqlserver登数据库... 1.下载安装包Navicat Premium_11.2.7简体中文版.rar 下载地址:http://qiaoliq ...