检测到自引用循环 - 从 WebApi 取回数据到浏览器

Question

我正在使用实体框架，但在将父子数据传输到浏览器时遇到问题。这是我的课程：

 public class Question
 {
    public int QuestionId { get; set; }
    public string Title { get; set; }
    public virtual ICollection<Answer> Answers { get; set; }
}

public class Answer
{
    public int AnswerId { get; set; }
    public string Text { get; set; }
    public int QuestionId { get; set; }
    public virtual Question Question { get; set; }
}

我正在使用以下代码返回问答数据：

    public IList<Question> GetQuestions(int subTopicId, int questionStatusId)
    {
        var questions = _questionsRepository.GetAll()
            .Where(a => a.SubTopicId == subTopicId &&
                   (questionStatusId == 99 ||
                    a.QuestionStatusId == questionStatusId))
            .Include(a => a.Answers)
            .ToList();
        return questions; 
    }

在 C# 方面，这似乎可行，但我注意到答案对象有对问题的引用。当我使用 WebAPI 将数据获取到浏览器时，我收到以下消息：

“ObjectContent`1”类型无法序列化内容类型“application/json;”的响应正文； charset=utf-8'。

检测到类型为“Models.Core.Question”的属性“问题”的自引用循环。

这是因为问题有答案并且答案有对问题的引用吗？我看过的所有地方都建议在孩子身上引用父母，所以我不知道该怎么做。有人可以给我一些建议吗？

Answer 1

这是因为问题有答案，而答案有 参考回问题？

是的。无法序列化。

编辑：请参阅 Tallmaris 的答案和 OttO 的评论，因为它更简单并且可以全局设置。

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.Re‌​ferenceLoopHandling = ReferenceLoopHandling.Ignore;

旧答案：

将 EF 对象 Question 投影到您自己的中间对象或 DataTransferObject。然后这个Dto就可以序列化成功了。

public class QuestionDto
{
    public QuestionDto()
    {
        this.Answers = new List<Answer>();
    } 
    public int QuestionId { get; set; }
    ...
    ...
    public string Title { get; set; }
    public List<Answer> Answers { get; set; }
}

类似：

public IList<QuestionDto> GetQuestions(int subTopicId, int questionStatusId)
{
    var questions = _questionsRepository.GetAll()
        .Where(a => a.SubTopicId == subTopicId &&
               (questionStatusId == 99 ||
                a.QuestionStatusId == questionStatusId))
        .Include(a => a.Answers)
        .ToList();

    var dto = questions.Select(x => new QuestionDto { Title = x.Title ... } );

    return dto; 
}

Answer 2

你也可以在你的Application_Start()试试这个：

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Serialize;

它应该可以解决您的问题，而无需费力。

---

编辑： 根据 OttO 下面的评论，请改用：ReferenceLoopHandling.Ignore。

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

Answer 3

如果使用 OWIN，请记住，您不再需要 GlobalSettings！您必须在传递给 IAppBuilder UseWebApi 函数（或您所在的任何服务平台）的 HttpConfiguration 对象中修改相同的设置

看起来像这样。

    public void Configuration(IAppBuilder app)
    {      
       //auth config, service registration, etc      
       var config = new HttpConfiguration();
       config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
       //other config settings, dependency injection/resolver settings, etc
       app.UseWebApi(config);
}

Answer 4

在 ASP.NET Core 中，修复如下：

services
.AddMvc()
.AddJsonOptions(x => x.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore);

Answer 5

ASP.NET Core Web-API (.NET Core 2.0)：

// Startup.cs
public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();
    services.Configure<MvcJsonOptions>(config =>
    {
        config.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
    });
}

Answer 6

如果使用 DNX / MVC 6 / ASP.NET vNext blah blah，即使 HttpConfiguration 也会丢失。您必须在 Startup.cs 文件中使用以下代码来配置格式化程序。

public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc().Configure<MvcOptions>(option => 
        {
            //Clear all existing output formatters
            option.OutputFormatters.Clear();
            var jsonOutputFormatter = new JsonOutputFormatter();
            //Set ReferenceLoopHandling
            jsonOutputFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
            //Insert above jsonOutputFormatter as the first formatter, you can insert other formatters.
            option.OutputFormatters.Insert(0, jsonOutputFormatter);
        });
    }

Answer 7

作为 ASP.NET Core 3.0 的一部分，团队不再默认包含 Json.NET。您可以在 [Including Json.Net to netcore 3.x][1]https://github.com/aspnet/Announcements/issues/325

中了解更多相关信息

您使用延迟加载可能会导致错误： services.AddDbContext(options => options.UseLazyLoadingProxies()... 要么 db.Configuration.LazyLoadingEnabled = true;

修复： 添加到startup.cs

 services.AddControllers().AddNewtonsoftJson(options =>
        {
            options.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
        });

Answer 8

使用这个：

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore

对我不起作用。相反，我为我的模型类创建了一个新的简化版本，只是为了测试，结果很好。本文探讨了我在模型中遇到的一些对 EF 效果很好但无法序列化的问题：

http://www.asp.net/web-api/overview/data/using-web-api-with-entity-framework/part-4

Answer 9

ReferenceLoopHandling.Ignore 对我不起作用。我可以绕过它的唯一方法是通过代码删除返回到我不想要的父级的链接并保留我做的那些。

parent.Child.Parent = null;

Answer 10

对于使用 .Net Framework 4.5 的新 Asp.Net Web 应用程序：

Web Api：转到 App_Start -> WebApiConfig.cs：

应该是这样的：

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Web API configuration and services
        // Configure Web API to use only bearer token authentication.
        config.SuppressDefaultHostAuthentication();
        config.Filters.Add(new HostAuthenticationFilter(OAuthDefaults.AuthenticationType));

        // ReferenceLoopHandling.Ignore will solve the Self referencing loop detected error
        config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;

        //Will serve json as default instead of XML
        config.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/html"));

        // Web API routes
        config.MapHttpAttributeRoutes();

        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );
    }
}

Answer 11

由于延迟加载，您会收到此错误。因此我的建议是从财产中删除虚拟钥匙。如果您使用 API，那么延迟加载对您的 API 运行状况不利。

无需在配置文件中添加额外的行。

public class Question
 {
    public int QuestionId { get; set; }
    public string Title { get; set; }
    public ICollection<Answer> Answers { get; set; }
}

public class Answer
{
    public int AnswerId { get; set; }
    public string Text { get; set; }
    public int QuestionId { get; set; }
    public Question Question { get; set; }
}

Answer 12

我发现当我生成现有数据库的 edmx（定义概念模型的 XML 文件）并且它具有父表和子表的导航属性时，会导致此错误。我删除了所有指向父对象的导航链接，因为我只想导航到子对象，问题就解决了。

Answer 13

实体 db = 新实体（）

db.Configuration.ProxyCreationEnabled = false;

db.Configuration.LazyLoadingEnabled = false;

Answer 14

您可以动态创建新的子集合以轻松解决此问题。

public IList<Question> GetQuestions(int subTopicId, int questionStatusId)
    {
        var questions = _questionsRepository.GetAll()
            .Where(a => a.SubTopicId == subTopicId &&
                   (questionStatusId == 99 ||
                    a.QuestionStatusId == questionStatusId))
            .Include(a => a.Answers).Select(b=> new { 
               b.QuestionId,
               b.Title
               Answers = b.Answers.Select(c=> new {
                   c.AnswerId,
                   c.Text,
                   c.QuestionId }))
            .ToList();
        return questions; 
    }

Answer 15

以上答案中的配置在 ASP.NET Core 2.2 中都不适合我。

我在我的虚拟导航属性上添加了JsonIgnore 属性。

public class Question
{
    public int QuestionId { get; set; }
    public string Title { get; set; }
    [JsonIgnore]
    public virtual ICollection<Answer> Answers { get; set; }
}