.NET多线程之调用上下文CallContext

命名空间：System.Runtime.Remoting.Messaging

类型完全限定名称：System.Runtime.Remoting.Messaging.CallContext

官方介绍：https://docs.microsoft.com/zh-cn/dotnet/api/system.runtime.remoting.messaging.callcontext?redirectedfrom=MSDN&view=netframework-4.8

用途：

　　用于提供与执行代码路径一起传送的属性集，直白讲就是：提供线程（多线程/单线程）代码执行路径中数据传递的能力。

方法	描述	是否可用于多线程环境
SetData	存储给定的对象并将其与指定名称关联。	否
GetData	从System.Runtime.Remoting.Messaging.CallContext中检索具有指定名称的对象	否
LogicalSetData	将给定的对象存储在逻辑调用上下文，并将其与指定名称关联。	是
LogicalGetData	从逻辑调用上下文中检索具有指定名称的对象。	是
FreeNamedDataSlot	清空具有指定名称的数据槽。	是
HostContext	获取或设置与当前线程相关联的主机上下文。在Web环境下等于System.Web.HttpContext.Current	否

为了更加明确的认识这些方法的作用以及作用我们通过以下代码来了解：

首先定义一个类：

public class User
{
　　public string Id { get; set; }

　　public string Name { get; set; }
}

一、单线/多线程环境，测试GetData、SetData、FreeNamedDataSlot

下边的输出分别对应1、2、3的输出

根据上述测试结果我们基本可以得出以下结论：

1、GetData、SetData只能用于单线程环境，如果发生了线程切换，存储的数据也会随之丢失

2、可以用于同一线程中的不同地方，传递数据

一、单线/多线程环境，测试LogicalSetData、LogicalGetData、FreeNamedDataSlot

通过上述测试可得出结论：

a、FreeNamedDataSlot只能清除当前线程的数据槽，不能清除子线程的数据槽；

b、LogicalSetData、LogicalGetData可用于在多线程环境下传递数据；

c、FreeNamedDataSlot清除当前线程，之前已经运行子任务，不受影响

通过与上一测试对比我们可以得出结论：

a、FreeNamedDataSlot只能清除当前线程的数据槽

b、LogicalSetData只是存储当前线程以及子线程的数据槽

c、LogicalGetData获取的是当前线程或父线程的数据槽对象，拿到的时对象的引用

d、子线程中使用LogicalSetData改变数据槽的值，不能印象父线程的数据槽，及时他们的key时一个

现在清楚了它的功能，这样我们就可以来思考它的使用场景。

1、可以解耦代码，以前我们向下传递数据是通过参数变量的形式，方法嵌套，我么就需要额外的参数一层一层传递。如果我们Get了CallContext技能，就可以对代码进行解耦；

2、工作单元（UOW），像XPO的工作单元以及ABP的工作单元，都是通过CallContext来实现的，ABP详见IUnitOfWorkManager.Current->ICurrentUnitOfWorkProvider.Current->CallContextCurrentUnitOfWorkProvider.Current

3、 System.Web.HttpContext.Current我们常用来获取当前请求上下文，使用的是System.Runtime.Remoting.Messaging.CallContext.HostContext

System.Runtime.Remoting.Messaging.CallContext.HostContext get访问器和set访问器实现和GetData和SetData的实现方式一致

在.NET Core中使用AsyncLocal代替CallContext，实现的是CallContext.LogicalGetData 和CallContext.SetLogicalCallContext

此处需要重点说下ILogicalThreadAffinative，其作用是：将一个对象，可以将外部传播标记 System.AppDomain 中 System.Runtime.Remoting.Messaging.LogicalCallContext。

如果需要存在在执行上下文中的对象继承了ILogicalThreadAffinative接口，使用LogicalSetData/LogicalGetData和SetData/GetData作用是一样的。请看以下源码截图：

 　　　　[SecurityCritical]
        public static void SetData(string name, object data)
        {
            if (data is ILogicalThreadAffinative)
            {
                LogicalSetData(name, data);
            }
            else
            {
                ExecutionContext mutableExecutionContext = Thread.CurrentThread.GetMutableExecutionContext();
                mutableExecutionContext.LogicalCallContext.FreeNamedDataSlot(name);
                mutableExecutionContext.IllogicalCallContext.SetData(name, data);
            }
        }

        [SecurityCritical]
        public static object GetData(string name)
        {
            object obj2 = LogicalGetData(name);
            return ((obj2 != null) ? obj2 : IllogicalGetData(name));
        }

我们可以看到，不管你是使用LogicalSetData还是SetData存储的数据，我们使用GetData都是可以取到的。如果SetData的值是继承ILogicalThreadAffinative接口，那不管使用那个都是一样的效果；

实际上在使用System.Web.HttpContext.Current是通过CallContext.HostContext实现的，在看其源码时发现一个很不理解的现象

 　　　　public static object HostContext
        {
            [SecurityCritical]
            get
            {
                ExecutionContext.Reader executionContextReader = Thread.CurrentThread.GetExecutionContextReader();
                object hostContext = executionContextReader.IllogicalCallContext.HostContext;
                if (hostContext == null)
                {
                    hostContext = executionContextReader.LogicalCallContext.HostContext;//这里又为什么取，不是无用功么
                }
                return hostContext;
            }
            [SecurityCritical]
            set
            {
                ExecutionContext mutableExecutionContext = Thread.CurrentThread.GetMutableExecutionContext();
                if (value is ILogicalThreadAffinative)
                {
                    mutableExecutionContext.IllogicalCallContext.HostContext = null;
                    mutableExecutionContext.LogicalCallContext.HostContext = value;
                }
                else
                {
                    mutableExecutionContext.IllogicalCallContext.HostContext = value;
                    mutableExecutionContext.LogicalCallContext.HostContext = null;//此处为什么要设置为null
                }
            }
        }

仔细看了下，取决于

ILogicalThreadAffinative，要不要传播，以此减少一次存储。