如何使用 CancellationToken 安全取消任务并等待 Task.WhenAll

Question

我有一个框架，它创建 CancellationTokenSource，配置 CancelAfter，然后调用异步方法并传递令牌。然后，异步方法会生成许多任务，将取消令牌传递给每个任务，然后等待任务的集合。这些任务均包含通过轮询 IsCancellationRequested 正常取消的逻辑。

我的问题是，如果我将 CancellationToken 传递到 Task.Run() 中，则会引发包含 TaskCanceledException 的 AggregateException。这会阻止任务正常取消。

为了解决这个问题，我无法将 CancelationToken 传递到 Task.Run 中，但是我不确定我会失去什么。例如，我喜欢这样的想法：如果我的任务挂起并且无法执行正常取消，则此异常将强制其停止。我想我可以串联两个 CancelationTokens 来处理这个问题，一个“优雅”，另一个“强制”。但是，我不喜欢这个解决方案。

这是一些代表我上面描述的内容的伪代码。

public async Task Main()
{
    CancellationTokenSource cts = new CancellationTokenSource();
    cts.CancelAfter(30000);
    await  this.Run(cts.Token);
}

public async Task Run(CancellationToken cancelationToken)
{
    HashSet<Task> tasks = new HashSet<Task>();
    foreach (var work in this.GetWorkNotPictured)
    {
        // Here is where I could pass the Token, 
        //   however If I do I cannot cancel gracefully
        //   My dilemma here is by not passing I lose the ability to force
        //   down the thread (via exception) if         
        //   it's hung for whatever reason
        tasks.Add(Task.Run(() => this.DoWork(work, cancelationToken))
    }

    await Task.WhenAll(tasks);

    // Clean up regardless of if we canceled
    this.CleanUpAfterWork();

    // It is now safe to throw as we have gracefully canceled
    cancelationToken.ThrowIfCancellationRequested();
}

public static void DoWork(work, cancelationToken)
{
    while (work.IsWorking)
    {
        if (cancelationToken.IsCancellationRequested)
          return // cancel gracefully
        work.DoNextWork();
    }
}

Answer 1

我建议您遵循抛出异常的标准取消模式，而不仅仅是返回：

public static void DoWork(work, cancellationToken)
{
  while (work.IsWorking)
  {
    cancellationToken.ThrowIfCancellationRequested();
    work.DoNextWork();
  }
}

如果你有清理工作要做，那就是finally（或者using，如果你可以这样重构的话）：

public async Task Run(CancellationToken cancellationToken)
{
  HashSet<Task> tasks = new HashSet<Task>();
  foreach (var work in this.GetWorkNotPictured)
  {
    tasks.Add(Task.Run(() => this.DoWork(work, cancellationToken))
  }

  try
  {
    await Task.WhenAll(tasks);
  }
  finally
  {
    this.CleanUpAfterWork();
  }
}