如何在Entity Framework Core中实现含导航属性的级联软删除

嘿，针对你说的EF Core里软删除主实体时要级联处理带IsDeleted的导航属性实体的需求，我给你整理了几种实用的实现方式，从简单到通用都有：

这种方式最直接，就是在标记主实体软删除的时候，手动遍历所有关联的导航属性，把它们的IsDeleted也设为true。举个例子：

// 先加载主实体及其关联的导航属性
var order = await _dbContext.Orders
    .Include(o => o.OrderItems) // 关联订单项
    .FirstOrDefaultAsync(o => o.Id == orderId);

if (order != null)
{
    // 标记主实体软删除
    order.IsDeleted = true;
    // 遍历所有关联实体，逐个标记
    foreach (var item in order.OrderItems)
    {
        item.IsDeleted = true;
    }
    await _dbContext.SaveChangesAsync();
}

优点是直观易懂，容易调试；缺点是如果关联关系复杂、层级多，代码会变得繁琐，而且容易遗漏关联实体。

EF Core提供了拦截器机制，可以在保存更改的环节自动处理级联软删除逻辑，一劳永逸。

首先我们先定义一个通用的软删除接口，让所有需要软删除的实体都实现它：

public interface ISoftDelete
{
    bool IsDeleted { get; set; }
}

比如你的主实体和导航属性实体都要实现这个接口：

public class Order : ISoftDelete
{
    public int Id { get; set; }
    public bool IsDeleted { get; set; }
    public ICollection<OrderItem> OrderItems { get; set; }
}

public class OrderItem : ISoftDelete
{
    public int Id { get; set; }
    public bool IsDeleted { get; set; }
    public int OrderId { get; set; }
    public Order Order { get; set; }
}

接下来创建一个拦截器类，在SavingChanges的时候自动处理级联软删除：

public class CascadeSoftDeleteInterceptor : SaveChangesInterceptor
{
    public override ValueTask<InterceptionResult<int>> SavingChangesAsync(
        DbContextEventData eventData,
        InterceptionResult<int> result,
        CancellationToken cancellationToken = default)
    {
        if (eventData.Context == null)
            return base.SavingChangesAsync(eventData, result, cancellationToken);

        // 找出所有被标记为软删除的实体（状态为Modified且IsDeleted=true）
        var deletedEntities = eventData.Context.ChangeTracker.Entries()
            .Where(e => e.State == EntityState.Modified
                        && e.Entity is ISoftDelete softDelete
                        && softDelete.IsDeleted)
            .Select(e => e.Entity as ISoftDelete);

        foreach (var entity in deletedEntities)
        {
            // 获取当前实体的所有导航属性（这里只处理ICollection类型的集合导航）
            var navProperties = eventData.Context.Model.FindEntityType(entity.GetType())
                .GetNavigations()
                .Where(n => n.ClrType.IsGenericType 
                            && n.ClrType.GetGenericTypeDefinition() == typeof(ICollection<>));

            foreach (var nav in navProperties)
            {
                // 获取导航属性对应的关联实体集合
                var relatedEntities = nav.GetGetter().GetClrValue(entity) as IEnumerable<ISoftDelete>;
                if (relatedEntities == null) continue;

                foreach (var related in relatedEntities)
                {
                    // 标记关联实体软删除，并设置状态为Modified
                    related.IsDeleted = true;
                    eventData.Context.Entry(related).State = EntityState.Modified;
                }
            }
        }

        return base.SavingChangesAsync(eventData, result, cancellationToken);
    }
}

最后在你的DbContext里注册这个拦截器：

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
    // 替换成你的数据库连接字符串
    optionsBuilder.UseSqlServer("YourConnectionString")
                  .AddInterceptors(new CascadeSoftDeleteInterceptor());
}

这样以后，只要你标记任意主实体的IsDeleted=true并调用SaveChangesAsync()，拦截器就会自动找到所有关联的导航属性实体，把它们也标记为软删除，完全不用手动处理。

如果你的关联是多层级的（比如Order→OrderItem→ItemDetail），可以把上面的导航属性处理改成递归方法，遍历所有层级的关联实体。

软删除后，我们通常希望查询时默认不返回已删除的实体。可以给所有实现ISoftDelete的实体添加全局查询过滤器：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    foreach (var entityType in modelBuilder.Model.GetEntityTypes())
    {
        if (typeof(ISoftDelete).IsAssignableFrom(entityType.ClrType))
        {
            // 创建查询过滤表达式：只返回IsDeleted=false的实体
            var parameter = Expression.Parameter(entityType.ClrType, "e");
            var filterExpression = Expression.Lambda(
                Expression.Not(Expression.Property(parameter, nameof(ISoftDelete.IsDeleted))),
                parameter);
            
            modelBuilder.Entity(entityType.ClrType).HasQueryFilter(filterExpression);
        }
    }
}

这样查询时，除非你显式调用IgnoreQueryFilters()，否则不会返回已软删除的实体，和级联软删除配合使用，体验会更好。

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