ASP.NET Core中EF Core加载Plan关联实体遇循环引用问题

一、补充外键属性（关联加载失效核心原因） #

你的Plan实体类未显式定义外键字段，EF Core无法正确识别关联关系的映射规则，导致Include方法无法加载关联实体。修改Plan类：

public class Plan
{
    public int PlanId { get; set; }
    // 添加对应导航属性的外键字段
    public int BuyerId { get; set; }
    public int SellerId { get; set; }
    public int RoomId { get; set; }

    public User Buyer { get; set; }
    public User Seller { get; set; }
    public Room Room { get; set; }

    public string Status { get; set; }
    public ICollection<Document> Documents { get; set; }
}

如果需要显式指定外键映射，可在OnModelCreating中补充：

modelBuilder.Entity<Plan>()
    .HasOne(a => a.Buyer)
    .WithMany(b => b.BuyerPlans)
    .HasForeignKey(a => a.BuyerId)
    .OnDelete(DeleteBehavior.Restrict);

modelBuilder.Entity<Plan>()
    .HasOne(a => a.Seller)
    .WithMany(b => b.SellerPlans)
    .HasForeignKey(a => a.SellerId)
    .OnDelete(DeleteBehavior.Restrict);

modelBuilder.Entity<Plan>()
    .HasOne(a => a.Room)
    .WithMany(b => b.Plans)
    .HasForeignKey(a => a.RoomId)
    .OnDelete(DeleteBehavior.Restrict);

二、修正关联实体加载代码 #

更新控制器查询逻辑，确保同时加载所有需要的关联实体：

[HttpGet(Name = "GetPlans")]
public async Task<IActionResult> Index()
{
    if (_context.Plans == null)
    {
        return Problem("Entity set 'YnynContext.Plans' is null.");
    }

    var plans = await _context.Plans
        .Include(p => p.Buyer)
        .Include(p => p.Seller)
        .Include(p => p.Room)
        .ToListAsync();

    return Ok(plans);
}

三、解决循环引用问题 #

加载关联实体后，User与Plan的双向导航属性会导致JSON序列化循环引用错误，可通过两种方式解决：

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

在.NET 6+的Program.cs中添加JSON序列化配置：

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

方案2：使用DTO避免循环 #

创建仅包含所需字段的数据传输对象（DTO），避免序列化双向导航属性：

public class PlanDTO
{
    public int PlanId { get; set; }
    public string Status { get; set; }
    public UserDTO Buyer { get; set; }
    public UserDTO Seller { get; set; }
    public RoomDTO Room { get; set; }
}

public class UserDTO
{
    public int UserId { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public string Email { get; set; }
}

public class RoomDTO
{
    public int RoomId { get; set; }
    public string Name { get; set; }
    public string Description { get; set; }
    public CategoryEnum Category { get; set; }
}

查询时投影到DTO：

var plans = await _context.Plans
    .Select(p => new PlanDTO
    {
        PlanId = p.PlanId,
        Status = p.Status,
        Buyer = new UserDTO
        {
            UserId = p.Buyer.UserId,
            FirstName = p.Buyer.FirstName,
            LastName = p.Buyer.LastName,
            Email = p.Buyer.Email
        },
        Seller = new UserDTO
        {
            UserId = p.Seller.UserId,
            FirstName = p.Seller.FirstName,
            LastName = p.Seller.LastName,
            Email = p.Seller.Email
        },
        Room = new RoomDTO
        {
            RoomId = p.Room.RoomId,
            Name = p.Room.Name,
            Description = p.Room.Description,
            Category = p.Room.Category
        }
    })
    .ToListAsync();

return Ok(plans);

四、验证数据完整性 #

确认数据库中Plan表的BuyerId、SellerId、RoomId字段已关联到User和Room表的有效主键值，如果外键字段为null，即使使用Include，返回的关联实体也会是null。

内容的提问来源于stack exchange，提问作者MA-Moustache