序列化“SubSonic.Schema .DatabaseColumn”类型的对象时检测到循环引用。

问题描述 投票:166回答:14

我正在尝试做一个简单的JSON返回,但我遇到了问题,我有以下内容。

public JsonResult GetEventData()
{
    var data = Event.Find(x => x.ID != 0);
    return Json(data);
}

我得到了一个HTTP 500,例外情况如此问题的标题所示。我也试过了

var data = Event.All().ToList()

这给了同样的问题。

这是一个错误还是我的实现?

c# .net json entity-framework subsonic
14个回答
172
投票

似乎您的对象层次结构中存在循环引用,JSON序列化程序不支持该引用。你需要所有的栏目吗?您只能在视图中选择所需的属性:

return Json(new 
{  
    PropertyINeed1 = data.PropertyINeed1,
    PropertyINeed2 = data.PropertyINeed2
});

这将使您的JSON对象更轻松,更容易理解。如果您有许多属性,AutoMapper可用于在DTO对象和View对象之间进行automatically映射。


2
投票

提供的答案很好,但我认为可以通过添加“架构”视角来改进它们。

调查

MVC's Controller.Json函数正在完成这项工作,但在这种情况下提供相关错误非常差。通过使用Newtonsoft.Json.JsonConvert.SerializeObject,错误确切地指定了触发循环引用的属性是什么。在序列化更复杂的对象层次结构时,这尤其有用。

适当的架构

永远不应该尝试序列化数据模型(例如EF模型),因为在序列化方面,ORM的导航属性是消亡的道路。数据流应如下:

Database -> data models -> service models -> JSON string 

可以使用自动映射器(例如Automapper)从数据模型获得服务模型。虽然这并不能保证缺少循环引用,但正确的设计应该这样做:服务模型应该包含服务消费者所需要的内容(即属性)。

在极少数情况下,当客户端请求在不同级别上涉及相同对象类型的层次结构时,该服务可以创建具有父 - >子关系的线性结构(仅使用标识符,而不是引用)。

现代应用程序倾向于避免一次加载复杂的数据结构,服务模型应该很小。例如。:

  1. 访问事件 - 仅加载标题数据(标识符,名称,日期等) - >仅包含标题数据的服务模型(JSON)
  2. 托管与会者列表 - 访问弹出窗口并延迟加载列表 - >服务模型(JSON)仅包含与会者列表

1
投票

我正在使用修复,因为在MVC5视图中使用Knockout。

在行动

return Json(ModelHelper.GetJsonModel<Core_User>(viewModel));

功能

   public static TEntity GetJsonModel<TEntity>(TEntity Entity) where TEntity : class
    {
        TEntity Entity_ = Activator.CreateInstance(typeof(TEntity)) as TEntity;
        foreach (var item in Entity.GetType().GetProperties())
        {
            if (item.PropertyType.ToString().IndexOf("Generic.ICollection") == -1 && item.PropertyType.ToString().IndexOf("SaymenCore.DAL.") == -1)
                item.SetValue(Entity_, Entity.GetPropValue(item.Name));
        }
        return Entity_;  
    }

0
投票

您可以注意到导致循环引用的属性。然后你可以这样做:

private Object DeCircular(Object object)
{
   // Set properties that cause the circular reference to null

   return object
}

-1
投票
//first: Create a class as your view model

public class EventViewModel 
{
 public int Id{get;set}
 public string Property1{get;set;}
 public string Property2{get;set;}
}
//then from your method
[HttpGet]
public async Task<ActionResult> GetEvent()
{
 var events = await db.Event.Find(x => x.ID != 0);
 List<EventViewModel> model = events.Select(event => new EventViewModel(){
 Id = event.Id,
 Property1 = event.Property1,
 Property1 = event.Property2
}).ToList();
 return Json(new{ data = model }, JsonRequestBehavior.AllowGet);
}

-1
投票

解决此问题的一个更简单的替代方法是返回一个字符串,并使用JavaScriptSerializer将该字符串格式化为json。

public string GetEntityInJson()
{
   JavaScriptSerializer j = new JavaScriptSerializer();
   var entityList = dataContext.Entitites.Select(x => new { ID = x.ID, AnotherAttribute = x.AnotherAttribute });
   return j.Serialize(entityList );
}

“选择”部分非常重要,它可以在视图中选择所需的属性。某些对象具有父级的引用。如果您不选择属性,则可能会出现循环引用,如果您只是将表作为一个整体。

不要这样做:

public string GetEntityInJson()
{
   JavaScriptSerializer j = new JavaScriptSerializer();
   var entityList = dataContext.Entitites.toList();
   return j.Serialize(entityList );
}

如果您不想要整个表格,请执行此操作:

public string GetEntityInJson()
{
   JavaScriptSerializer j = new JavaScriptSerializer();
   var entityList = dataContext.Entitites.Select(x => new { ID = x.ID, AnotherAttribute = x.AnotherAttribute });
   return j.Serialize(entityList );
}

这有助于使用更少的数据呈现视图,只需使用您需要的属性,并使您的Web运行更快。


96
投票

我有同样的问题,并由using Newtonsoft.Json;解决

var list = JsonConvert.SerializeObject(model,
    Formatting.None,
    new JsonSerializerSettings() {
        ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore
});

return Content(list, "application/json");

54
投票

这实际上是因为复杂对象是导致生成的json对象失败的原因。它失败了,因为当对象被映射时,它映射了映射其父对象的子对象,从而进行循环引用。 Json将花费无限的时间来序列化它,因此它可以防止异常的问题。

实体框架映射也会产生相同的行为,解决方案是丢弃所有不需要的属性。

只是说明最终答案,整个代码将是:

public JsonResult getJson()
{
    DataContext db = new DataContext ();

    return this.Json(
           new {
                Result = (from obj in db.Things select new {Id = obj.Id, Name = obj.Name})
               }
           , JsonRequestBehavior.AllowGet
           );
}

如果您不希望Result属性中的对象,也可以是以下内容:

public JsonResult getJson()
{
    DataContext db = new DataContext ();

    return this.Json(
           (from obj in db.Things select new {Id = obj.Id, Name = obj.Name})
           , JsonRequestBehavior.AllowGet
           );
}

13
投票

总结一下,有4个解决方案:

解决方案1:关闭DBContext的ProxyCreation并最终将其恢复。

    private DBEntities db = new DBEntities();//dbcontext

    public ActionResult Index()
    {
        bool proxyCreation = db.Configuration.ProxyCreationEnabled;
        try
        {
            //set ProxyCreation to false
            db.Configuration.ProxyCreationEnabled = false;

            var data = db.Products.ToList();

            return Json(data, JsonRequestBehavior.AllowGet);
        }
        catch (Exception ex)
        {
            Response.StatusCode = (int)HttpStatusCode.BadRequest;
            return Json(ex.Message);
        }
        finally
        {
            //restore ProxyCreation to its original state
            db.Configuration.ProxyCreationEnabled = proxyCreation;
        }
    }

解决方案2:通过设置ReferenceLoopHandling使用JsonConvert忽略序列化设置。

    //using using Newtonsoft.Json;

    private DBEntities db = new DBEntities();//dbcontext

    public ActionResult Index()
    {
        try
        {
            var data = db.Products.ToList();

            JsonSerializerSettings jss = new JsonSerializerSettings { ReferenceLoopHandling = ReferenceLoopHandling.Ignore };
            var result = JsonConvert.SerializeObject(data, Formatting.Indented, jss);

            return Json(result, JsonRequestBehavior.AllowGet);
        }
        catch (Exception ex)
        {
            Response.StatusCode = (int)HttpStatusCode.BadRequest;
            return Json(ex.Message);
        }
    }

以下两个解决方案是相同的,但使用模型更好,因为它是强类型的。

解决方案3:返回仅包含所需属性的模型。

    private DBEntities db = new DBEntities();//dbcontext

    public class ProductModel
    {
        public int Product_ID { get; set;}

        public string Product_Name { get; set;}

        public double Product_Price { get; set;}
    }

    public ActionResult Index()
    {
        try
        {
            var data = db.Products.Select(p => new ProductModel
                                                {
                                                    Product_ID = p.Product_ID,
                                                    Product_Name = p.Product_Name,
                                                    Product_Price = p.Product_Price
                                                }).ToList();

            return Json(data, JsonRequestBehavior.AllowGet);
        }
        catch (Exception ex)
        {
            Response.StatusCode = (int)HttpStatusCode.BadRequest;
            return Json(ex.Message);
        }
    }

解决方案4:返回一个新的动态对象,其中仅包含所需的属性。

    private DBEntities db = new DBEntities();//dbcontext

    public ActionResult Index()
    {
        try
        {
            var data = db.Products.Select(p => new
                                                {
                                                    Product_ID = p.Product_ID,
                                                    Product_Name = p.Product_Name,
                                                    Product_Price = p.Product_Price
                                                }).ToList();

            return Json(data, JsonRequestBehavior.AllowGet);
        }
        catch (Exception ex)
        {
            Response.StatusCode = (int)HttpStatusCode.BadRequest;
            return Json(ex.Message);
        }
    }

7
投票

JSON与xml和其他各种格式一样,是基于树的序列化格式。如果在对象中有循环引用,它将不会爱你,因为“树”将是:

root B => child A => parent B => child A => parent B => ...

通常有一些方法可以沿某条路径禁用导航;例如,使用XmlSerializer,您可以将父属性标记为XmlIgnore。我不知道这是否可能与json序列化器有关,也不知道DatabaseColumn是否有合适的标记(非常不可能,因为它需要引用每个序列化API)


4
投票

它是因为用于生成EntityFramework实体的新DbContext T4模板。为了能够执行更改跟踪,此模板使用代理模式,通过使用它们包装好的POCO。这会在使用JavaScriptSerializer进行序列化时导致问题。

那么这两个解决方案是:

  1. 您只需序列化并返回客户端上所需的属性
  2. 您可以通过在上下文的配置上设置代理来关闭代理的自动生成 context.Configuration.ProxyCreationEnabled = false;

在下面的文章中很好地解释了。

http://juristr.com/blog/2011/08/javascriptserializer-circular-reference/


4
投票

使用Newtonsoft.Json:在你的Global.asax Application_Start方法中添加以下行:

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;

4
投票

[JsonIgnore]添加到模型中的虚拟属性。


4
投票

避免直接转换表对象。如果在其他表之间设置关系,则可能会抛出此错误。相反,您可以创建一个模型类,为类对象赋值,然后对其进行序列化。

© www.soinside.com 2019 - 2024. All rights reserved.