.NET 7中System.Text.Json设置ReferenceHandler.IgnoreCycles序列化失效

你遇到的核心问题是序列化时对象实际嵌套深度触及MaxDepth阈值，同时EF实体间的循环引用加剧了序列化冲突，以下是不用Newtonsoft.Json的有效解决方案：

方案1：调整MaxDepth到合适值 #

System.Text.Json的MaxDepth从根对象开始计数（根层级为1），报错中CurrentDepth (5)说明序列化到第5层时刚好达到阈值，无法继续处理下一层关联对象。只需将阈值设为比实际嵌套深度大1的值即可：

builder.Services.AddControllers()
    .AddJsonOptions(o =>
    {
        o.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles;
        o.JsonSerializerOptions.MaxDepth = 6; // 比报错的深度阈值大1
    });

该配置同时处理循环引用（跳过互相引用的对象）和深度限制问题。

方案2：使用DTO投影（推荐） #

直接返回EF Core实体不仅容易引发序列化问题，还可能暴露不必要的关联数据或敏感字段。更稳妥的方式是定义数据传输对象（DTO），仅保留前端需要的字段，通过EF查询投影到DTO：

1. 定义DTO类：

public class PmtaskDto
{
    // 仅保留Pmtask的必要属性
    public int Id { get; set; }
    public string TaskTitle { get; set; }
    
    // 关联对象也用对应DTO，避免深层嵌套
    public AssetDto Asset { get; set; }
    public TaskBasicDto Task { get; set; }
    public PmscheduleTypeDto PmscheduleType { get; set; }
}

public class AssetDto
{
    public int Id { get; set; }
    public string AssetName { get; set; }
    // 无需包含会引发循环或深层嵌套的属性（如AssetOdometers）
}

// 同理定义TaskBasicDto、PmscheduleTypeDto

2. 修改接口查询逻辑：

[HttpGet]
public async Task<ActionResult<IEnumerable<PmtaskDto>>> GetPmtasks()
{
    if (_context.Pmtasks == null)
    {
        return NotFound();
    }
    return await _context.Pmtasks
        .Select(t => new PmtaskDto
        {
            Id = t.Id,
            TaskTitle = t.TaskTitle,
            Asset = new AssetDto { Id = t.Asset.Id, AssetName = t.Asset.AssetName },
            Task = new TaskBasicDto { Id = t.Task.Id, TaskName = t.Task.TaskName },
            PmscheduleType = new PmscheduleTypeDto { Id = t.PmscheduleType.Id, TypeName = t.PmscheduleType.TypeName }
        })
        .ToListAsync();
}

此方式从根源上避免了循环引用和深度超限问题，还能精确控制返回数据的范围。

方案3：禁用EF Core延迟加载 #

如果你的DbContext启用了延迟加载（如使用UseLazyLoadingProxies），序列化时可能触发自动加载未Include的关联对象，导致深度超出限制。可在Program.cs中显式禁用：

builder.Services.AddDbContext<YourDbContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("YourConnString"))
           .UseLazyLoadingProxies(false));

为什么之前的配置不生效？ #

• 使用ReferenceHandler.IgnoreCycles时，序列化器会跳过循环引用，但如果对象嵌套深度刚好等于MaxDepth，仍会触发深度超限错误；
• 使用ReferenceHandler.Preserve时，虽然会保留对象引用，但同样受限于MaxDepth的层级限制，无法解决深度触顶的问题。

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