EF Code-First迁移未检测到外键关系变更求助

背景与已执行步骤 #

需要在已上线的生产环境数据库中，为两个现有表添加必填外键关系，已执行以下操作：

1. 首次迁移为Company表添加可空Guid类型的RegistryId列，随后用自定义SQL脚本填充了该列的对应值；
2. 更新模型将RegistryId设为非空，生成的新迁移自动为该列添加了索引，此步骤执行正常；
3. 在Company和Registry的模型配置类中配置了双向导航的外键关系，但生成新迁移时，EF始终无法检测到这些模型和配置的变更。

相关模型与配置代码 #

Company 模型 #

public class Company
{
    /// <summary>
    /// Gets or sets the unique identifier of the <see cref="Company"/>.
    /// </summary>
    public Guid Id { get; set; } = Guid.NewGuid();

    /// <summary>
    /// Gets or sets the name of the <see cref="Company"/>.
    /// </summary>
    public string Name { get; set; } = string.Empty;

    /// <summary>
    /// Gets or sets the unique identifier of the <see cref="Group"/> to which the <see cref="Company"/> belongs.
    /// </summary>
    public Guid? GroupId { get; set; }

    /// <summary>
    /// Gets or sets the unique identifier of the <see cref="Registry"/> from which the <see cref="Company"/> entity was created.
    /// </summary>
    public Guid RegistryId { get; set; }

    /// <summary>
    /// Gets the date and time at which the <see cref="Company"/> was created.
    /// </summary>
    public DateTime CreatedAt { get; } = DateTime.UtcNow;

    /// <summary>
    /// Gets or sets the unique identifier of the user who created the <see cref="Company"/>.
    /// </summary>
    public Guid CreatedBy { get; set; } = Guid.Empty;

    /// <summary>
    /// Gets or sets the date and time at which the <see cref="Company"/> was last updated.
    /// </summary>
    public DateTime UpdatedAt { get; set; } = DateTime.UtcNow;

    /// <summary>
    /// Gets or sets a concurrency token used to prevent conflicting edits in a <see cref="Company"/> entity.
    /// </summary>
    [SuppressMessage("ReSharper", "PropertyCanBeMadeInitOnly.Global", Justification = "Used by Entity Framework.")]
    public byte[] RowVersion { get; set; } = null!;

    /// <summary>
    /// Gets or sets the <see cref="Group"/> to which the <see cref="Company"/> is linked through <see cref="GroupId"/>.
    /// </summary>
    public Group? Group { get; set; }

    /// <summary>
    /// Gets or sets the <see cref="Registry"/> to which the <see cref="Company"/> is linked through <see cref="RegistryId"/>.
    /// </summary>
    public Registry Registry { get; set; } = null!;

    /// <summary>
    /// Gets or sets a collection of <see cref="SystemIdentifier"/> linked to this <see cref="Company"/>.
    /// </summary>
    public ICollection<SystemIdentifier> SystemIdentifiers { get; set; } = null!;

    /// <summary>
    /// Gets or sets a collection of <see cref="User"/> linked to this <see cref="Company"/>.
    /// </summary>
    public ICollection<User> Users { get; set; } = null!;

    /// <summary>
    /// Gets or sets a collection of <see cref="Permission"/> linked to this <see cref="Company"/>.
    /// </summary>
    public ICollection<Permission> Permissions { get; set; } = null!;
}

Registry 模型 #

public class Registry
{
    /// <summary>
    /// Gets or sets the unique identifier of the <see cref="Registry"/>.
    /// </summary>
    public Guid Id { get; set; } = Guid.NewGuid();

    /// <summary>
    /// Gets or sets a token required to verify the <see cref="Registry"/>.
    /// </summary>
    public string? RegistrationToken { get; set; }

    /// <summary>
    /// Gets or sets the name of the company to which the registered client belongs.
    /// </summary>
    public string? CompanyName { get; set; }

    /// <summary>
    /// Gets or sets a JSON string containing a list of requested users.
    /// </summary>
    public string? RequestedUsers { get; set; }

    /// <summary>
    /// Gets or sets a value indicating whether the specified user in the registry are handled.
    /// </summary>
    public bool IsHandled { get; set; }

    /// <summary>
    /// Gets or sets a concurrency token used to prevent conflicting edits to a <see cref="Registry"/> entity.
    /// </summary>
    public byte[] RowVersion { get; set; } = null!;

    /// <summary>
    /// Gets or sets the date and time at which the <see cref="Registry"/> was created.
    /// </summary>
    public DateTime CreatedAt { get; set; } = DateTime.UtcNow;

    /// <summary>
    /// Gets or sets the date and time at which the <see cref="Registry"/> was last updated.
    /// </summary>
    public DateTime UpdatedAt { get; set; } = DateTime.UtcNow;

    /// <summary>
    /// Gets or sets a collection of <see cref="RegistryAgreement"/> entities linked to the <see cref="Registry"/>.
    /// </summary>
    public ICollection<RegistryAgreement> Agreements { get; set; } = null!;

    /// <summary>
    /// Gets or sets a collection fo <see cref="Company"/> entities linked to the <see cref="Registry"/>.
    /// </summary>
    public ICollection<Company> Companies { get; set; } = null!;
}

CompanyConfiguration 配置类 #

public class CompanyConfiguration : IEntityTypeConfiguration<Company>
{
    /// <inheritdoc />
    public void Configure(EntityTypeBuilder<Company> builder)
    {
        builder = builder ?? throw new ArgumentNullException(nameof(builder));

        builder.HasKey(c => c.Id);
        builder.Property(c => c.Id)
            .HasDefaultValueSql("NEWID()");

        builder.Property(c => c.Name)
            .IsRequired()
            .HasMaxLength(75);

        builder.Property(c => c.RegistryId)
            .IsRequired();

        builder.Property(c => c.CreatedAt)
            .HasDefaultValueSql("getdate()")
            .ValueGeneratedOnAdd()
            .IsRequired();

        builder.Property(c => c.CreatedBy)
            .IsRequired();

        builder.Property(c => c.UpdatedAt)
            .HasDefaultValueSql("getdate()")
            .ValueGeneratedOnAddOrUpdate()
            .IsRequired();

        builder.Property(c => c.RowVersion)
            .IsRowVersion();

        builder.HasOne(c => c.Group)
            .WithMany(g => g.Companies)
            .HasForeignKey(c => c.GroupId)
            .OnDelete(DeleteBehavior.SetNull)
            .IsRequired(false);

        builder.HasOne(c => c.Registry)
            .WithMany(r => r.Companies)
            .HasForeignKey(c => c.RegistryId)
            .OnDelete(DeleteBehavior.Restrict)
            .IsRequired();

        builder.HasMany(c => c.Permissions)
            .WithOne(p => p.Company)
            .HasForeignKey(p => p.CompanyId)
            .OnDelete(DeleteBehavior.NoAction)
            .IsRequired(false);

        builder.HasMany(c => c.SystemIdentifiers)
            .WithOne(si => si.Company)
            .HasForeignKey(si => si.CompanyId)
            .OnDelete(DeleteBehavior.NoAction)
            .IsRequired(false);
    }
}

RegistryConfiguration 配置类 #

public class RegistryConfiguration : IEntityTypeConfiguration<Registry>
{
    /// <inheritdoc />
    public void Configure(EntityTypeBuilder<Registry> builder)
    {
        builder = builder ?? throw new ArgumentNullException(nameof(builder));

        builder.HasKey(r => r.Id);
        builder.Property(r => r.Id)
            .HasDefaultValueSql("NEWID()")
            .ValueGeneratedOnAdd()
            .IsRequired();

        builder.Property(r => r.IsHandled)
            .ValueGeneratedOnAdd()
            .HasDefaultValueSql("0")
            .HasColumnType("bit")
            .IsRequired();

        builder.Property(r => r.CreatedAt)
            .HasDefaultValueSql("getdate()")
            .ValueGeneratedOnAdd()
            .IsRequired();

        builder.Property(r => r.UpdatedAt)
            .HasDefaultValueSql("getdate()")
            .ValueGeneratedOnAddOrUpdate()
            .IsRequired();

        builder.Property(r => r.RowVersion)
            .IsRowVersion();

        builder.HasMany(r => r.Agreements)
            .WithOne(ra => ra.Registry)
            .HasForeignKey(ra => ra.RegistryId)
            .OnDelete(DeleteBehavior.NoAction);

        builder.HasMany(r => r.Companies)
            .WithOne(c => c.Registry)
            .HasForeignKey(c => c.RegistryId)
            .OnDelete(DeleteBehavior.NoAction);
    }
}

已尝试但无效的解决方案 #

• 直接生成新迁移：EF无法检测到任何变更；
• 回滚到倒数第二个迁移，删除并重新生成最后一个迁移：仍无法检测到外键关系的变更；
• 回滚到倒数第二个迁移，删除最后一个迁移并手动修改快照后生成新迁移：EF报错找不到导航属性，但该属性已在模型中明确定义。

可行解决方案 #

1. 检查并修复EF迁移快照 #

打开项目中的YourDbContextModelSnapshot.cs文件，确认Company实体的配置中是否已经包含了Registry外键的定义。如果快照未同步配置类的更改，手动添加以下代码（与配置类逻辑保持一致）：

// 在Company的实体配置节点内添加
builder.HasOne(t => t.Registry)
    .WithMany(t => t.Companies)
    .HasForeignKey(d => d.RegistryId)
    .OnDelete(DeleteBehavior.Restrict)
    .IsRequired();

保存快照后，重新尝试生成迁移。

2. 手动创建空迁移并编写外键SQL #

既然EF自动检测失效，直接手动生成空迁移并添加外键创建逻辑：

1. 执行命令生成空迁移：

   dotnet ef migrations add AddRegistryCompanyForeignKey --empty
   

2. 打开生成的迁移文件，修改Up和Down方法：

   protected override void Up(MigrationBuilder migrationBuilder)
   {
       // 注意替换表名和约束名为你的数据库实际命名
       migrationBuilder.AddForeignKey(
           name: "FK_Companies_Registries_RegistryId",
           table: "Companies",
           column: "RegistryId",
           principalTable: "Registries",
           principalColumn: "Id",
           onDelete: ReferentialAction.Restrict);
   }
   
   protected override void Down(MigrationBuilder migrationBuilder)
   {
       migrationBuilder.DropForeignKey(
           name: "FK_Companies_Registries_RegistryId",
           table: "Companies");
   }
   

3. 执行迁移应用到数据库：

   dotnet ef database update
   

3. 验证数据完整性 #

添加外键前，必须确保Companies表中所有RegistryId的值都存在于Registries表的Id列中，否则外键创建会失败。执行以下SQL检查数据：

SELECT * FROM Companies c 
LEFT JOIN Registries r ON c.RegistryId = r.Id 
WHERE r.Id IS NULL;

如果查询返回结果，先修复这些无效数据（比如填充正确的RegistryId或删除无效记录）。

4. 清理编译缓存 #

删除项目的bin和obj目录，重新编译项目，再尝试生成迁移。编译缓存可能导致EF读取旧的模型配置，无法识别新的外键关系。

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