2018-12-14-区分CancellationToken-CancellationTokenSource-CancellationTokenRegistration

发现一些小伙伴的代码中CancellationToken-CancellationTokenSource-CancellationTokenRegistration傻傻分不清楚，今天就对这三个类的使用进行下区分。

var source = new  CancellationTokenSource();
DoAsync(source);

...
    
public async void DoAsync(CancellationTokenSource source)
{
    if(!source.IsCancellationRequested)
    {
        //do something
    }
}

一些小伙伴经常会在一些耗时操作里面添加如上所示的取消判定代码。

然而这种写法实际是不推荐的。

对比下微软官方程序集提供的取消API，要求的参数都是CancellationToken

实际上CancellationTokenSource翻译过来就是用作取消的Token(代币)源，而CancellationToken则是那个用于取消的代币。

执行任务前，CancellationTokenSource将自己的Token（CancellationToken）分发给各个任务。

当用户需要进行取消操作时，只要调用CancellationTokenSource的Cancel方法，就可以在Token中触发取消操作（具体按照业务写法，可以有异常，轮训状态，注册回调等等）

实际上更推荐的写法应该是

using(var source = new  CancellationTokenSource())
{
    DoAsync(source.Token);
}


...
    
public async void DoAsync(CancellationToken token)
{
    if(!token.IsCancellationRequested)
    {
        //do something
    }
}

这样取消的控制权就不会交到底层业务

划重点，CancellationTokenSource是IDisposable的

那么CancellationTokenRegistration 是什么呢？

他是CancellationToken的回调注册方法的返回值

using (CancellationTokenRegistration ctr = token.Register(() => //do cancel))
{
      //do something
}

划重点，CancellationTokenRegistration 是IDisposable的

当调用其Dispose方法时，注册的回调事件将会被释放，从而避免了内存泄漏

参考链接：

• CancellationTokenSource Class (System.Threading) - Microsoft Docs
• CancellationTokenRegistration Struct (System.Threading) - Microsoft Docs
• CancellationToken Struct (System.Threading) - Microsoft Docs

本文会经常更新，请阅读原文： https://xinyuehtx.github.io/post/%E5%8C%BA%E5%88%86CancellationToken-CancellationTokenSource-CancellationTokenRegistration.html ，以避免陈旧错误知识的误导，同时有更好的阅读体验。

本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布，但务必保留文章署名黄腾霄（包含链接： https://xinyuehtx.github.io ），不得用于商业目的，基于本文修改后的作品务必以相同的许可发布。如有任何疑问，请 与我联系 。