如何解决Repository模式下的主键映射异常？

问题背景 #

SQL表主键为_id，但Repository依赖的IEntity<TId>接口原本定义的是Id属性。修改接口属性为_id后，EF Core无法识别主键，即使添加[Key]注解也报错：

The entity type 'Address' requires a primary key to be defined. If you intended to use a keyless entity type, call 'HasNoKey' in 'OnModelCreating'. For more information on keyless entity types

解决方法 #

方法1：保持IEntity的Id属性，映射到数据库_id列 #

这种方式无需修改接口和Repository逻辑，仅通过EF Core的列映射解决数据库列名与实体属性名的差异。

实体类示例：

public class Account : IEntity<Guid>
{
    [Column("_id")] // 将实体的Id属性映射到数据库的_id列
    public Guid Id { get; set; }

    [Column("person_id")]
    public Guid PersonId { get; set; }

    [Column("groupRules_id")]
    public Guid GroupRulesId { get; set; }
}

若偏好Fluent API配置（在DbContext的OnModelCreating方法中）：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Account>()
        .Property(entity => entity.Id)
        .HasColumnName("_id");
}

方法2：修改IEntity为_id属性，显式配置主键 #

若必须保留实体的_id属性，需修改接口并强制EF Core识别该属性为主键。

1. 修改IEntity接口：

public interface IEntity<TId>
{
    public TId _id { get; set; }
}

2. 实体类添加[Key]注解，若注解无效，用Fluent API兜底：

public class Account : IEntity<Guid>
{
    [Key]
    public Guid _id { get; set; }

    [Column("person_id")]
    public Guid PersonId { get; set; }

    [Column("groupRules_id")]
    public Guid GroupRulesId { get; set; }
}

3. 在DbContext的OnModelCreating中显式配置主键确保生效：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Account>()
        .HasKey(entity => entity._id);
}

注意：需检查Repository抽象类中是否有依赖Id属性的代码如GetById方法，同步修改为_id。

方法3：全局配置EF Core识别_id为主键 #

如果多个实体都使用_id作为主键，可通过全局配置统一处理，避免逐个实体配置：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    foreach (var entityType in modelBuilder.Model.GetEntityTypes())
    {
        // 查找实体中的_id属性
        var idProperty = entityType.FindProperty("_id");
        if (idProperty != null)
        {
            // 将_id设置为该实体的主键
            entityType.SetPrimaryKey(idProperty);
        }
    }
}

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