TaskCancellationException如何避免成功控制流上的异常

本文关键字:异常 控制流 成功 何避免 TaskCancellationException | 更新日期: 2023-09-27 18:26:46

在我们的应用程序中,我们经常使用async/await和Tasks。因此,它确实使用了Task.Run,有时使用内置的CancellationToken来取消支持。

public Task DoSomethingAsync(CancellationToken cancellationToken)
{
    return Task.Run(() =>
    {
        while (true)
        {
            if (cancellationToken.IsCancellationRequested) break;
            //do some work
        }
    }, cancellationToken);
}

如果我现在使用CancellationToken取消执行,那么执行将在下一个循环开始时停止,或者如果Task根本没有启动,它会抛出异常(Task.Run内部的TaskCanceledException)。现在的问题是,为什么Task.Run使用exception来控制成功取消,而不是只返回一个已完成的Task。MS没有坚持"不要使用异常来控制执行流"规则,有什么具体的原因吗?。

我如何才能避免在一个完全无用的try-catch(TaskCancelledException)块中对所有支持取消的方法(很多)进行装箱?

TaskCancellationException如何避免成功控制流上的异常

好吧,在您非常简单的场景中,您实际上并没有使用Task的结果,也不需要通过复杂的调用堆栈传播取消。

首先,您的Task可能会返回一个值。手术取消后你会返回什么?

其次,您取消的任务之后可能还有其他任务。您可能希望在方便的时候通过其他任务传播取消。

异常传播。在这种用法中,任务取消与Thread.Abort几乎相同——当你发布Thread.Abort时,ThreadAbortException用于确保你一直放松到顶部。否则,你的所有方法都必须检查他们调用的每个方法的结果,检查它们是否被取消,并在需要时返回它们自己——我们已经看到,人们会忽略老式C中的错误返回值:)

最后,任务取消,就像线程中止一样,是一种特殊的情况。它已经涉及同步,堆栈展开等

但是,这并不意味着您必须使用try-catch来捕获异常——您可以使用任务状态。例如,您可以使用这样的助手函数:

public static Task<T> DefaultIfCanceled<T>(this Task<T> @this, T defaultValue = default(T))
{
  return
    @this.ContinueWith
      (
        t =>
        {
          if (t.IsCanceled) return defaultValue;
          return t.Result;
        }
      );
}

可以用作

await SomeAsync().DefaultIfCanceled();

当然,需要注意的是,noöne是在强迫你使用这种取消方法——它只是为了方便。例如,您可以使用自己的放大类型来保存取消信息,并手动处理取消。但当你开始这样做时,你会发现使用异常处理取消的原因——在命令式代码中这样做是一件痛苦的事情,所以你要么浪费大量精力而没有收获,要么你会转向更实用的编程方式(来吧,我们有cookie!*)。

(*)免责声明:我们实际上没有cookie。但你可以自己做

抛出异常的目的正如社区中其他人已经指出的那样。

然而,如果你想对TaskCanceledException的行为有更多的控制权,并且仍然将逻辑隔离在一个地方,你可以实现一个扩展方法来扩展处理取消的Task,比如

  public async Task DoSomethingAsync(CancellationToken cancellationToken)
    {
        await Task.Run(() =>
        {
            while (true)
            {
                if (cancellationToken.IsCancellationRequested) break;
                //do some work
            }
        }).
        WithCancellation(cancellationToken,false); // pass the cancellation token to extension funciton instead to run
    }   

static class TaskCacellationHelper
{
    private struct Void { } // just to support TaskCompletionSource class.

    public static async Task WithCancellation(this Task originalTask,  CancellationToken ct, bool suppressCancellationExcetion)
    {
        // Create a Task that completes when the CancellationToken is canceled
        var cancelTask = new TaskCompletionSource<Void>();
        // When the CancellationToken is canceled, complete the Task
        using (ct.Register(
        t => ((TaskCompletionSource<Void>)t).TrySetResult(new Void()), cancelTask))
        {
            // Create a Task that completes when either the original or
            // CancellationToken Task completes
            Task any = await Task.WhenAny(originalTask, cancelTask.Task);
            // If any Task completes due to CancellationToken, throw OperationCanceledException
            if (any == cancelTask.Task)
            {
                //
                if (suppressCancellationExcetion == false)
                {
                    ct.ThrowIfCancellationRequested();
                }
                else
                {
                    Console.WriteLine("Cancelled but exception supressed");
                }
            }
        }
        // await original task. Incase of cancellation your logic will break the while loop            
        await originalTask;
    }
}