EF Core 6/7中属性名匹配表名时必填列被设为可空的问题

我在EF Core 6.0/7.0中遇到一个问题：给实体类的string类型属性标记了[Required]注解，但生成的SQL建表语句里该列却是NULL，而非预期的NOT NULL。

具体触发场景：当属性名格式为[实体类名]Id（比如实体类MyTable的MyTableId属性），且对应的数据库表名和实体类名不一致（比如DbSet名为MyStuff对应表MyStuff）时，就会出现这个问题。但把属性名改成其他名称（比如Name），或者修改表名和实体名一致，就能正常生成NOT NULL列。这个问题在EF Core 5.0中是正常的。

异常的建表语句 #

实际生成的SQL：

CREATE TABLE [MyStuff] 
(
    [MyTableKey] bigint NOT NULL IDENTITY,
    [MyTableId] nvarchar(20) NULL,
    CONSTRAINT [PK_MyStuff] PRIMARY KEY ([MyTableKey])
);

复现代码 #

using System;
using System.ComponentModel.DataAnnotations;
using Microsoft.EntityFrameworkCore;

namespace EfTest
{
    public static class Program
    {
        public class MyDbContext : DbContext
        {
            public MyDbContext(DbContextOptions<MyDbContext> options)
                : base(options)
            {
            }

            public virtual DbSet<MyTable> MyStuff { get; set; }
        }

        public class MyTable
        {
            [Key]
            public long MyTableKey { get; set; }

            [Required]
            [MaxLength(20)]
            public string MyTableId { get; set; }
        }

        public static void Main()
        {
            var options = new DbContextOptionsBuilder<MyDbContext>()
                .UseSqlServer("Server=localhost;Database=ef;User Id=nope;Password=nope;")
                .Options;

            using (var dbContext = new MyDbContext(options))
            {
                var sql = dbContext.Database.GenerateCreateScript();

                Console.WriteLine(sql);
            }
        }
    }
}

解决办法 #

这个问题是EF Core 6+新增的约定行为导致的：当属性名符合[实体名]Id格式时，EF会默认将其识别为实体的备用键（Alternate Key），但在表名与实体名不一致的场景下，这个约定会干扰[Required]注解的生效，最终生成可空列。以下两种方式可以解决：

方法1：显式配置属性为必填，覆盖约定 #

在DbContext的OnModelCreating方法中，针对目标属性强制设置必填：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<MyTable>()
        .Property(t => t.MyTableId)
        .IsRequired(true);
}

方法2：全局禁用备用键自动识别约定 #

如果不需要这种自动识别备用键的约定，可以全局移除它，避免后续其他实体出现类似问题：

using Microsoft.EntityFrameworkCore.Metadata.Conventions;

// ...

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    // 禁用"实体名+Id"格式的备用键自动识别约定
    modelBuilder.Conventions.Remove<AlternateKeyConvention>();
}

验证效果 #

应用上述任一方法后，生成的建表语句会变为预期的：

CREATE TABLE [MyStuff] 
(
    [MyTableKey] bigint NOT NULL IDENTITY,
    [MyTableId] nvarchar(20) NOT NULL,
    CONSTRAINT [PK_MyStuff] PRIMARY KEY ([MyTableKey])
);

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