如何使用CancellationToken属性？

Question

与上面的RulyCanceler类的代码相比,我想使用运行代码 CancellationTokenSource.

如何在取消令牌中提到它,即不抛出/捕获异常？我可以使用该IsCancellationRequested物业吗？

我试图像这样使用它:

cancelToken.ThrowIfCancellationRequested();

和

try
{
  new Thread(() => Work(cancelSource.Token)).Start();
}
catch (OperationCanceledException)
{
  Console.WriteLine("Canceled!");
}

但这cancelToken.ThrowIfCancellationRequested();在方法中给出了运行时错误Work(CancellationToken cancelToken):

System.OperationCanceledException was unhandled
  Message=The operation was canceled.
  Source=mscorlib
  StackTrace:
       at System.Threading.CancellationToken.ThrowIfCancellationRequested()
       at _7CancellationTokens.Token.Work(CancellationToken cancelToken) in C:\xxx\Token.cs:line 33
       at _7CancellationTokens.Token.<>c__DisplayClass1.<Main>b__0() in C:\xxx\Token.cs:line 22
       at System.Threading.ThreadHelper.ThreadStart_Context(Object state)
       at System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean ignoreSyncCtx)
       at System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state)
       at System.Threading.ThreadHelper.ThreadStart()
  InnerException:

我成功运行的代码在新线程中捕获了OperationCanceledException:

using System;
using System.Threading;
namespace _7CancellationTokens
{
  internal class Token
  {
    private static void Main()
    {
      var cancelSource = new CancellationTokenSource();
      new Thread(() =>
      {
         try
         {
           Work(cancelSource.Token); //).Start();
         }
         catch (OperationCanceledException)
         {
            Console.WriteLine("Canceled!");
         }
         }).Start();

      Thread.Sleep(1000);
      cancelSource.Cancel(); // Safely cancel worker.
      Console.ReadLine();
    }
    private static void Work(CancellationToken cancelToken)
    {
      while (true)
      {
        Console.Write("345");
        cancelToken.ThrowIfCancellationRequested();
      }
    }
  }
}

Answer 1

您可以按如下方式实现工作方法:

private static void Work(CancellationToken cancelToken)
{
    while (true)
    {
        if(cancelToken.IsCancellationRequested)
        {
            return;
        }
        Console.Write("345");
    }
}

而已.您总是需要自己处理取消 - 在适当的时间退出时退出方法(以便您的工作和数据处于一致状态)

更新:我不喜欢写作,while (!cancelToken.IsCancellationRequested)因为通常只有很少的出口点,你可以在循环体上安全地停止执行,循环通常有一些逻辑条件退出(迭代集合中的所有项目等).所以我认为最好不要将这些条件混合起来,因为它们有不同的意图.

Answer 2

@ BrainSlugs83

你不应该盲目信任stackoverflow上发布的所有内容.Jens代码中的注释不正确,该参数不控制是否抛出异常.

MSDN非常清楚该参数控制的是什么,你读过它吗？ http://msdn.microsoft.com/en-us/library/dd321703(v=vs.110).aspx

如果throwOnFirstException为true,则异常将立即传播出Cancel的调用,从而阻止处理剩余的回调和可取消的操作.如果throwOnFirstException为false,则此重载将聚合抛出到AggregateException中的任何异常,这样一个抛出异常的回调将不会阻止执行其他已注册的回调.

变量名也是错误的,因为在CancellationTokenSource上调用Cancel而不是令牌本身,并且源更改它管理的每个令牌的状态.

Answer 3

您必须将 传递CancellationToken给 Task，它会定期监视令牌以查看是否请求取消。

// CancellationTokenSource provides the token and have authority to cancel the token
CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
CancellationToken token = cancellationTokenSource.Token;  

// Task need to be cancelled with CancellationToken 
Task task = Task.Run(async () => {     
  while(!token.IsCancellationRequested) {
      Console.Write("*");         
      await Task.Delay(1000);
  }
}, token);

Console.WriteLine("Press enter to stop the task"); 
Console.ReadLine(); 
cancellationTokenSource.Cancel(); 

在这种情况下，操作将在请求取消时结束，并且Task将有一个RanToCompletion状态。如果您想确认您的任务已被取消，您必须使用ThrowIfCancellationRequested抛出OperationCanceledException异常。

Task task = Task.Run(async () =>             
{                 
    while (!token.IsCancellationRequested) {
         Console.Write("*");                      
         await Task.Delay(1000);                
    }           
    token.ThrowIfCancellationRequested();               
}, token)
.ContinueWith(t =>
 {
      t.Exception?.Handle(e => true);
      Console.WriteLine("You have canceled the task");
 },TaskContinuationOptions.OnlyOnCanceled);  
 
Console.WriteLine("Press enter to stop the task");                 
Console.ReadLine();                 
cancellationTokenSource.Cancel();                 
task.Wait(); 

希望这有助于更好地理解。

Answer 4

您可以在不处理异常的情况下使用ThrowIfCancellationRequested!

ThrowIfCancellationRequested的使用意味着在Task(而不是Thread)中使用.在Task中使用时,您不必自己处理异常(并获取Unhandled Exception错误).它将导致离开Task,并且Task.IsCancelled属性将为True.无需异常处理.

在您的特定情况下,将线程更改为任务.

try
{
  Task.Run(() => Work(cancelSource.Token), cancelSource.Token);
}
if (t.IsCancelled)
  Console.WriteLine("Canceled!");
}

Answer 5

您可以使用取消令牌创建任务,当您应用转到后台时,您可以取消此令牌.

您可以在PCL中执行此操作https://developer.xamarin.com/guides/xamarin-forms/application-fundamentals/app-lifecycle

var cancelToken = new CancellationTokenSource();
Task.Factory.StartNew(async () => {
    await Task.Delay(10000);
    // call web API
}, cancelToken.Token);

//this stops the Task:
cancelToken.Cancel(false);

Anther解决方案是Xamarin.Forms中的用户计时器,当应用程序转到后台时停止计时器 https://xamarinhelp.com/xamarin-forms-timer/