Entity Framework Include()导致ASP.NET中JSON解析错误

你遇到的是JSON序列化循环引用问题：Calendar和Category互为多对多关联，序列化JSON时，Calendar会包含Categories集合，每个Category又会反向引用Calendars集合，形成无限递归，导致JSON数据无限嵌套，浏览器无法正常解析。

解决方案1：使用DTO（推荐） #

创建仅包含前端所需字段的数据传输对象（DTO），避免传递循环引用的导航属性。

示例DTO定义：

public class CalendarDTO
{
    public int Id { get; set; }
    public string Name { get; set; }
    // 仅返回Category的基础信息，不包含反向的Calendars
    public List<CategoryDTO> Categories { get; set; }
}

public class CategoryDTO
{
    public int Id { get; set; }
    public string Name { get; set; }
    // 不包含Calendars属性，切断循环链
}

控制器中映射实体到DTO：

var calendars = await query.Include(c => c.Categories).ToArrayAsync();
var calendarDTOs = calendars.Select(c => new CalendarDTO
{
    Id = c.Id,
    Name = c.Name,
    Categories = c.Categories.Select(cc => new CategoryDTO
    {
        Id = cc.Id,
        Name = cc.Name
    }).ToList()
}).ToArray();
return Ok(calendarDTOs);

解决方案2：配置JSON序列化忽略循环引用 #

在ASP.NET Core的配置文件（Program.cs或Startup.cs）中，设置JSON序列化选项自动忽略循环引用：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles;
    });

此配置会让序列化器在检测到循环引用时自动跳过，避免无限递归。

解决方案3：用特性标记忽略导航属性 #

在其中一个实体的反向导航属性上添加[JsonIgnore]特性，阻止该属性被序列化：

public class Category
{
    ...
    [JsonIgnore]
    public ICollection<Calendar> Calendars { get; set; } = new List<Calendar>();
    ...
}

这样序列化Calendar时，Category对象不会包含Calendars属性，彻底切断循环引用链。

内容的提问来源于stack exchange，提问作者Hanza