序列化EF Core查询结果时如何避免循环引用错误？

触发原因 #

该行为是EF Core自带的**关系修正（Relationship Fixup）**机制导致的：
只要实体处于当前DbContext的跟踪范围内，EF Core会自动补全所有已加载实体的双向导航属性。你在查询ForumPost时通过Include加载了关联的Tag实体，这两类实体都被加入了上下文的跟踪缓存，EF识别到Tag上的Posts导航属性与已加载的ForumPost实例存在关联，就会自动为Tag的Posts集合填充对应数据，即便你没有显式Include该导航属性也会触发该行为。

解决方案 #

可以根据你的业务场景选择以下任意方案：

• 方案1：使用无跟踪查询（最推荐，适配只读查询场景）
  关系修正仅作用于被上下文跟踪的实体，查询时添加AsNoTracking()即可关闭该机制，Tag的Posts属性会保持默认空值/Null：

var posts = await context.Posts
    .AsNoTracking()
    .Include(p => p.Tags)
    .ToListAsync();

• 方案2：移除不需要的反向导航属性
  如果业务上不需要从Tag维度反查关联的ForumPost列表，可以直接删除Tag类中的public List<ForumPost> Posts { get; set; }属性，从根源上避免循环引用，也不会影响正向查询Tag的逻辑。

• 方案3：配置序列化器忽略循环引用
  如果必须保留双向导航和实体跟踪逻辑，可以修改JSON序列化配置，直接跳过循环引用的节点：

  • 用System.Text.Json的配置示例：

  var json = JsonSerializer.Serialize(posts, new JsonSerializerOptions
  {
      ReferenceHandler = ReferenceHandler.IgnoreCycles
  });
  

  • 用Newtonsoft.Json的配置示例：

  var json = JsonConvert.SerializeObject(posts, new JsonSerializerSettings
  {
      ReferenceLoopHandling = ReferenceLoopHandling.Ignore
  });
  

• 方案4：手动清空反向导航属性
  如果上述方案都不适用，你可以在查询完成后手动遍历清空所有Tag的Posts集合：

foreach (var post in posts)
{
    foreach (var tag in post.Tags)
    {
        tag.Posts = null;
    }
}

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