如何在IDbCommandTreeInterceptors与IDbCommandInterceptors间共享状态？

我之前在处理EF拦截器的时候也遇到过这个头疼的问题——确实DbCommandTreeInterceptionContext和DbCommandInterceptionContext的UserState是完全独立的，EF内部不会自动把状态从前者传递到后者，所以得靠外部机制来实现共享。下面是几个经过实践验证的方案：

1. 利用DbContext的Items集合（最稳妥的同步/简单异步场景） #

每个EF操作都会关联一个DbContext，而DbContext.Items是一个内置的键值对集合，专门用来存储当前上下文的临时状态。它的优势是和当前EF操作完全绑定，不会出现跨操作的状态污染。

代码示例： #

首先定义你的共享状态类：

public class MySharedState
{
    public string OperationId { get; set; }
    public string CustomData { get; set; }
}

在DbCommandTreeInterceptor中存储状态：

public class CustomCommandTreeInterceptor : IDbCommandTreeInterceptor
{
    // 用一个唯一的静态对象当键，避免和其他代码冲突
    private static readonly object SharedStateKey = new object();

    public void TreeCreated(DbCommandTreeInterceptionContext interceptionContext)
    {
        // 获取当前操作关联的DbContext
        var dbContext = interceptionContext.DbContexts.FirstOrDefault();
        if (dbContext == null) return;

        // 创建并存储共享状态
        var sharedState = new MySharedState
        {
            OperationId = Guid.NewGuid().ToString(),
            CustomData = "从CommandTree拦截器传递的状态"
        };
        dbContext.Items[SharedStateKey] = sharedState;
    }
}

在DbCommandInterceptor中读取状态：

public class CustomCommandInterceptor : DbCommandInterceptor
{
    private static readonly object SharedStateKey = new object();

    public override void ReaderExecuting(DbCommand command, DbCommandInterceptionContext<DbDataReader> interceptionContext)
    {
        var dbContext = interceptionContext.DbContexts.FirstOrDefault();
        if (dbContext == null) return;

        // 读取共享状态
        var sharedState = dbContext.Items[SharedStateKey] as MySharedState;
        if (sharedState != null)
        {
            // 在这里使用状态，比如打日志、修改Command参数等
            Console.WriteLine($"当前操作ID：{sharedState.OperationId}");
            
            // 用完记得移除，避免占用DbContext的内存
            dbContext.Items.Remove(SharedStateKey);
        }

        base.ReaderExecuting(command, interceptionContext);
    }
}

2. 使用AsyncLocal（复杂异步场景首选） #

如果你的项目大量使用异步EF操作，或者存在多层异步调用嵌套，AsyncLocal<T>会是更好的选择。它是.NET提供的异步本地存储机制，能在整个异步调用流中保留状态，不会因为线程切换而丢失。

代码示例： #

先创建一个静态的状态持有类：

public static class InterceptorStateHolder
{
    // AsyncLocal会自动跟踪异步上下文
    public static AsyncLocal<MySharedState> CurrentSharedState { get; } = new AsyncLocal<MySharedState>();
}

在DbCommandTreeInterceptor中设置状态：

public void TreeCreated(DbCommandTreeInterceptionContext interceptionContext)
{
    InterceptorStateHolder.CurrentSharedState.Value = new MySharedState
    {
        OperationId = Guid.NewGuid().ToString(),
        CustomData = "异步场景下的共享状态"
    };
}

在DbCommandInterceptor中读取并清理状态：

public override void ReaderExecuting(DbCommand command, DbCommandInterceptionContext<DbDataReader> interceptionContext)
{
    var sharedState = InterceptorStateHolder.CurrentSharedState.Value;
    if (sharedState != null)
    {
        // 使用状态
        Console.WriteLine($"异步操作ID：{sharedState.OperationId}");
        
        // 必须清空状态，否则会污染后续的异步操作
        InterceptorStateHolder.CurrentSharedState.Value = null;
    }

    base.ReaderExecuting(command, interceptionContext);
}

3. 利用DbCommand的Tag属性（轻量备选方案） #

DbCommand本身有一个Tag属性，可以用来存储任意对象。因为DbCommandTree最终会生成对应的DbCommand，所以你可以在CommandTree拦截阶段提前设置这个Tag，之后在Command拦截阶段读取。

代码示例： #

在DbCommandTreeInterceptor中设置Tag：

public void TreeCreated(DbCommandTreeInterceptionContext interceptionContext)
{
    // 仅当CommandTree是查询/修改类型时，才能创建CommandDefinition
    if (interceptionContext.Result is DbQueryCommandTree queryTree)
    {
        var dbContext = interceptionContext.DbContexts.FirstOrDefault();
        if (dbContext == null) return;

        var commandDef = dbContext.Database.CreateCommandDefinition(queryTree);
        var command = commandDef.CreateCommand();
        command.Tag = new MySharedState
        {
            OperationId = Guid.NewGuid().ToString(),
            CustomData = "通过Command.Tag传递的状态"
        };
    }
}

在DbCommandInterceptor中读取Tag：

public override void ReaderExecuting(DbCommand command, DbCommandInterceptionContext<DbDataReader> interceptionContext)
{
    var sharedState = command.Tag as MySharedState;
    if (sharedState != null)
    {
        Console.WriteLine($"Tag传递的操作ID：{sharedState.OperationId}");
    }

    base.ReaderExecuting(command, interceptionContext);
}

注意事项： #

• 这个方法的局限性在于，并不是所有CommandTree都能直接生成Command，比如一些内部的EF操作可能不会走这个流程，所以可靠性不如前两种。
• 要确保EF内部不会覆盖Tag属性，否则状态会丢失。

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