EF Core中AspNetCore.Identity扩展的可空外键关系问题

核心思路 #

针对泛型TKey（支持值类型如int/Guid、引用类型如string），通过EF Core的泛型模型配置，解决ModifierId可空性、外键关联及派生类继承的问题，同时避免不必要的查询开销。

方案1：基类定义+统一泛型模型配置 #

1. 定义带审计字段的用户基类 #

public class CustomIdentityUser<TKey> : IdentityUser<TKey> where TKey : IEquatable<TKey>
{
    // 创建者ID（必填，用户创建时必须指定）
    public virtual TKey CreatorId { get; set; }
    // 修改者ID（可空，未修改时为null）
    public virtual TKey? ModifierId { get; set; }

    // 可选：按需保留导航属性（若需关联查询，可配置为惰性加载）
    public virtual CustomIdentityUser<TKey> Creator { get; set; }
    public virtual CustomIdentityUser<TKey>? Modifier { get; set; }
}

2. 在DbContext中统一配置泛型模型 #

protected override void OnModelCreating(ModelBuilder builder)
{
    base.OnModelCreating(builder);
    // 调用泛型配置方法
    ConfigureAuditableUser<TKey>(builder);
}

private void ConfigureAuditableUser<TKey>(ModelBuilder builder) where TKey : IEquatable<TKey>
{
    var userEntity = builder.Entity<CustomIdentityUser<TKey>>();

    // 配置CreatorId外键（关联自身表）
    userEntity.HasOne(u => u.Creator)
              .WithMany()
              .HasForeignKey(u => u.CreatorId)
              .OnDelete(DeleteBehavior.Restrict); // 避免循环级联删除

    // 配置ModifierId的可空性及外键
    var modifierIdProp = userEntity.Property(u => u.ModifierId);
    // 针对值类型TKey，显式设置非必填
    if (typeof(TKey).IsValueType)
    {
        modifierIdProp.IsRequired(false);
    }

    userEntity.HasOne(u => u.Modifier)
              .WithMany()
              .HasForeignKey(u => u.ModifierId)
              .OnDelete(DeleteBehavior.Restrict);
}

方案2：无导航属性的Shadow Property配置（避免查询开销） #

若仅需保留CreatorId/ModifierId字段，不需要导航属性，可通过Shadow Property配置外键约束，避免自动加载关联数据的开销：

1. 简化基类定义 #

public class CustomIdentityUser<TKey> : IdentityUser<TKey> where TKey : IEquatable<TKey>
{
    public virtual TKey CreatorId { get; set; }
    public virtual TKey? ModifierId { get; set; }
}

2. DbContext中的配置 #

private void ConfigureAuditableUser<TKey>(ModelBuilder builder) where TKey : IEquatable<TKey>
{
    var userEntity = builder.Entity<CustomIdentityUser<TKey>>();

    // 配置CreatorId外键（无导航属性）
    userEntity.HasOne<CustomIdentityUser<TKey>>()
              .WithMany()
              .HasForeignKey(u => u.CreatorId)
              .OnDelete(DeleteBehavior.Restrict);

    // 配置ModifierId可空及外键
    var modifierIdProp = userEntity.Property(u => u.ModifierId);
    if (typeof(TKey).IsValueType)
    {
        modifierIdProp.IsRequired(false);
    }

    userEntity.HasOne<CustomIdentityUser<TKey>>()
              .WithMany()
              .HasForeignKey(u => u.ModifierId)
              .OnDelete(DeleteBehavior.Restrict);
}

方案3：派生类（如ApplicationUser）的兼容配置 #

当其他应用继承CustomIdentityUser<TKey>实现自定义ApplicationUser时，可通过泛型扩展方法复用配置逻辑：

1. 创建配置扩展方法 #

public static class ModelBuilderExtensions
{
    public static void ConfigureAuditableUser<TUser, TKey>(this ModelBuilder builder) 
        where TUser : CustomIdentityUser<TKey>
        where TKey : IEquatable<TKey>
    {
        var userEntity = builder.Entity<TUser>();

        userEntity.HasOne<TUser>()
                  .WithMany()
                  .HasForeignKey(u => u.CreatorId)
                  .OnDelete(DeleteBehavior.Restrict);

        var modifierIdProp = userEntity.Property(u => u.ModifierId);
        if (typeof(TKey).IsValueType)
        {
            modifierIdProp.IsRequired(false);
        }

        userEntity.HasOne<TUser>()
                  .WithMany()
                  .HasForeignKey(u => u.ModifierId)
                  .OnDelete(DeleteBehavior.Restrict);
    }
}

2. 在派生类的DbContext中调用 #

protected override void OnModelCreating(ModelBuilder builder)
{
    base.OnModelCreating(builder);
    // 配置自定义ApplicationUser
    builder.ConfigureAuditableUser<ApplicationUser, int>();
}

关键注意事项 #

• 对于值类型TKey（如int/Guid），必须显式设置ModifierId的IsRequired(false)，EF Core才能生成可空字段；引用类型TKey（如string）则可通过TKey?直接实现可空。
• 外键的OnDelete需设置为Restrict，避免用户表自关联导致的循环级联删除异常。
• 无导航属性的配置方式可彻底避免额外查询开销，同时保留数据库外键约束。

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