如何通过OnModelCreating为EF Core外键设置自定义命名

问题根源 #

• Classes类主键命名不匹配：你在Classes类中定义的主键为ClassedId，但关联表StudentClasses中对应的外键字段是ClassId，二者命名不一致，EF Core无法识别你显式配置的外键，就会自动生成带导航属性前缀的默认外键。
• 多余导航属性冲突：Classes类中同时存在ICollection<Students> Students和ICollection<StudentClasses> StudentClasses两个集合导航属性，EF Core会将前者识别为另一套未显式配置的一对多关系，额外生成对应外键，就是你截图中看到的带冗余前缀的字段。

解决步骤 #

1. 修正字段命名冲突
   修改Classes类的主键命名，和关联表外键保持一致，同时删除多余的直接关联导航属性：

public class Classes
{
    [Key]
    // 将原ClassedId修改为ClassId，和StudentClasses中的外键名称匹配
    public int ClassId { get; set; }
    public Guid? UserId { get; set; }
    // 删除多余的直接关联导航属性：public ICollection<Students> Students { get; set; }
    public DateTime? StartDate { get; set; }
    public DateTime? EndDate { get; set; }
    public ICollection<StudentClasses> StudentClasses { get; set; }
    // 其余原有属性保持不变
    public bool? IsDeleted { get; set; }
    public bool? IsActive { get; set; }
    public string? CreatedBy { get; set; }
    public string? LastModifiedBy { get; set; }
    public DateTime? LastUpdatedDate { get; set; }
    public DateTime? CreatedDate { get; set; }
}

2. 显式指定外键约束名（可选）
   如果你需要完全控制外键的命名，可以在Fluent API配置中新增HasConstraintName方法手动指定：

modelBuilder.Entity<StudentClasses>()
            .HasKey(bc => new { bc.StudentId, bc.ClassId });

modelBuilder.Entity<StudentClasses>()
            .HasOne(bc => bc.Students)
            .WithMany(b => b.StudentClasses)
            .HasForeignKey(bc => bc.StudentId)
            // 自定义外键约束名
            .HasConstraintName("FK_StudentClasses_Students_StudentId");

modelBuilder.Entity<StudentClasses>()
            .HasOne(bc => bc.Classes)
            .WithMany(c => c.StudentClasses)
            .HasForeignKey(bc => bc.ClassId)
            .HasConstraintName("FK_StudentClasses_Classes_ClassId");

3. 全局统一外键命名规则（可选）
   如果希望项目所有外键都遵循统一命名规则，可以在OnModelCreating方法末尾添加全局约定，不需要逐个配置：

// 全局配置外键命名规则
foreach (var entityType in modelBuilder.Model.GetEntityTypes())
{
    foreach (var foreignKey in entityType.GetForeignKeys())
    {
        var foreignKeyName = $"FK_{foreignKey.DeclaringEntityType.ClrType.Name}_{foreignKey.PrincipalEntityType.ClrType.Name}_{foreignKey.Properties.First().Name}";
        foreignKey.SetConstraintName(foreignKeyName);
    }
}

修改完成后，删除旧的迁移文件，重新执行Add-Migration和Update-Database命令，生成的外键名称就会符合预期。

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