威海电子商务网站建设,免费html网站登录模板,网站怎样才能被百度收录,抖音广告投放收费标准前言相信大家在使用C#进行开发的时候#xff0c;特别是使用异步的场景#xff0c;多多少少会接触到CancellationTokenSource。看名字就知道它和取消异步任务相关的#xff0c;而且一看便知大名鼎鼎的CancellationToken就是它生产出来的。不看不知道#xff0c;一看吓一跳。… 前言 相信大家在使用C#进行开发的时候特别是使用异步的场景多多少少会接触到CancellationTokenSource。看名字就知道它和取消异步任务相关的而且一看便知大名鼎鼎的CancellationToken就是它生产出来的。不看不知道一看吓一跳。它在取消异步任务、异步通知等方面效果还是不错的不仅好用而且够强大。无论是微软底层类库还是开源项目涉及到Task相关的基本上都能看到它的身影而微软近几年也是很重视框架中的异步操作特别是在.NET Core上基本上能看到Task的地方就能看到CancellationTokenSource的身影。这次我们抱着学习的态度来揭开它的神秘面纱。简单示例相信对于CancellationTokenSource基本的使用许多同学已经非常熟悉了。不过为了能够让大家带入文章的节奏我们还是打算先展示几个基础的操作让大家找找感觉回到那个熟悉的年代。基础操作首先呈现一个最基础的操作。CancellationTokenSource cancellationTokenSource new CancellationTokenSource();
CancellationToken cancellationToken cancellationTokenSource.Token;
cancellationToken.Register(() System.Console.WriteLine(取消了));
cancellationToken.Register(() System.Console.WriteLine(取消了));
cancellationToken.Register(state System.Console.WriteLine($取消了。。。{state}),啊啊啊);
System.Console.WriteLine(做了点别的,然后取消了.);
这个操作是最简单的操作我们上面提到过CancellationTokenSource就是用来生产CancellationToken的还可以说CancellationToken是CancellationTokenSource的表现这个待会看源码的时候我们会知道为啥这么说。这里呢我们给CancellationToken注册几个操作然后使用CancellationTokenSource的Cancel方法取消操作这时候控制台就会打印结果如下做了点别的,然后取消了.
取消了。。。啊啊啊
取消了
取消了
通过上面简单的示例大家应该非常轻松的理解了它的简单使用。定时取消有的时候呢我们可能需要超时操作比如我不想一直等着到了一个固定的时间我就要取消操作这时候我们可以利用CancellationTokenSource的构造函数给定一个限定时间过了这个时间CancellationTokenSource就会被取消了操作如下//设置3000毫秒(即3秒)后取消
CancellationTokenSource cancellationTokenSource new CancellationTokenSource(3000);
CancellationToken cancellationToken cancellationTokenSource.Token;
cancellationToken.Register(() System.Console.WriteLine(我被取消了.));
System.Console.WriteLine(先等五秒钟.);
await Task.Delay(5000);
System.Console.WriteLine(手动取消.)
cancellationTokenSource.Cancel();
然后在控制台打印的结果是这个样子的活脱脱的为我们实现了内建的超时操作。先等五秒钟.
我被取消了.
手动取消.
上面的写法是在构造CancellationTokenSource的时候设置超时等待还有另一种写法等同于这种写法使用的是CancelAfter方法具体使用如下CancellationTokenSource cancellationTokenSource new CancellationTokenSource();
cancellationTokenSource.Token.Register(() System.Console.WriteLine(我被取消了.));
//五秒之后取消
cancellationTokenSource.CancelAfter(5000);
System.Console.WriteLine(不会阻塞,我会执行.);
这个操作也是定时取消操作需要注意的是CancelAfter方法并不会阻塞执行所以打印的结果是不会阻塞,我会执行.
我被取消了.
关联取消还有的时候是这样的场景就是我们设置一组关联的CancellationTokenSource我们期望的是只要这一组里的任意一个CancellationTokenSource被取消了那么这个被关联的CancellationTokenSource就会被取消。说得通俗一点就是我们几个当中只要一个不在了那么你也可以不在了具体的实现方式是这样的//声明几个CancellationTokenSource
CancellationTokenSource tokenSource new CancellationTokenSource();
CancellationTokenSource tokenSource2 new CancellationTokenSource();
CancellationTokenSource tokenSource3 new CancellationTokenSource();tokenSource2.Token.Register(() System.Console.WriteLine(tokenSource2被取消了));//创建一个关联的CancellationTokenSource
CancellationTokenSource tokenSourceNew CancellationTokenSource.CreateLinkedTokenSource(tokenSource.Token, tokenSource2.Token, tokenSource3.Token);
tokenSourceNew.Token.Register(() System.Console.WriteLine(tokenSourceNew被取消了));
//取消tokenSource2
tokenSource2.Cancel();
上述示例中因为tokenSourceNew关联了tokenSource、tokenSource2、tokenSource3所以只要他们其中有一个被取消那么tokenSourceNew也会被取消所以上述示例的打印结果是tokenSourceNew被取消了
tokenSource2被取消了
判断取消上面我们使用的方式都是通过回调的方式得知CancellationTokenSource被取消了没办法通过标识去得知CancellationTokenSource是否可用。不过微软贴心的为我们提供了IsCancellationRequested属性去判断需要注意的是它是CancellationToken的属性具体使用方式如下CancellationTokenSource tokenSource new CancellationTokenSource();
CancellationToken cancellationToken tokenSource.Token;
//打印被取消
cancellationToken.Register(() System.Console.WriteLine(被取消了.));
//模拟传递的场景
Task.Run(async () {while (!cancellationToken.IsCancellationRequested){System.Console.WriteLine(一直在执行...);await Task.Delay(1000);}
});
//5s之后取消
tokenSource.CancelAfter(5000);
上述代码五秒之后CancellationTokenSource被取消因此CancellationTokenSource的Token也会被取消。反映到IsCancellationRequested上就是值为true说明被取消为false说明没被取消因此控制台输出的结果是一直在执行...
一直在执行...
一直在执行...
一直在执行...
一直在执行...
被取消了.
还有另一种方式也可以主动判断任务是否被取消不过这种方式简单粗暴直接是抛出了异常。如果是使用异步的方式的话需要注意的是Task内部异常的捕获方式否则对外可能还没有感知到具体异常的原因它的使用方式是这样的这里为了演示方便我直接换了一种更直接的方式CancellationTokenSource tokenSource new CancellationTokenSource();
CancellationToken cancellationToken tokenSource.Token;
cancellationToken.Register(() System.Console.WriteLine(被取消了.));
tokenSource.CancelAfter(5000);
while (true)
{//如果操作被取消则直接抛出异常cancellationToken.ThrowIfCancellationRequested();System.Console.WriteLine(一直在执行...);await Task.Delay(1000);
}
执行五秒之后则直接抛出 System.OperationCanceledException: The operation was canceled.异常异步情况下注意异常处理的方式即可。通过上面这些简单的示例相信大家对CancellationTokenSource有了一定的认识大概知道了在什么时候可以使用它主要是异步取消通知或者限定时间操作通知等等。CancellationTokenSource是个不错的神器使用简单功能强大。源码探究 通过上面的示例相信大家对CancellationTokenSource有了一个基本的认识真的是非常强大而且使用起来也非常的简单这也是c#语言的精妙之处非常实用让你用起来的时候非常舒服有种用着用着就想跪下的冲动。步入正题接下来让我们来往深处看看CancellationTokenSource的源码看看它的工作机制是啥。本文贴出的源码是博主精简过的毕竟源码太多不太可能全部粘贴出来主要是跟着它的思路了解它的工作方式。构造入手因为这一次呢CancellationTokenSource的初始化函数中有一个比较重要的构造函数那就是可以设置定时超时的操作那么我们就从它的构造函数入手[点击查看源码????[1]]//全局状态
private volatile int _state;
//未取消状态值
private const int NotCanceledState 1;/// summary
/// 无参构造初始化状态
/// /summary
public CancellationTokenSource() _state NotCanceledState;/// summary
/// 定时取消构造
/// /summary
public CancellationTokenSource(TimeSpan delay)
{//获取timespan的毫秒数long totalMilliseconds (long)delay.TotalMilliseconds;if (totalMilliseconds -1 || totalMilliseconds int.MaxValue){throw new ArgumentOutOfRangeException(nameof(delay));}//调用InitializeWithTimerInitializeWithTimer((int)totalMilliseconds);
}public CancellationTokenSource(int millisecondsDelay)
{if (millisecondsDelay -1){throw new ArgumentOutOfRangeException(nameof(millisecondsDelay));}//调用InitializeWithTimerInitializeWithTimer(millisecondsDelay);
}
无参构造函数没啥好说的就是给全局state状态初始化NotCanceledState的初始值也就是初始化状态。我们比较关注的是可以定时取消的构造函数虽然是两个构造函数但是殊途同归本质都是传递的毫秒整形参数而且调用的核心方法都是InitializeWithTimer看来是一个定时器操作这样不奇怪了我们看下InitializeWithTimer方法的实现[点击查看源码????[2]]//任务完成状态值
private const int NotifyingCompleteState 2;
//定时器
private volatile TimerQueueTimer? _timer;
//定时器回调初始化
private static readonly TimerCallback s_timerCallback TimerCallback;
//定时器回调委托本质是调用的CancellationTokenSource的NotifyCancellation方法
private static void TimerCallback(object? state) ((CancellationTokenSource)state!).NotifyCancellation(throwOnFirstException: false);private void InitializeWithTimer(uint millisecondsDelay)
{if (millisecondsDelay 0){//如果定时的毫秒为0则设置全局状态为NotifyingCompleteState_state NotifyingCompleteState;}else{//如果超时毫秒不为0则初始化定时器并设置定时器定时的回调_timer new TimerQueueTimer(s_timerCallback, this, millisecondsDelay, Timeout.UnsignedInfinite, flowExecutionContext: false);}
}
通过这个方法我们可以可以非常清晰的看到定时初始化的核心操作其实就是初始化一个定时器而定时的时间就是我们初始化传递的毫秒数其中s_timerCallback是定时的回调函数即如果等待超时之后则调用这个委托其本质正是CancellationTokenSource的NotifyCancellation方法这个方法正是处理超时之后的操作[点击查看源码????[3]]//信号控制类通过信号判断是否需要继续执行或阻塞
private volatile ManualResetEvent? _kernelEvent;
//throwOnFirstException函数是指示如果被取消了是否抛出异常
private void NotifyCancellation(bool throwOnFirstException)
{//如果任务已经取消则直接直接释放定时器if (!IsCancellationRequested Interlocked.CompareExchange(ref _state, NotifyingState, NotCanceledState) NotCanceledState){TimerQueueTimer? timer _timer;if (timer ! null){_timer null;timer.Close();}//信号量涉及到了一个重要的属性WaitHandle接下来会说_kernelEvent?.Set(); //执行取消操作是取消操作的核心讲取消操作的时候咱们会着重说这个ExecuteCallbackHandlers(throwOnFirstException);Debug.Assert(IsCancellationCompleted, Expected cancellation to have finished);}
}
NotifyCancellation正是处理定时器到时的操作说白了就是到了指定的时间但是没有手动取消执行的操作其实也是执行的取消操作这个方法里涉及到了两个比较重要的点也是接下来我们会分析的点这里做一下说明•首先是ManualResetEvent这个实例这个类的功能是通过信号机制控制是否阻塞或执行后续操作与之相辅的还有另一个类AutoResetEvent。这两个类实现的效果是一致的只是ManualResetEvent需要手动重置初始状态而AutoResetEvent则会自动重置。有关两个类的说明这里不做过多介绍有需要了解的同学们可以自行百度。而CancellationTokenSource类的一个重要属性WaitHandle正是使用的它。•还有一个是ExecuteCallbackHandlers方法这个是CancellationTokenSource执行取消操作的核心操作。为了保证阅读的顺序性咱们在讲取消操作的时候在重点讲这个方法。上面提到了为了保证阅读的顺序性方便理解咱们在本文接下来会讲解这两部分就不再初始化这里讲解了这里做一下标记以防大家觉得没讲清楚就继续了。小插曲WaitHandle上面我们提到了CancellationTokenSource的WaitHandle属性它是基于ManualResetEvent实现的。这个算是一个稍微独立的地方我们可以先进行讲解一下[点击查看源码????[4]]private volatile ManualResetEvent? _kernelEvent;
internal WaitHandle WaitHandle
{get{ThrowIfDisposed();//如果初始化过了则直接返回if (_kernelEvent ! null){return _kernelEvent;}//初始化一个ManualResetEvent给定初始值为falsevar mre new ManualResetEvent(false);//线程安全操作如果有别的线程初始了则释放上面初始化的操作if (Interlocked.CompareExchange(ref _kernelEvent, mre, null) ! null){mre.Dispose();}//如果任务已取消则后续操作不阻塞if (IsCancellationRequested){_kernelEvent.Set();}return _kernelEvent;}
}
通过这段代码我们可以看到如果使用了WaitHandle属性则可以使用它实现简单的阻塞通知操作也就是收到取消通知操作之后我们可以执行WaitHandle之后的操作但是WaitHandle是internal修饰的我们该怎么使用呢莫慌我们知道CancellationTokenSource的Token属性获取的是CancellationToken实例[点击查看源码????[5]]public CancellationToken Token
{get{ThrowIfDisposed();return new CancellationToken(this);}
}
直接实例化了一个CancellationToken实例返回去了并传递了当前CancellationTokenSource实例找到CancellationToken的这个构造函数[点击查看源码????[6]]private readonly CancellationTokenSource? _source;
internal CancellationToken(CancellationTokenSource? source) _source source;
public WaitHandle WaitHandle (_source ?? CancellationTokenSource.s_neverCanceledSource).WaitHandle;
通过上面的代码我们可以看到通过CancellationToken实例便可以使用WaitHandle属性实现我们访问到它的效果光是说的话可能有点迷糊通过一个简单的示例我们来了解WaitHandle的使用方式简单来看下CancellationTokenSource tokenSource new CancellationTokenSource();
CancellationToken cancellationToken tokenSource.Token;
cancellationToken.Register(() System.Console.WriteLine(被取消了.));
tokenSource.CancelAfter(5000);
Task.Run(() {System.Console.WriteLine(阻塞之前);cancellationToken.WaitHandle.WaitOne();System.Console.WriteLine(阻塞取消,执行到了.);
});
System.Console.WriteLine(执行到了这里);
在CancellationTokenSource为被取消之前WaitHandle.WaitOne()方法会阻塞后续执行也就是下面的输出暂时不会输出。等到CancellationTokenSource执行了Cancel操作里调用了ManualResetEvent的Set方法停止阻塞后续的输出才会被执行到这是一个同步操作如果了解ManualResetEvent的同学相信对这个不难理解。为了演示效果我用Task演示异步的情况所以执行的结果如下所示执行到了这里
阻塞之前
阻塞取消,执行到了.
被取消了.
注册操作上面我们大概讲解了一些初始化相关的和一些辅助的操作接下来我们看一下核心的注册操作注册操作的用途就是注册CancellationTokenSource取消或超时后需要执行的动作而注册Register的操作并未由CancellationTokenSource直接进行而是通过它的Token属性即CancellationToken实例操作的话不多说直接找到CancellationToken的Register方法[点击查看源码????[7]]public CancellationTokenRegistration Register(Action callback)
Register(s_actionToActionObjShunt,callback ?? throw new ArgumentNullException(nameof(callback)),useSynchronizationContext: false,useExecutionContext: true);
它是直接调用自己的重载方法注意几个参数如果看细节的话还是要关注方法参数的。过程就省略了直接找到最底层的方法[点击查看源码????[8]]private CancellationTokenRegistration Register(Actionobject? callback, object? state, bool useSynchronizationContext, bool useExecutionContext)
{if (callback null)throw new ArgumentNullException(nameof(callback));//_source就是传递下来的CancellationTokenSourceCancellationTokenSource? source _source;//本质是调用的CancellationTokenSource的InternalRegister方法return source ! null ?source.InternalRegister(callback, state, useSynchronizationContext ? SynchronizationContext.Current : null, useExecutionContext ? ExecutionContext.Capture() : null) :default;
从这个最底层的方法我们可以得知其本质还是调用CancellationTokenSource的InternalRegister方法核心操作都不在CancellationToken还是在CancellationTokenSource类CancellationToken更像是依赖CancellationTokenSource的表现类看一下InternalRegister方法[点击查看源码????[9]]//初始化CallbackPartition数组
private volatile CallbackPartition?[]? _callbackPartitions;
//获取初始化上面数组的长度根据当前CPU核心数获取的
private static readonly int s_numPartitions GetPartitionCount();internal CancellationTokenRegistration InternalRegister(Actionobject? callback, object? stateForCallback, SynchronizationContext? syncContext, ExecutionContext? executionContext)
{//判断有没有被取消if (!IsCancellationRequested){//如果已被释放直接返回if (_disposed){return default;}CallbackPartition?[]? partitions _callbackPartitions;if (partitions null){//首次调用初始化CallbackPartition数组partitions new CallbackPartition[s_numPartitions];//判断_callbackPartitions如果为null,则把partitions赋值给_callbackPartitionspartitions Interlocked.CompareExchange(ref _callbackPartitions, partitions, null) ?? partitions;}//获取当前线程使用的分区下标int partitionIndex Environment.CurrentManagedThreadId s_numPartitionsMask;//获取一个CallbackPartitionCallbackPartition? partition partitions[partitionIndex];if (partition null){//初始化CallbackPartition实例partition new CallbackPartition(this);//如果partitions的partitionIndex下标位置为null则使用partition填充partition Interlocked.CompareExchange(ref partitions[partitionIndex], partition, null) ?? partition;}long id;CallbackNode? node;bool lockTaken false;//锁住操作partition.Lock.Enter(ref lockTaken);try{id partition.NextAvailableId;//获取CallbackNode这事真正存储回调的地方不要被List名字迷惑其实是要构建链表node partition.FreeNodeList;if (node ! null){//这个比较有意思如果CallbackNode不是首次则把最新的赋值给FreeNodeListpartition.FreeNodeList node.Next;}else{//首次的时候初始化一个CallbackNode实例node new CallbackNode(partition);}node.Id id;//Register的回调操作赋值给了CallbackNode的Callbacknode.Callback callback;node.CallbackState stateForCallback;node.ExecutionContext executionContext;node.SynchronizationContext syncContext;//构建一个CallbackNode链表从下面的代码可以看出来构建的其实是倒序链表最新的CallbackNode是表头node.Next partition.Callbacks;if (node.Next ! null){node.Next.Prev node;}//Callbacks记录的是当前的节点如果下一次进来新节点则作为新节点的Next节点partition.Callbacks node;}finally{//释放锁partition.Lock.Exit(useMemoryBarrier: false); }//用当前注册回调生成的CallbackNode节点生成CancellationTokenRegistration实例var ctr new CancellationTokenRegistration(id, node);//如果未被取消则直接返回if (!IsCancellationRequested || !partition.Unregister(id, node)){return ctr;}}//走到这里说明IsCancellationRequested已经等于true了也就是被取消了则直接执行该回调callback(stateForCallback);return default;
}
这里涉及到一个比较核心的类那就是CallbackPartition这是一个内部类它的主要用途就是辅助构建执行回调的链表操作其大概实现是这个样子的[点击查看源码????[10]]internal sealed class CallbackPartition
{public readonly CancellationTokenSource Source;//使用了自旋锁public SpinLock Lock new SpinLock(enableThreadOwnerTracking: false);public CallbackNode? Callbacks;public CallbackNode? FreeNodeList;public long NextAvailableId 1; public CallbackPartition(CancellationTokenSource source){Source source;}internal bool Unregister(long id, CallbackNode node){//这里面有内容,就不罗列了判断CallbackNode是否被取消注册如果为false说明未被取消注册}
}
这里面我暂时没有列出Unregister的内容因为它是和取消相关的说到取消的时候咱们再看如果返回true则说明取消成功。这个类核心就是辅助构建Register回调链表的它的核心都是在操作CallbackNode节点和其构建的回调链表而CallbackNode则是链表的一个节点定义其大致结构如下[点击查看源码????[11]]internal sealed class CallbackNode
{public readonly CallbackPartition Partition;//构建链表的核心Prev和Nextpublic CallbackNode? Prev;public CallbackNode? Next;public long Id;//回调操作被这个委托记录public Actionobject?? Callback;public object? CallbackState;public ExecutionContext? ExecutionContext;public SynchronizationContext? SynchronizationContext;public CallbackNode(CallbackPartition partition){Partition partition;}public void ExecuteCallback(){//这里也有代码暂时不列出来讲取消的时候单独讲解}
}
到了这里关于Register涉及到的核心操作都罗列出来了,由于贴出来的是源码相关看着是比较蒙圈的但是如果顺着看的话其实还是大致的实现思路还是可以理解的这里我大致的总结一下它的实现思路•首先是构建了CallbackPartition数组构建这个数组的长度是根据CPU的核心数来决定每个CallbackPartition是操作的核心为了防止过多的线程同时操作一个CallbackPartition实例它采用了为不同线程分区的思路CallbackPartition维护了构建链表节点的类CallbackNode。•CallbackNode是组成链表的核心CallbackNode每个实例都是链表的一个节点从它自包含Prev和Next属性便可以看出是一个双向链表。•CallbackPartition的核心功能就是为了构建Register进来的回调从上面的InternalRegister方法里的操作我们可以得知通过CallbackPartition的辅助将CallbackNode节点构建为一个倒序链表也就是最新的CallbackNode实例是链表的首节点而最老的CallbackNode实例则是链表的尾节点。每一次Register进来的回调都被包装成了CallbackNode添加到这个链表中。上面InternalRegister方法里我们看到操作CallbackNode的时候使用了SpinLock自旋锁。短时间锁定的情况下SpinLock更快因为自旋锁本质上不会让线程休眠而是一直循环尝试对资源访问直到可用。所以自旋锁线程被阻塞时不进行线程上下文切换而是空转等待。对于多核CPU而言减少了切换线程上下文的开销从而提高了性能。取消操作上面我们看到了注册相关的操作注册还是比较统一的就一种操作方式。取消却有两种方式一种是超时取消另一种是主动取消接下来我们就分别看一下这两种方式分别是如何操作的。Cancel操作首先我们来看主动取消的操作方式这个是最简单最直接的方式而且这个方法属于CancellationTokenSource类话不多说直接看实现[点击查看源码????[12]]public void Cancel() Cancel(false);public void Cancel(bool throwOnFirstException)
{ThrowIfDisposed();NotifyCancellation(throwOnFirstException);
}
重点来了Cancel方法居然也是调用的NotifyCancellation方法这个方法咱们上面已经看过了。在说定时的方式构造CancellationTokenSource的时候有一个自动取消的操作提到了NotifyCancellation方法的核心是ExecuteCallbackHandlers方法这个是CancellationTokenSource执行取消操作的核心操作。还说了为了保证阅读的顺序性咱们在讲取消操作的时候在重点讲这个方法。看来这个时刻终于还是到来了直接打开ExecuteCallbackHandlers方法[点击查看源码????[13]]private volatile int _threadIDExecutingCallbacks -1;
private volatile CallbackPartition?[]? _callbackPartitions;
private const int NotifyingCompleteState 3;
private void ExecuteCallbackHandlers(bool throwOnFirstException)
{//获取当前线程IDThreadIDExecutingCallbacks Environment.CurrentManagedThreadId;//将_callbackPartitions置为null但是partitions不为null因为Exchange返回的是改变之前的值CallbackPartition?[]? partitions Interlocked.Exchange(ref _callbackPartitions, null);//如果partitions为null说明是回调已经通知完成状态了直接返回if (partitions null){Interlocked.Exchange(ref _state, NotifyingCompleteState);return;}ListException? exceptionList null;try{//遍历CallbackPartition数组foreach (CallbackPartition? partition in partitions){//CallbackPartition实例为null说明这个分区未被使用直接跳过if (partition null){continue;}//循环处理CallbackNode链表while (true){CallbackNode? node;bool lockTaken false;//锁住当前操作partition.Lock.Enter(ref lockTaken);try{//获取链表的节点node partition.Callbacks;//为null说明没Register过直接中断if (node null){break;}else{//如果链表遍历不是尾节点,切断和下一个节点的关联if (node.Next ! null) node.Next.Prev null;//把下一个节点赋值给Callbackspartition.Callbacks node.Next;}//当前执行节点ID_executingCallbackId node.Id;node.Id 0;}finally{//退出锁partition.Lock.Exit(useMemoryBarrier: false); }try{//如果当时传递了同步上下文则直接在当时的上下文调用ExecuteCallback委托if (node.SynchronizationContext ! null){node.SynchronizationContext.Send(static s {var n (CallbackNode)s!;n.Partition.Source.ThreadIDExecutingCallbacks Environment.CurrentManagedThreadId;n.ExecuteCallback();}, node);ThreadIDExecutingCallbacks Environment.CurrentManagedThreadId; }else{//如果没有传递SynchronizationContext则直接调用ExecuteCallback委托//即调用Register的注册的委托node.ExecuteCallback();}}catch (Exception ex) when (!throwOnFirstException){(exceptionList ?? new ListException()).Add(ex);}}}}finally{//将全局状态置为通知完成状态//即已经调用过Register回调_state NotifyingCompleteState;Volatile.Write(ref _executingCallbackId, 0);Interlocked.MemoryBarrier(); }//如果中途存在异常则抛出if (exceptionList ! null){Debug.Assert(exceptionList.Count 0, $Expected {exceptionList.Count} 0);throw new AggregateException(exceptionList);}
}
关于ExecuteCallback方法是CallbackNode类的方法也就是咱们上面罗列CallbackNode类结构时被省略的方法它的主要功能就是调用Register的回调也就是执行Register里的委托。欠下的我会补上来注意这里是CallbackNode类接下来看下实现[点击查看源码????[14]]public ExecutionContext? ExecutionContext;
public void ExecuteCallback()
{ExecutionContext? context ExecutionContext;//如果Register的时候允许传递ExecutionContext则直接用这个上下文执行回调Callback//Callback委托也就是承载Register的委托操作if (context ! null){ExecutionContext.RunInternal(context, static s {Debug.Assert(s is CallbackNode, $Expected {typeof(CallbackNode)}, got {s});CallbackNode n (CallbackNode)s;Debug.Assert(n.Callback ! null);n.Callback(n.CallbackState);}, this);}else{Debug.Assert(Callback ! null);//直接在当前线程调用Callback//Callback委托也就是承载Register的委托操作Callback(CallbackState);}
}
关于取消的核心方法ExecuteCallbackHandlers的重要操作咱们已经罗列出来了其实我们看到注册的思路的时候就已经能猜到执行取消回调的大致思路了既然Register的时候进行了拉链那么取消执行注册回调肯定是变量链表执行里面的Callback了大致总结一下•执行Cancel之后核心操作还是针对构建的CallbackNode链表进行遍历咱们之前说过构建的CallbackNode链表是倒序链表最新的节点放在链表的首部这也就解释了为啥我们上面的示例Register多个委托的时候最先输出的是最后注册委托。•Register注册时候有参数判断是否需要传递当前同步上下文SynchronizationContext和执行上下文ExecutionContext作用就是为了是否在当时的上下文环境执行Callback回调操作。•上面的遍历代码我们看到了会执行CallbackNode.Next.Prevnull的操作是为了断开当前链表节点和上下节点的关系个人感觉是为了切断对象引用方便释放的防止内存泄漏同时也说明了默认情况下Register的的回调函数执行是一次性的当执行完Cancel操作之后当前CancellationToken实例也就失效了。CancelAfter操作之前我们演示的时候说过有两种方式可以执行超时取消操作一种是在构建CancellationTokenSource实例构造的时候传递超时时间还有另一种是使用CancelAfter操作这个方法表示在指定时间之后取消效果上等同于实例化CancellationTokenSource的时候传递超时时间的操作废话不多说直接罗列代码[点击查看源码????[15]]public void CancelAfter(TimeSpan delay)
{long totalMilliseconds (long)delay.TotalMilliseconds;if (totalMilliseconds -1 || totalMilliseconds int.MaxValue){throw new ArgumentOutOfRangeException(nameof(delay));}//调用的是重载的CancelAfter方法CancelAfter((int)totalMilliseconds);
}private static readonly TimerCallback s_timerCallback obj
{((CancellationTokenSource)obj).NotifyCancellation(throwOnFirstException: false);
};public void CancelAfter(int millisecondsDelay)
{//传递的毫秒数不能小于-1if (millisecondsDelay -1){throw new ArgumentOutOfRangeException(nameof(millisecondsDelay));}//如果已经取消则直接返回if (IsCancellationRequested){return;}//注册一个定时器执行s_timerCallback//s_timerCallback在上面我们介绍过了 本这就是调用CancellationTokenSource的NotifyCancellation方法TimerQueueTimer? timer _timer;if (timer null){timer new TimerQueueTimer(s_timerCallback, this, Timeout.UnsignedInfinite, Timeout.UnsignedInfinite, flowExecutionContext: false);TimerQueueTimer? currentTimer Interlocked.CompareExchange(ref _timer, timer, null);if (currentTimer ! null){timer.Close();timer currentTimer;}}try{timer.Change((uint)millisecondsDelay, Timeout.UnsignedInfinite);}catch (ObjectDisposedException){}
}
通过上面的源码我们可以看到CancelAfter的操作代码和传递超时时间构造CancellationTokenSource的代码基本上是一致的都是通过TimerQueueTimer的方式定时触发调用CancellationTokenSource的NotifyCancellation方法而NotifyCancellation方法的核心实现就是ExecuteCallbackHandlers方法这些方法咱们上面都有讲解过就不重复介绍了这样关于取消相关的操作我们也就全部讲解完成了。总结 本文我们主要讲解了C#取消令牌CancellationTokenSource虽然设计到的类并不多但是这部分源码并不少而且也只是讲解核心功能的部分源码有兴趣的同学可以自行阅读这个类相关代码如果你觉得你的GitHub比较不给力推荐一个可以阅读CoreCLR源码的网站source.dot.net[16]这个网站看到的是目前CoreCLR最新的源码可以直接连接到GitHub非常方便但是最新版本的源码和稳定版本的有些差别这个还需要注意。由于文章比较长再加上笔者技术能力和文笔能力都有限这里做一下简单的总结•CancellationTokenSource的用途就是可以感知到取消操作其中涉及到的Register回调、WaitHandle、IsCancellationRequested都能实现这个功能当然它还支持超时取消操作。•CancellationTokenSource的Register和Cancel相关成双成对的虽然有CancelAfter和构造传递超时时间的方式其本质和Cancel操作是一样的。•CancellationTokenSource的核心操作原理是通过CallbackPartition和CallbackNode构建倒序链表Register的时候通过Callback委托构建链表Cancel的时候遍历构建的链表执行Callback虽然有一堆额外操作但是核心工作方式就是链表操作。•需要注意的是默认情况下CancellationTokenSource产生的CancellationToken是一次性的取消了之后是没有办法进行重置的当然微软已经为我们提供了IChangeToken去解决了CancellationToken重复触发的问题请放心使用。 由于本篇文章篇幅较长加上笔者能力有限文笔更是一般如果讲解的不清楚还望谅解或者感兴趣的同学可以自行阅读源码。关于看源码每个人都有自己的关注点我一般的初衷都是弄明白它的原理顺便学习下它代码风格或思路。学无止境结果有时候并不那么重要过程才重要。就和许多人追求自己能有到达什么样的高度成功其实只是成长过程中顺便的一种表现就和你如果不满现状说明你在很早之前没想过改变自己一样。References[1] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationTokenSource.cs#L168[2] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationTokenSource.cs#L212[3] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationTokenSource.cs#L578[4] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationTokenSource.cs#L110[5] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationTokenSource.cs#L101[6] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationToken.cs#L93[7] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationToken.cs#L139[8] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationToken.cs#L270[9] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationTokenSource.cs#L477[10] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationTokenSource.cs#L921[11] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationTokenSource.cs#1008[12] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationTokenSource.cs#250[13] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationTokenSource.cs#L608[14] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationTokenSource.cs#L1026[15] 点击查看源码????: https://github.com/dotnet/runtime/blob/v5.0.9/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationTokenSource.cs#L303[16] source.dot.net: https://source.dot.net/
