Обнаружен цикл обращения к себе - возврат данных из WebApi в браузер
Я использую Entity Framework и имею проблему с передачей родительских и дочерних данных в браузер. Вот мои занятия:
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; кодировка = UTF-8'.
Обнаружен самоссылочный цикл для свойства 'question' с типом 'Models.Core.Question'.
Это потому, что в вопросе есть ответы, а в ответах есть ссылка на вопрос? Все места, которые я посмотрел, предполагают наличие ссылки на родителя в ребенке, поэтому я не уверен, что делать. Может кто-нибудь дать мне совет по этому поводу.
16 ответов
Это потому, что в вопросе есть ответы, а в ответах есть ссылка на вопрос?
Да. Это не может быть сериализовано.
РЕДАКТИРОВАТЬ: см. Ответ Tallmaris и комментарий OttO, поскольку он более прост и может быть установлен глобально.
GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = 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;
}
Вы также можете попробовать это в вашем Application_Start():
GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Serialize;
Это должно исправить вашу проблему, не проходя через много обручей.
РЕДАКТИРОВАТЬ: Согласно комментарию OttO ниже, используйте:
ReferenceLoopHandling.Ignore вместо.GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
В ASP.NET Core исправление заключается в следующем:
services
.AddMvc()
.AddJsonOptions(x => x.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore);
Если вы используете OWIN, помните, что больше нет GlobalSettings для вас! Вы должны изменить этот же параметр в объекте HttpConfiguration, который передается в функцию UseWebApi IAppBuilder (или любую платформу обслуживания, на которой вы работаете)
Будет выглядеть примерно так.
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);
}
При использовании DNX / MVC 6 / ASP.NET vNext бла-бла, даже 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);
});
}
Веб-API ASP.NET Core (.NET Core 2.0):
// Startup.cs
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
services.Configure<MvcJsonOptions>(config =>
{
config.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
});
}
Как часть ASP.NET Core 3.0, команда отказалась от включения Json.NET по умолчанию. Вы можете узнать больше об этом в [Включая Json.Net в netcore 3.x] [1] https://github.com/aspnet/Announcements/issues/325
Ошибка могла быть вызвана использованием отложенной загрузки: services.AddDbContext(options => options.UseLazyLoadingProxies()... или db.Configuration.LazyLoadingEnabled = true;
fix: добавить в startup.cs
services.AddControllers().AddNewtonsoftJson(options =>
{
options.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
});
Используя это:
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
Для нового веб-приложения Asp.Net, использующего.Net Framework 4.5:
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 }
);
}
}
ReferenceLoopHandling.Ignore не работает для меня. Единственный способ обойти это - удалить с помощью кода ссылки на родителя, который мне не нужен, и сохранить те, которые я сделал.
parent.Child.Parent = null;
Ни одна из конфигураций в ответах выше не работала для меня в 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; }
}
Вы можете динамически создать новую дочернюю коллекцию, чтобы легко обойти эту проблему.
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;
}
Я обнаружил, что эта ошибка была вызвана тем, что я сгенерировал edmx (XML-файл, который определяет концептуальную модель) существующей базы данных, и он имел свойства Navigation для родительской и дочерней таблиц. Я удалил все навигационные ссылки на родительские объекты, так как хотел только перейти к дочерним объектам, и проблема была решена.
Я думаю, что в большинстве случаев, если у вас возникла эта проблема, модификация сериализатора устранит только симптом.
Если возможно, лучше исправить базовый источник данных или вызывающий код. Очевидно, что если у вас нет контроля над ними, вы ничего не можете сделать, кроме как уйти :)
Из-за отложенной загрузки вы получаете эту ошибку. Следовательно, я предлагаю удалить виртуальный ключ из свойства. Если вы работаете с 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; }
}
Entities db = new Entities ()
db.Configuration.ProxyCreationEnabled = false;
db.Configuration.LazyLoadingEnabled = false;