.NET Entity Framework 循环引用导致序列化失败问题排查

问题根源 #

当用EF的Include加载Blog及其关联Posts时，每个Post的Blog导航属性会反向引用回父Blog对象，JSON序列化器递归处理这些对象时会陷入无限循环，最终导致程序崩溃。另外你DBContext配置里有个小错误：HasMany(d => d.Post)应该改为HasMany(d => d.Posts)，和Blog类里的属性名对应，否则EF关系配置会失效。

解决方案 #

1. 使用DTO（推荐） #

创建专门的传输对象，分离领域模型和接口返回模型，彻底避免循环引用，还能精准控制返回字段。

定义DTO类

// BlogDTO.cs
public class BlogDTO
{
    public int Id { get; set; }
    public string BlogName { get; set; } = string.Empty;
    public List<PostDTO> Posts { get; set; } = new();
}

// PostDTO.cs
public class PostDTO
{
    public int Id { get; set; }
    public int BlogId { get; set; }
    // 不包含Blog属性，切断循环链
}

修改服务层代码

public async Task<ServiceResponse<BlogDTO>> GetBlogWithPosts(int blogId)
{
    var blog = await _context.Blog.Include(p => p.Posts)
                                 .FirstOrDefaultAsync(x => x.Id == blogId);
    if (blog == null)
    {
        return new ServiceResponse<BlogDTO> { Success = false, Message = "Blog Not Found." };
    }

    // 领域模型转DTO
    var blogDto = new BlogDTO
    {
        Id = blog.Id,
        BlogName = blog.BlogName,
        Posts = blog.Posts.Select(p => new PostDTO
        {
            Id = p.Id,
            BlogId = p.BlogId
        }).ToList()
    };

    var response = new ServiceResponse<BlogDTO>
    {
        Data = blogDto,
        Success = true
    };
    return response;
}

修改控制器返回类型

[HttpGet("get-blog-with-posts/{blogId}")]
public async Task<ActionResult<ServiceResponse<BlogDTO>>> GetBlogWithPosts(int blogId)
{
   var options = await this._blogService.GetBlogWithPosts(blogId);
   return Ok(options);
}

2. 配置JSON序列化器忽略循环引用 #

在服务端Program.cs中配置JsonOptions，让序列化器遇到循环引用时自动跳过。

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

这个方法简单快捷，但会隐藏循环引用的存在，可能导致返回JSON丢失部分关联数据，适合临时快速解决，长期还是推荐用DTO方案。

3. 在模型导航属性上标记忽略序列化 #

在Post类的Blog属性上添加[JsonIgnore]特性，让序列化器跳过这个属性。

public class Post 
{ 
    public int Id { get; set; }       
    public int BlogId{ get; set; } 
    [JsonIgnore] // 跳过该属性的序列化
    public Blog Blog{ get; set; }       
}

注意：这个方法会影响所有需要序列化Post对象的场景，如果其他接口需要返回包含Blog的Post数据，就不适用了。

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