Entity Framework中如何为Add/Attach实现类似TagWith的拦截标识？

因为DbSet.Add/Attach没有自带的TagWith扩展，我们可以通过自定义扩展方法给实体条目加标记，再结合拦截器识别并修改SQL命令，具体步骤如下：

1. 给EntityEntry加自定义标记扩展 #

通过EntityEntry的元数据注解存储标记，把标记和具体实体绑定：

public static class EntityEntryExtensions
{
    private const string CustomTagKey = "CommandHintTag";

    // 给实体条目添加命令标记
    public static EntityEntry AddCommandHint(this EntityEntry entry, string hint)
    {
        entry.Metadata.AddAnnotation(CustomTagKey, hint);
        return entry;
    }

    // 获取实体条目上的命令标记
    public static string? GetCommandHint(this EntityEntry entry)
    {
        return entry.Metadata.FindAnnotation(CustomTagKey)?.Value?.ToString();
    }
}

2. 标记要处理的实体 #

在Add/Attach实体时调用扩展方法，给特定实体打上标记：

var newBlog = new Blog { Title = "My Blog" };
// 添加实体并标记需要ROWLOCK提示
context.Blogs.Add(newBlog).AddCommandHint("NeedRowLock");
await context.SaveChangesAsync();

3. 编写拦截器识别标记并修改SQL #

继承SaveChangesInterceptor，在保存变更前遍历实体获取标记，然后在命令生成阶段修改SQL：

public class CommandHintInterceptor : SaveChangesInterceptor
{
    private string? _currentHint;

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

        // 从待变更的实体中提取标记
        var targetEntry = context.ChangeTracker.Entries()
            .FirstOrDefault(e => (e.State == EntityState.Added || e.State == EntityState.Modified) 
                                 && e.GetCommandHint() == "NeedRowLock");
        
        if (targetEntry != null)
        {
            _currentHint = targetEntry.GetCommandHint();
        }

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

    public override InterceptionResult<DbCommand> CommandCreating(
        CommandCorrelatedEventData eventData,
        InterceptionResult<DbCommand> result)
    {
        var command = result.Result;
        if (!string.IsNullOrEmpty(_currentHint) && command.CommandText.StartsWith("INSERT", StringComparison.OrdinalIgnoreCase))
        {
            // 给INSERT语句加上ROWLOCK提示
            command.CommandText += " WITH (ROWLOCK)";
            // 重置标记，避免影响后续命令
            _currentHint = null;
        }
        return base.CommandCreating(eventData, result);
    }
}

4. 注册拦截器到DbContext #

在DbContext的配置方法里添加这个拦截器：

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
    optionsBuilder.UseSqlServer("你的数据库连接字符串")
                  .AddInterceptors(new CommandHintInterceptor());
}

这样就能精准识别带有特定标记的Insert命令，并在拦截器中修改SQL语句了。

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