.NET Core 6 Web API对象循环引用序列化问题求助

针对你遇到的多对多关系循环引用序列化问题，结合之前尝试方案的痛点，推荐以下可行方案：

1. 基于DTO（数据传输对象）的按需映射（优先推荐） #

直接序列化EF Core实体类易引发循环引用，且无法灵活控制返回字段。通过创建DTO仅保留业务所需字段，从根源上避免循环引用：

示例代码 #

// Customer的DTO，按需包含Manager的基础信息
public class CustomerDto
{
    public int Id { get; set; }
    public string CustomerName { get; set; }
    // 仅返回Manager必要字段，不包含反向关联的Customers集合
    public List<ManagerSimpleDto> LinkedManagers { get; set; }
}

// Manager的精简DTO
public class ManagerSimpleDto
{
    public int Id { get; set; }
    public string ManagerName { get; set; }
}

// 查询时投影到DTO
var customers = _context.Customers
    .Include(c => c.Managers)
    .Select(c => new CustomerDto
    {
        Id = c.Id,
        CustomerName = c.Name,
        LinkedManagers = c.Managers.Select(m => new ManagerSimpleDto 
        { 
            Id = m.Id, 
            ManagerName = m.Name 
        }).ToList()
    })
    .ToList();

优势 #

• 彻底规避循环引用：DTO中不包含实体类的反向导航属性（如Manager的Customers集合）
• 性能优化：EF Core会根据Select中的字段生成精简SQL，减少数据传输量
• 灵活可控：可根据不同接口需求定义不同DTO，完全按需返回数据
• 解决CS0029错误：通过强类型投影，避免实体类与DTO之间的类型转换错误

若需查询Manager关联的Customers，只需定义对应DTO即可：

public class ManagerDto
{
    public int Id { get; set; }
    public string ManagerName { get; set; }
    public List<CustomerSimpleDto> LinkedCustomers { get; set; }
}

public class CustomerSimpleDto
{
    public int Id { get; set; }
    public string CustomerName { get; set; }
}

2. 配置System.Text.Json的选择性忽略（补充方案） #

若不想定义大量DTO，可通过[JsonIgnore]结合条件判断，仅在序列化时忽略反向导航属性，不影响EF Core的查询：

示例代码 #

在实体类的反向导航属性上添加条件忽略：

public class Manager
{
    public int Id { get; set; }
    public string Name { get; set; }
    // 仅序列化时忽略，EF Core查询仍可加载该属性
    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
    public List<Customer> Customers { get; set; }
}

注意事项 #

• 该方案仅解决序列化时的循环引用，EF Core查询时仍可通过Include(m => m.Customers)加载关联数据
• 若需在特定接口返回Manager的Customers，可通过自定义Json转换器或局部配置覆盖全局设置

3. EF Core查询时用投影替代Include（轻量优化方案） #

如果不需要加载完整关联实体，可直接通过Select投影获取所需数据，避免加载不必要属性：

var managers = _context.Managers
    .Select(m => new 
    {
        m.Id,
        m.Name,
        CustomerNames = m.Customers.Select(c => c.Name).ToList()
    })
    .ToList();

这种方式无需定义DTO，适合快速开发场景，同时避免循环引用，且SQL查询更高效。

内容的提问来源于stack exchange，提问作者Mr. Luo