Entity Framework关联查询时父实体嵌套子实体循环引用问题

这是Entity Framework双向关联搭配JSON序列化时的经典循环引用问题——你的Invoice包含Type集合，每个Type又持有一个Invoice引用，序列化器在处理的时候会无限递归嵌套，就出现了你看到的套娃结构。下面给你几个常用的解决方案，按需选择：

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

如果不想修改实体或额外创建类，可以直接在序列化配置里开启循环引用忽略。

针对System.Text.Json（.NET Core 3.0+ 默认） #

在Program.cs（或旧版的Startup.cs）里配置控制器的JSON选项：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        // 忽略循环引用的实体
        options.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles;
    });

针对Newtonsoft.Json（如果项目使用这个库） #

同样在服务配置里修改：

builder.Services.AddControllers()
    .AddNewtonsoftJson(options =>
    {
        options.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
    });

方案2：使用DTO（数据传输对象）解耦推荐 #

这是更规范的做法，通过创建专门的传输类，只暴露需要返回的字段，完全避免实体之间的循环引用。

首先定义DTO类：

// 发票传输对象
public class InvoiceDto
{
    public string Id { get; set; }
    public string Number { get; set; }
    // 只包含Type的必要字段，不反向引用Invoice
    public List<TypeDto> Types { get; set; }
}

// 发票类型传输对象
public class TypeDto
{
    public string Type { get; set; }
    public string Number { get; set; }
}

然后在查询时把EF实体映射到DTO（可以手动映射，也用AutoMapper这类工具简化）：

// 从数据库查询包含Type的Invoice
var invoices = _context.Invoices.Include(i => i.Type).ToList();

// 手动映射到DTO
var invoiceDtos = invoices.Select(invoice => new InvoiceDto
{
    Id = invoice.Id,
    Number = invoice.Number,
    Types = invoice.Type.Select(type => new TypeDto
    {
        Type = type.Type,
        Number = type.Number
    }).ToList()
}).ToList();

// 返回DTO给前端
return Ok(invoiceDtos);

这种方式的好处是解耦了数据层实体和前端需要的数据结构，后续需求变更时更灵活，也避免了实体内部细节泄露。

方案3：在实体上标记忽略反向引用 #

如果只是临时解决，也可以直接在实体的反向引用属性上加序列化忽略特性：

public partial class Type { 
    public string Type { get; set; } 
    public string Number { get; set; } 
    // 标记这个属性不参与JSON序列化
    [JsonIgnore] // System.Text.Json和Newtonsoft.Json都支持这个特性
    public Invoice Invoice { get; set; } 
}

不过这种方式不够灵活，如果后续有场景需要序列化这个反向引用，就得修改实体代码，不如DTO方案通用。

额外小建议 #

你的实体类里Invoice的集合属性命名是Type，和类名Type重复了，建议改成Types更规范，同时Fluent API里也要对应修改：

// 修改Invoice实体
public partial class Invoice : IEntity<string> { 
    public string Id { get; set; } 
    public string Number { get; set; } 
    public ICollection<Type> Types { get; set; } 
}

// 修改Fluent API配置
modelBuilder.Entity<Type>(entity => 
    entity.HasOne(t => t.Invoice)
          .WithMany(f => f.Types) // 这里改成Types
          .HasForeignKey(f => f.Number)
          .HasPrincipalKey(f => f.Number);
)

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