一对一关联实体用Include查询时出现对象循环引用异常问题

问题根源 #

你的TableA和TableB实体互相包含对方的引用，EF Core查询时通过Include(x => x.TableA)加载关联数据后，返回的对象形成了循环引用链（TableB → TableA → TableB → ……），System.Text.Json序列化器无法处理这种循环结构，因此抛出异常。

解决方法 #

1. 使用DTO（数据传输对象）推荐 #

定义只包含业务所需字段的DTO类，切断循环引用链：

// TableB的DTO
public class TableBDto
{
    public int Id { get; set; }
    public string? Title { get; set; }
    public TableADto? TableA { get; set; }
}

// TableA的DTO
public class TableADto
{
    public int Id { get; set; }
    public string? Item { get; set; }
    // 不包含TableB属性，避免循环
}

修改查询代码，将实体映射为DTO后返回：

[HttpGet("{id}")]
public ActionResult GetById(int id)
{
    using(var db=new ExampleContext())
    {
        var data = db.TableBs.Include(x => x.TableA)
            .Select(x => new TableBDto
            {
                Id = x.Id,
                Title = x.Title,
                TableA = new TableADto
                {
                    Id = x.TableA.Id,
                    Item = x.TableA.Item
                }
            })
            .FirstOrDefault(x => x.Id == id);
        return Ok(data);
    }
}

这种方式能精确控制返回数据结构，避免不必要的字段泄露，是最规范的解决方案。

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

在项目的启动文件（Program.cs/Startup.cs）中添加Json序列化配置：

// .NET 6+ Program.cs示例
builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles;
    });

此方法无需修改实体或查询代码，序列化器会自动跳过循环引用的部分，但无法自定义返回字段，可能导致数据截断。

3. 用特性标记忽略序列化的关联属性 #

在实体类的循环引用属性上添加[JsonIgnore]特性，让序列化器跳过该属性：

public partial class TableA
{
    public int Id { get; set; }
    public string? Item { get; set; }
    [JsonIgnore] // 序列化时忽略TableB属性
    public virtual TableB? TableB { get; set; }
}

此方法简单直接，但灵活性差，后续若需要序列化该属性需修改实体代码。

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