如何全局重写EF自动生成Shadow Properties的外键命名规则？

针对你遇到的EF Core在生成外键时自动添加数字后缀（比如Class2_identifier1），而想要外键名称包含对应导航属性名的需求，最适合大规模模型的方案是自定义EF Core的约定逻辑，这样不需要逐个手动配置每个导航属性，全局生效。

实现步骤 #

1. 创建自定义外键命名约定类

这个类会在EF Core构建模型时，自动修改外键的命名规则，将导航属性名纳入外键名称中：

using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata;
using Microsoft.EntityFrameworkCore.Metadata.Conventions;

public class CustomForeignKeyNamingConvention : IForeignKeyAddedConvention
{
    public void ProcessForeignKeyAdded(
        IConventionForeignKeyBuilder foreignKeyBuilder,
        IConventionContext<IConventionForeignKeyBuilder> context)
    {
        var foreignKey = foreignKeyBuilder.Metadata;
        
        // 只处理EF自动生成的外键（避免覆盖手动配置的外键）
        if (foreignKey.Properties.Any(p => !p.IsForeignKey() || !p.Name.StartsWith($"{foreignKey.PrincipalEntityType.ShortName()}_")))
            return;

        // 获取关联的导航属性（holders/users）
        var navigation = foreignKey.PrincipalToDependent ?? foreignKey.DependentToPrincipal;
        if (navigation == null) return;

        // 构建目标外键名称：主实体名_导航属性名_主键名
        var principalEntityName = foreignKey.PrincipalEntityType.ShortName();
        var navigationName = navigation.Name;
        var principalKeyName = foreignKey.PrincipalKey.Properties.First().Name;
        var newForeignKeyName = $"{principalEntityName}_{navigationName}_{principalKeyName}";

        // 应用新的外键列名
        foreach (var property in foreignKey.Properties)
        {
            property.Builder.HasColumnName(newForeignKeyName);
        }
    }
}

2. 在DbContext中注册自定义约定

在EF Core 6及以上版本，可以通过ConfigureConventions方法轻松注册约定（这是推荐方式）：

public class YourDbContext : DbContext
{
    // DbSet定义
    public DbSet<Class1> Class1s { get; set; }
    public DbSet<Class2> Class2s { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        // 配置数据库连接
        optionsBuilder.UseSqlServer("YourConnectionString");
    }

    protected override void ConfigureConventions(ModelConfigurationBuilder configurationBuilder)
    {
        // 添加自定义外键命名约定
        configurationBuilder.Conventions.Add(_ => new CustomForeignKeyNamingConvention());
    }
}

如果是EF Core 5及更早版本，需要在OnModelCreating中修改约定集：

using Microsoft.EntityFrameworkCore.Metadata.Conventions.Infrastructure;

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    // 获取默认约定集，添加自定义约定（避免丢失其他默认约定）
    var conventionSet = ConventionSet.CreateConventionSet(modelBuilder.ModelBuilder);
    conventionSet.ForeignKeyAddedConventions.Add(new CustomForeignKeyNamingConvention());
    modelBuilder.ModelBuilder.HasAnnotation(CoreAnnotationNames.ConventionsSet, conventionSet);
}

生效方式 #

1. 删除之前生成的旧迁移文件（如果有的话）
2. 重新运行add-migration命令，此时EF Core会按照自定义的规则生成外键名称，比如Class2_holders_identifier和Class2_users_identifier，完全符合你的需求。

注意事项 #

• 这个约定只会处理EF自动生成的外键，不会覆盖你手动通过Fluent API或数据注解配置的外键名称
• 可以根据自己的需求调整newForeignKeyName的格式，比如修改分隔符、调整名称顺序等

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