ASP.Net MVC-Web API使用Entity Framework时遇到Loop Reference

原文地址：http://www.it165.net/pro/html/201210/3932.html

最近开始研究Web API,运气不错第一个测试项目就遇到问题@@-当新增Control时选择[API Controller woth read/write actions, using Entity Framework]然后使用Northwnd数据库,数据表选择Orders,Order_Details,Products.

前端javascript程序代码如下

@section scripts{ 
<script type="text/javascript"> 
$(document).ready(function () { 
 
$.getJSON('/api/order/', function (data) { 
alert(data); 
}) 
.error(function (jqXHR, textStatus, err) { 
alert('Error: ' + err); 
}); 
}); 
</script> 
}

执行后出现错误,查询完整的错误说明为Self referencing loop detected…,也就是循环参考.

这错误讯息好熟悉,突然想起以前开发Silverlight RIA Service好像也有类似情况.经上网查询原因后果不其然,问题是一样的,因为ASP.Net MVC Web API预设采用JSON.Net作为输出转换,而预设的情况下JSON.Net会自动一层层解析要输出的对象之属性,也就说这个例子中的输出对象为 Order,其中有个属性为Order_Details,而Order_Details也有个属性参考至Order,所以产生了循环相依问题,导致错误产生.

这个问题处理方式有三种 www.it165.net

1.最简单的方式就是从Entity Framework着手,停用LazyLoading与ProxyCreation.因为LazyLoading停用后那么当JSON.Net解析 Order对象时其属性Order_Details会返回null(不会自动加载).所以也就避免了此问题

当然此方式的缺点会导致后续程序存取Entity Object时牺牲了LazyLoading的方便性,需要手动处理此问题.

db.Configuration.LazyLoadingEnabled = false; 
db.Configuration.ProxyCreationEnabled = false; 
 
return db.Orders.AsEnumerable(); 

2.设定JSON.Net忽略循环参考

透过APP_Start的WebApiConfig.cs,设定 config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;

使用这个方式时要注意,它只是忽略循环参考的错误,但实际上还是会自动一层层解析要输出的对象之属性,所以若数据会相依有可能会产生无穷循环.

3.设定JSON.Net避免循环参考

透过APP_Start的WebApiConfig.cs,设定

config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Serialize;

config.Formatters.JsonFormatter.SerializerSettings.PreserveReferencesHandling = Newtonsoft.Json.PreserveReferencesHandling.Objects;

这种做法与2的差异在于它会将重复过的对象用一个代表取代,譬如底下JSON格式
1: [{"$id":"1","Category":{"$id":"2","Products":[{"$id":"3","Category":{"$ref":"2"},"Id":2,"Name":"Yogurt"},{"$ref":"1"}],"Id":1,"Name":"Diary"},"Id":1,"Name":"Whole Milk"},{"$ref":"3"}]

所以对于数据而言这种作法还是会自动一层层解析要输出的对象之属性,只是避免输出太大量数据.

4.手动设定避免循环参考

如同3的模式,透过[JsonIgnore] 与[JsonObject(IsReference = true)] 细部设定,可以更精确的设定每个要输出的属性.

缺点是1.设定繁杂. 2.只能通用设定无法例外. 3.因为必须直接或透过 partial class方式设定,故无法将设定与Entity Object class做分离

以上作法实际上都有其优缺点, 并没有一个可以通用的模式, 须看需求而定,这问题与同早期RIA Service的问题相同,但这边提供一种比较通用的模式就是采用方法1+方法2或3.

停用LazyLoading,而使用程序的方式(透过 Include方法)决定那些属性要输出.