EF Core中BSDTUser表意外生成多余外键列问题排查

问题场景 #

配置EF Core实体的一对多关系时，生成的迁移代码中，BSDTUser表被自动添加了BSDTModelId和BSDTTemplateId两个外键列，这与预期的“一个用户拥有多个模型/模板”的一对多关系不符。

实体类定义 #

public class DatabaseEntity
{
    [Key]
    public Guid Id { get; set; }
}

public class BSDTUser : DatabaseEntity
{
    [Required]
    public string Username { get; set; }
    [Required]
    public string Email { get; set; }
    public ICollection<BSDTModel> Models { get; set; } = new List<BSDTModel>();
    public ICollection<BSDTTemplate> Templates { get; set; } = new List<BSDTTemplate>();
}

public class BSDTModel : DatabaseEntity
{
    [Required]
    public string Name { get; set; }

    [Required]
    public string InputJSON { get; set; }

    public string? OutputJSON { get; set; }
    public DateTime DateCreated { get; set; }
    public DateTime LastModified { get; set; }
    public bool IsPublic { get; set; }
    public List<BSDTUser> SharedTo { get; set; } = [];
    public string? ImageURL { get; set; }

    public Guid? OwnerID { get; set; }

    [ForeignKey(nameof(OwnerID))]
    public BSDTUser? Owner { get; set; }
}

public class BSDTTemplate : DatabaseEntity
{
    [Required]
    public string Name { get; set; }

    [Required]
    public string InputJSON { get; set; }

    public string? OutputJSON { get; set; }
    public DateTime DateCreated { get; set; }
    public DateTime LastModified { get; set; }

    public bool IsPublic { get; set; }
    public List<BSDTUser> SharedTo { get; set; } = [];
    public string? ImageURL { get; set; }

    public Guid? OwnerID { get; set; }

    [ForeignKey(nameof(OwnerID))]
    public BSDTUser? Owner { get; set; }
}

预期关系 #

• 一个BSDTUser对应多个BSDTModel（用户拥有多个模型）
• 一个BSDTUser对应多个BSDTTemplate（用户拥有多个模板）

已配置的关系代码 #

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    base.OnModelCreating(modelBuilder);

    modelBuilder.Entity<BSDTModel>(entity =>
    {
        entity.Property(e => e.Id).HasDefaultValueSql("NEWID()");
        entity.Property(e => e.InputJSON).HasColumnType("nvarchar(max)");
        entity.Property(e => e.OutputJSON).HasColumnType("nvarchar(max)");

        entity.HasOne(m => m.Owner)
            .WithMany(u => u.Models)
            .HasForeignKey(m => m.OwnerID);
    });

    modelBuilder.Entity<BSDTTemplate>(entity =>
    {
        entity.Property(e => e.Id).HasDefaultValueSql("NEWID()");
        entity.Property(e => e.InputJSON).HasColumnType("nvarchar(max)");
        entity.Property(e => e.OutputJSON).HasColumnType("nvarchar(max)");

        entity.HasOne(t => t.Owner)
            .WithMany(u => u.Templates)
            .HasForeignKey(t => t.OwnerID);
    });

    modelBuilder.Entity<BSDTUser>(entity =>
    {
        entity.Property(e => e.Id).HasDefaultValueSql("NEWID()");

        entity.HasMany(t => t.Models)
            .WithOne(u => u.Owner)
            .HasForeignKey(t => t.OwnerID);

        entity.HasMany(t => t.Templates)
            .WithOne(u => u.Owner)
            .HasForeignKey(t => t.OwnerID);
    });
}

异常的迁移代码 #

生成的BSDTUsers表包含了额外的外键列：

migrationBuilder.CreateTable(
    name: "BSDTUsers",
    columns: table => new
    {
        Id = table.Column<Guid>(type: "uniqueidentifier", nullable: false),
        Username = table.Column<string>(type: "nvarchar(max)", nullable: false),
        Email = table.Column<string>(type: "nvarchar(max)", nullable: false),
        BSDTModelId = table.Column<Guid>(type: "uniqueidentifier", nullable: true),
        BSDTTemplateId = table.Column<Guid>(type: "uniqueidentifier", nullable: true)
    },
    constraints: table =>
    {
        table.PrimaryKey("PK_BSDTUsers", x => x.Id);
        table.ForeignKey(
            name: "FK_BSDTUsers_BSDTModels_BSDTModelId",
            column: x => x.BSDTModelId,
            principalTable: "BSDTModels",
            principalColumn: "Id");
        table.ForeignKey(
            name: "FK_BSDTUsers_BSDTTemplates_BSDTTemplateId",
            column: x => x.BSDTTemplateId,
            principalTable: "BSDTTemplates",
            principalColumn: "Id");
    });

问题原因 #

问题出在BSDTModel和BSDTTemplate中的List<BSDTUser> SharedTo属性。EF Core的约定优先机制会自动将这个集合识别为单向一对多关系：默认认为一个BSDTModel对应多个BSDTUser，但因为没有指定反向导航属性和外键，EF Core会在BSDTUser表中自动生成外键列（BSDTModelId、BSDTTemplateId），这完全不符合实际要实现的关系。

解决方案 #

根据SharedTo的实际用途选择以下方案：

方案1：实现多对多关系（模型/模板共享给多个用户） #

如果SharedTo是为了实现“一个模型/模板可以共享给多个用户，一个用户可以拥有多个共享的模型/模板”的多对多关系，需要显式配置该关系：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    base.OnModelCreating(modelBuilder);

    // 原有一对多关系配置（保留其一即可，无需重复配置）
    modelBuilder.Entity<BSDTModel>(entity =>
    {
        entity.Property(e => e.Id).HasDefaultValueSql("NEWID()");
        entity.Property(e => e.InputJSON).HasColumnType("nvarchar(max)");
        entity.Property(e => e.OutputJSON).HasColumnType("nvarchar(max)");

        entity.HasOne(m => m.Owner)
            .WithMany(u => u.Models)
            .HasForeignKey(m => m.OwnerID);
    });

    modelBuilder.Entity<BSDTTemplate>(entity =>
    {
        entity.Property(e => e.Id).HasDefaultValueSql("NEWID()");
        entity.Property(e => e.InputJSON).HasColumnType("nvarchar(max)");
        entity.Property(e => e.OutputJSON).HasColumnType("nvarchar(max)");

        entity.HasOne(t => t.Owner)
            .WithMany(u => u.Templates)
            .HasForeignKey(t => t.OwnerID);
    });

    // 配置模型与用户的多对多共享关系
    modelBuilder.Entity<BSDTModel>()
        .HasMany(m => m.SharedTo)
        .WithMany() // 若不需要用户端的反向导航，保持为空即可
        .UsingEntity(j => j.ToTable("BSDTModelSharedUsers")); // 指定多对多中间表名

    // 配置模板与用户的多对多共享关系
    modelBuilder.Entity<BSDTTemplate>()
        .HasMany(t => t.SharedTo)
        .WithMany()
        .UsingEntity(j => j.ToTable("BSDTTemplateSharedUsers"));
}

方案2：删除无用的SharedTo属性 #

如果SharedTo是误添加的，或者不需要这个共享关系，直接删除BSDTModel和BSDTTemplate中的List<BSDTUser> SharedTo属性即可，EF Core将不再生成多余的外键列。

额外优化 #

原有代码中，BSDTUser的关系配置和BSDTModel/BSDTTemplate的配置是重复的，EF Core只需要一边配置即可生效，保留其中一组配置就能正确建立一对多关系，无需重复定义。

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