操作已取消异常 VS 任务已取消任务时的异常

本文关键字:任务 取消 异常 操作 VS | 更新日期: 2023-09-27 18:27:29

以下代码创建一个正在取消的任务。 await表达式(大小写 1(抛出System.OperationCanceledException,而同步Wait()(大小写 2(抛出System.Threading.Tasks.TaskCanceledException(用 System.AggregateException 包装(。

using System;
using System.Threading;
using System.Threading.Tasks;
public class Program
{
    public static void Main()
    {
        Program.MainAsync().Wait();
    }
    private static async Task MainAsync()
    {
        using(var cancellationTokenSource = new CancellationTokenSource())
        {
            var token = cancellationTokenSource.Token;
            const int cancelationCheckTimeout = 100;
            var task = Task.Run(
                async () => 
                {
                    for (var i = 0; i < 100; i++)
                    {
                        token.ThrowIfCancellationRequested();
                        Console.Write(".");
                        await Task.Delay(cancelationCheckTimeout);  
                    }
                }, 
                cancellationTokenSource.Token
            );
            var cancelationDelay = 10 * cancelationCheckTimeout;
            cancellationTokenSource.CancelAfter(cancelationDelay);
            try
            {
                await task; // (1)
                //task.Wait(); // (2) 
            }
            catch(Exception ex)
            {
                Console.WriteLine(ex.ToString());
                Console.WriteLine($"Task.IsCanceled: {task.IsCanceled}");
                Console.WriteLine($"Task.IsFaulted: {task.IsFaulted}");
                Console.WriteLine($"Task.Exception: {((task.Exception == null) ? "null" : task.Exception.ToString())}");
            }
        }
    }
}

案例 1 输出:

..........System.OperationCanceledException: The operation was canceled.
   at System.Threading.CancellationToken.ThrowIfCancellationRequested()
   at Program.<>c__DisplayClass1_0.<<MainAsync>b__0>d.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at Program.<MainAsync>d__1.MoveNext()
Task.IsCanceled: True
Task.IsFaulted: False
Task.Exception: null

案例 2 输出:

..........System.AggregateException: One or more errors occurred. ---> System.Threading.Tasks.TaskCanceledException: A task was canceled.
   --- End of inner exception stack trace ---
   at System.Threading.Tasks.Task.Wait(Int32 millisecondsTimeout, CancellationToken cancellationToken)
   at System.Threading.Tasks.Task.Wait()
   at Program.<MainAsync>d__1.MoveNext()
---> (Inner Exception #0) System.Threading.Tasks.TaskCanceledException: A task was canceled.<---
Task.IsCanceled: True
Task.IsFaulted: False
Task.Exception: null

为什么第二种情况下System.AggregateException不包含System.OperationCanceledException作为内部例外?

我知道ThrowIfCancellationRequested()抛出OperationCanceledException,我们可以看到,在这两种情况下,Task都会进入取消(不是错误(状态。

这让我感到困惑,因为从 .NET API 取消方法在这两种情况下都会产生一致的行为 - 取消的任务只会抛出TaskCanceledException

using System;
using System.Threading;
using System.Threading.Tasks;
public class Program
{
    public static void Main()
    {
        Program.MainAsync().Wait();
    }
    private static async Task MainAsync()
    {
        using(var cancellationTokenSource = new CancellationTokenSource())
        {
            var token = cancellationTokenSource.Token;
            var task = Task.Delay(1000, token);
            cancellationTokenSource.CancelAfter(100);
            try
            {
                await task; // (1)
                //task.Wait(); // (2)
            }
            catch(Exception ex)
            {
                Console.WriteLine(ex.ToString());
                Console.WriteLine($"Task.IsCanceled: {task.IsCanceled}");
                Console.WriteLine($"Task.IsFaulted: {task.IsFaulted}");
                Console.WriteLine($"Task.Exception: {((task.Exception == null) ? "null" : task.Exception.ToString())}");
            }
        }
    }
}

案例 1 输出:

System.Threading.Tasks.TaskCanceledException: A task was canceled.
   at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at Program.<MainAsync>d__1.MoveNext()
Task.IsCanceled: True
Task.IsFaulted: False
Task.Exception: null

案例 2 输出:

System.AggregateException: One or more errors occurred. ---> System.Threading.Tasks.TaskCanceledException: A task was canceled.
   --- End of inner exception stack trace ---
   at System.Threading.Tasks.Task.Wait(Int32 millisecondsTimeout, CancellationToken cancellationToken)
   at System.Threading.Tasks.Task.Wait()
   at Program.<MainAsync>d__1.MoveNext()
---> (Inner Exception #0) System.Threading.Tasks.TaskCanceledException: A task was canceled.<---
Task.IsCanceled: True
Task.IsFaulted: False
Task.Exception: null

操作已取消异常 VS 任务已取消任务时的异常

这里的区别来自于使用token.ThrowIfCancellationRequested()。此方法检查取消,如果请求,则专门抛出OperationCanceledException而不是TaskCanceledException(可以理解,因为CancellationToken不是 TPL 独有的(。您可以查看引用源,并看到它调用了此方法:

private void ThrowOperationCanceledException()
{
    throw new OperationCanceledException(Environment.GetResourceString("OperationCanceled"), this);
}

"常规"取消确实会产生TaskCanceledException。通过在任务有机会开始运行之前取消令牌,您可以看到这一点:

cancellationTokenSource.Cancel();
var task = Task.Run(() => { }, cancellationTokenSource.Token);
try
{
    await task; 
}
catch (Exception ex)
{
    Console.WriteLine(ex.ToString());
    Console.WriteLine($"Task.IsCanceled: {task.IsCanceled}");
    Console.WriteLine($"Task.IsFaulted: {task.IsFaulted}");
    Console.WriteLine($"Task.Exception: {((task.Exception == null) ? "null" : task.Exception.ToString())}");
}

输出:

System.Threading.Tasks.TaskCanceledException: A task was canceled.
   at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at System.Runtime.CompilerServices.TaskAwaiter.GetResult()
   at Sandbox.Program.<MainAsync>d__1.MoveNext()
Task.IsCanceled: True
Task.IsFaulted: False
Task.Exception: null

传统的 .Net 方法通常不会将CancellationToken.ThrowIfCancellationRequested用于异步 API,因为这仅适用于将工作卸载到另一个线程的情况。这些方法用于固有的异步操作,因此使用 CancellationToken.Register(或内部InternalRegisterWithoutEC(监视取消。

TaskCanceledException继承自OperationCanceledException .所以它至少有一点连续性。

if( ex is OperationCanceledException)
{
...
}