如何在Entity Framework中拆分臃肿的OnModelCreating并就近配置实体？

问题背景 #

我们希望为UserEntity的主键设置自定义约束名pk_users_id，而非Entity Framework默认生成的PK_Users。由于没有对应的特性（Attribute）可用，必须使用Fluent API实现。但当前将所有实体配置集中在OnModelCreating中会导致代码臃肿，而在实体类内添加静态配置方法的方式又属于反模式，因此需要一种合理的方式，将实体的Fluent API配置放在实体类附近，同时避免上述问题。

解决方案 #

方案1：实现IEntityTypeConfiguration<T>接口（官方推荐） #

这是EF Core官方提供的标准拆分配置方式，既保证配置与实体就近存放，又遵循设计原则：

1. 为每个实体创建独立的配置类，与实体类放在同一目录下：

// 与UserEntity.cs同目录的UserEntityConfiguration.cs
public class UserEntityConfiguration : IEntityTypeConfiguration<UserEntity>
{
    public void Configure(EntityTypeBuilder<UserEntity> builder)
    {
        builder
            .HasKey(user => user.Id)
            .HasName("pk_users_id");
        
        // 该实体的其他Fluent API配置也可在此添加
    }
}

2. 在DbContext中批量注册所有配置类，无需逐个手动调用：

public class AppDbContext : DbContext
{
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        // 自动扫描当前程序集中所有实现IEntityTypeConfiguration的配置类并应用
        modelBuilder.ApplyConfigurationsFromAssembly(typeof(AppDbContext).Assembly);

        base.OnModelCreating(modelBuilder);
    }

    public DbSet<UserEntity> Users { get; set; }
}

方案2：嵌套配置类（更紧密的就近存放） #

如果希望配置逻辑与实体类完全在同一文件中，可以将配置类作为实体的嵌套类：

public class UserEntity
{
    public int Id { get; set; }
    public string Name { get; set; } = "";

    // 嵌套配置类，与实体定义在同一文件内
    public class Configuration : IEntityTypeConfiguration<UserEntity>
    {
        public void Configure(EntityTypeBuilder<UserEntity> builder)
        {
            builder
                .HasKey(user => user.Id)
                .HasName("pk_users_id");
        }
    }
}

同样通过modelBuilder.ApplyConfigurationsFromAssembly批量注册即可，配置与实体的耦合性更强，完全实现就近存放的需求。

为什么静态配置方法是反模式？ #

实体类的核心职责是表示领域模型，静态配置方法会让实体类与EF的配置逻辑强耦合，违反单一职责原则。此外，静态方法难以进行单元测试，也不利于后续的扩展与维护，而IEntityTypeConfiguration的方式将配置逻辑抽离到独立类中，更符合代码设计规范。

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