EF Core报错：实体类型CafeId需定义主键的问题解决问询

报错信息：

The entity type 'CafeId' requires a primary key to be defined. If you intended to use a keyless entity type, call 'HasNoKey' in 'OnModelCreating'.

实体代码 #

Cafe 实体 #

public class Cafe : Entity<CafeId>
{
    private Cafe() : base(default!) { }

    private Cafe(
        CafeId cafeId,
        string name,
        string description,
        string location) : base(cafeId)
    {
        CafeId = cafeId;
        Name = name;
        Description = description;
        Location = location;
    }

    public CafeId CafeId { get; private set; }
    public string Name { get; private set; }
    public string Description { get; private set; }
    public string Location { get; private set; }
    public string? Logo { get; private set; }

    public static Result<Cafe> Create(
        string name,
        string description,
        string location,
        string? logo = null)
    {
        if (string.IsNullOrEmpty(name))
        {
            return Result.Failure<Cafe>(DomainError.Cafe.EmptyName);
        }

        var cafe = new Cafe(
            CafeId.GenerateID(),
            name,
            description,
            location)
        {
            Logo = logo
        };

        return cafe;
    }
}

CafeId 记录 #

public record CafeId
{
    private CafeId() { }

    public CafeId(Guid value) => Value = value;

    public static CafeId GenerateID() => new(Guid.NewGuid());

    public Guid Value { get; }

    public static Result<CafeId> Create(Guid value)
    {
        if (value == Guid.Empty)
        {
            return Result.Failure<CafeId>(Error.Null);
        }

        return new CafeId(value);
    }
}

实体配置 #

public class DbSetCafe : IEntityTypeConfiguration<Cafe>
{
    public void Configure(EntityTypeBuilder<Cafe> builder) 
    {
        builder.ToTable("cafe");

        builder.HasKey(c => c.CafeId);
        builder.Property(c => c.CafeId)
             .HasConversion<CafeIdConvertor>();
        
        builder.Property(c => c.Name)
            .HasMaxLength(100)
            .IsRequired();

        builder.Property(c => c.Description)
            .HasMaxLength(500)
            .IsRequired();

        builder.Property(c => c.Location)
            .HasMaxLength(200)
            .IsRequired();

        builder.Property(c => c.Logo)
            .HasMaxLength(2000);

        builder.HasMany<Employee>()
            .WithOne()
            .HasForeignKey("CafeId")
            .OnDelete(DeleteBehavior.Cascade);
    }
}

转换器 #

public class CafeIdConvertor : ValueConverter<CafeId, Guid>
{
    public CafeIdConvertor() : base(IN => IN.Value,
        OUT => new CafeId(OUT))
    {
    }
}

Entity 实体基类 #

public abstract class Entity<TId> : IEquatable<Entity<TId>> where TId : notnull
{
    protected Entity(TId id) => Id = id;

    public TId Id { get; private init; }

    public static bool operator ==(Entity<TId>? first, Entity<TId>? second) => first is not null && second is not null && first.Equals(second);

    public static bool operator !=(Entity<TId>? first, Entity<TId> second) => !(first == second);

    public override bool Equals(object? obj)
    {
        if (obj == null)
        {
            return false;
        }

        if (obj.GetType() != GetType())
        {
            return false;
        }

        if (obj is not Entity<TId> entity)
        {
            return false;
        }

        return EqualityComparer<TId>.Default.Equals(entity.Id, Id);
    }

    public bool Equals(Entity<TId>? other)
    {
        if (other == null)
        {
            return false;
        }

        if (other.GetType() != GetType())
        {
            return false;
        }

        return EqualityComparer<TId>.Default.Equals(other.Id, Id);
    }

    public override int GetHashCode() => Id.GetHashCode();
}

DBContext 类 #

public class EmployeeDBContext : DbContext
{
    public EmployeeDBContext(DbContextOptions<EmployeeDBContext> options) 
        : base(options) { }
    
    public DbSet<Employee> Employee { get; set; }
    public DbSet<Cafe> Cafe { get; set; }

    protected override void OnModelCreating(ModelBuilder modelBuilder) 
    {
        modelBuilder.ApplyConfigurationsFromAssembly(GetType().Assembly);
        base.OnModelCreating(modelBuilder); 
    } 
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) 
    {
        optionsBuilder.UseSnakeCaseNamingConvention();
        optionsBuilder.EnableSensitiveDataLogging();
    }
}

已尝试方案 #

• 将CafeID定义为record类型，但EF Core仍将其视为实体而非值对象
• 使用ValueConverter（CafeIdConvertor）将CafeID映射为Guid

提问 #

请问在EF Core中使用强类型ID，确保其被正确识别的推荐方案是什么？

EF Core将CafeId识别为实体而非值对象，核心原因是未明确告知EF Core这是一个值对象。以下是几种推荐的处理方案：

方案1：显式排除CafeId作为实体 #

在OnModelCreating中直接指定忽略该类型，强制EF Core将其视为值对象：

protected override void OnModelCreating(ModelBuilder modelBuilder) 
{
    modelBuilder.ApplyConfigurationsFromAssembly(GetType().Assembly);
    // 排除CafeId作为实体类型
    modelBuilder.Ignore<CafeId>();
    base.OnModelCreating(modelBuilder); 
}

这是最直接的临时解决方式，快速阻断EF Core对该类型的实体识别逻辑。

方案2：使用EF Core 8+原生强类型ID支持 #

如果使用EF Core 8及以上版本，官方提供了原生强类型ID支持，无需手动编写转换器：

1. 修改CafeId实现IStronglyTypedId接口（需引用Microsoft.EntityFrameworkCore包）：

public record CafeId(Guid Value) : IStronglyTypedId;

2. 移除实体配置中的手动转换器代码，EF Core会自动处理类型映射：

builder.HasKey(c => c.CafeId);
// 移除.HasConversion<CafeIdConvertor>()配置

这是官方推荐的现代方案，代码更简洁且兼容性更好。

方案3：完善旧版本EF Core的值对象配置 #

若使用EF Core 7及以下版本，除了保留ValueConverter，还需双重确保EF Core不将其识别为实体：

1. 确保CafeId未被注册为DbSet（当前代码已满足）
2. 实体配置中明确列类型，同时加上忽略配置：

builder.Property(c => c.CafeId)
    .HasConversion<CafeIdConvertor>()
    .HasColumnType("uniqueidentifier");

并在OnModelCreating中添加modelBuilder.Ignore<CafeId>()。

额外优化：移除冗余属性 #

你的Cafe实体同时继承Entity<CafeId>并拥有CafeId属性，属于冗余设计。可修改Cafe实体直接使用基类的Id属性：

public class Cafe : Entity<CafeId>
{
    private Cafe() : base(default!) { }

    private Cafe(
        CafeId cafeId,
        string name,
        string description,
        string location) : base(cafeId)
    {
        Name = name;
        Description = description;
        Location = location;
    }

    // 移除重复的CafeId属性，使用基类的Id
    public string Name { get; private set; }
    public string Description { get; private set; }
    public string Location { get; private set; }
    public string? Logo { get; private set; }

    // Create方法保持不变
}

实体配置中调整主键指向基类Id：

builder.HasKey(c => c.Id);
builder.Property(c => c.Id)
    .HasConversion<CafeIdConvertor>()
    .HasColumnName("cafe_id");

该优化可避免冗余属性带来的潜在映射冲突。

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