Task.Wait在OperationCanceledException的情况下出现意外行为

pro*_*man 10 .net c# wait task-parallel-library cancellation

考虑以下代码:

CancellationTokenSource cts0 = new CancellationTokenSource(), cts1 = new CancellationTokenSource();
try
{
    var task = Task.Run(() => { throw new OperationCanceledException("123", cts0.Token); }, cts1.Token);
    task.Wait();
}
catch (AggregateException ae) { Console.WriteLine(ae.InnerException); }
Run Code Online (Sandbox Code Playgroud)

由于MSDN任务应该是在Faulted状态,因为它的令牌不匹配异常的令牌(也IsCancellationRequested就是false):

如果令牌的IsCancellationRequested属性返回false,或者异常的令牌与Task的令牌不匹配,则OperationCanceledException被视为正常异常,导致Task转换到Faulted状态.

当我使用.NET 4.5.2在控制台应用程序中启动此代码时,我得到Canceled状态任务(聚合异常包含未知TaskCanceledExeption,而不是原始).并且原始异常的所有信息都将丢失(消息,内部异常,自定义数据).

我也注意到的这种行为Task.Wait不同于await task在以下情况下OperationCanceledException.

try { Task.Run(() => { throw new InvalidOperationException("123"); }).Wait(); } // 1
catch (AggregateException ae) { Console.WriteLine(ae.InnerException); }

try { await Task.Run(() => { throw new InvalidOperationException("123"); }); } // 2
catch (InvalidOperationException ex) { Console.WriteLine(ex); }

try { Task.Run(() => { throw new OperationCanceledException("123"); }).Wait(); } // 3 
catch (AggregateException ae) { Console.WriteLine(ae.InnerException); }

try { await Task.Run(() => { throw new OperationCanceledException("123"); }); } // 4
catch (OperationCanceledException ex) { Console.WriteLine(ex); }
Run Code Online (Sandbox Code Playgroud)

案例1和2产生几乎相同的结果(仅在不同的情况下StackTrace),但是当我更改异常时OperationCanceledException,我得到非常不同的结果:TaskCanceledException在3没有原始数据的情况下是未知的,并且OpeartionCanceledException在4所有原始数据(消息等)的情况下预期.

所以问题是:MSDN是否包含不正确的信息?或者它是.NET中的错误?或者也许只是我不懂东西?

Mat*_*ith 5

这是一个错误. Task.Run 引擎盖下的电话Task<Task>.Factory.StartNew.这个内部任务正在获得Faulted的正确状态.包装任务不是.

你可以通过调用解决这个bug

Task.Factory.StartNew(() => { throw new OperationCanceledException("123", cts0.Token); }, cts1.Token, TaskCreationOptions.DenyChildAttach, TaskScheduler.Default);
Run Code Online (Sandbox Code Playgroud)

但是,你将失去其他功能,Task.Run即展开.请参阅:
Task.Run与Task.Factory.StartNew

更多细节:

这里是Task.Run你看到它创建包装的代码UnwrapPromise(源自Task<TResult>:

public static Task Run(Func<Task> function, CancellationToken cancellationToken)
{
    // Check arguments
    if (function == null) throw new ArgumentNullException("function");
    Contract.EndContractBlock();

    cancellationToken.ThrowIfSourceDisposed();

    // Short-circuit if we are given a pre-canceled token
    if (cancellationToken.IsCancellationRequested)
        return Task.FromCancellation(cancellationToken);

    // Kick off initial Task, which will call the user-supplied function and yield a Task.
    Task<Task> task1 = Task<Task>.Factory.StartNew(function, cancellationToken, TaskCreationOptions.DenyChildAttach, TaskScheduler.Default);

    // Create a promise-style Task to be used as a proxy for the operation
    // Set lookForOce == true so that unwrap logic can be on the lookout for OCEs thrown as faults from task1, to support in-delegate cancellation.
    UnwrapPromise<VoidTaskResult> promise = new UnwrapPromise<VoidTaskResult>(task1, lookForOce: true);

    return promise;
}
Run Code Online (Sandbox Code Playgroud)

它调用的Task构造函数不接受取消令牌(因此它不知道内部Task的取消令牌).请注意,它会创建一个默认的CancellationToken.这是它所说的ctor:

internal Task(object state, TaskCreationOptions creationOptions, bool promiseStyle)
{
    Contract.Assert(promiseStyle, "Promise CTOR: promiseStyle was false");

    // Check the creationOptions. We only allow the AttachedToParent option to be specified for promise tasks.
    if ((creationOptions & ~TaskCreationOptions.AttachedToParent) != 0)
    {
        throw new ArgumentOutOfRangeException("creationOptions");
    }

    // m_parent is readonly, and so must be set in the constructor.
    // Only set a parent if AttachedToParent is specified.
    if ((creationOptions & TaskCreationOptions.AttachedToParent) != 0)
        m_parent = Task.InternalCurrent;

    TaskConstructorCore(null, state, default(CancellationToken), creationOptions, InternalTaskOptions.PromiseTask, null);
}
Run Code Online (Sandbox Code Playgroud)

外部任务(UnwrapPromise添加延续).继续审查内部任务.在内部任务出现故障的情况下,它考虑将OperationCanceledException作为指示取消(不管匹配的令牌).下面是UnwrapPromise<TResult>.TrySetFromTask(下面也是显示调用位置的调用堆栈).请注意Faulted状态:

private bool TrySetFromTask(Task task, bool lookForOce)
{
    Contract.Requires(task != null && task.IsCompleted, "TrySetFromTask: Expected task to have completed.");

    bool result = false;
    switch (task.Status)
    {
        case TaskStatus.Canceled:
            result = TrySetCanceled(task.CancellationToken, task.GetCancellationExceptionDispatchInfo());
            break;

        case TaskStatus.Faulted:
            var edis = task.GetExceptionDispatchInfos();
            ExceptionDispatchInfo oceEdi;
            OperationCanceledException oce;
            if (lookForOce && edis.Count > 0 &&
                (oceEdi = edis[0]) != null &&
                (oce = oceEdi.SourceException as OperationCanceledException) != null)
            {
                result = TrySetCanceled(oce.CancellationToken, oceEdi);
            }
            else
            {
                result = TrySetException(edis);
            }
            break;

        case TaskStatus.RanToCompletion:
            var taskTResult = task as Task<TResult>;
            result = TrySetResult(taskTResult != null ? taskTResult.Result : default(TResult));
            break;
    }
    return result;
}
Run Code Online (Sandbox Code Playgroud)

调用堆栈:

    mscorlib.dll!System.Threading.Tasks.Task<System.Threading.Tasks.VoidTaskResult>.TrySetCanceled(System.Threading.CancellationToken tokenToRecord, object cancellationException) Line 645 C#
    mscorlib.dll!System.Threading.Tasks.UnwrapPromise<System.Threading.Tasks.VoidTaskResult>.TrySetFromTask(System.Threading.Tasks.Task task, bool lookForOce) Line 6988 + 0x9f bytes   C#
    mscorlib.dll!System.Threading.Tasks.UnwrapPromise<System.Threading.Tasks.VoidTaskResult>.ProcessCompletedOuterTask(System.Threading.Tasks.Task task) Line 6956 + 0xe bytes  C#
    mscorlib.dll!System.Threading.Tasks.UnwrapPromise<System.Threading.Tasks.VoidTaskResult>.InvokeCore(System.Threading.Tasks.Task completingTask) Line 6910 + 0x7 bytes   C#
    mscorlib.dll!System.Threading.Tasks.UnwrapPromise<System.Threading.Tasks.VoidTaskResult>.Invoke(System.Threading.Tasks.Task completingTask) Line 6891 + 0x9 bytes   C#
    mscorlib.dll!System.Threading.Tasks.Task.FinishContinuations() Line 3571    C#
    mscorlib.dll!System.Threading.Tasks.Task.FinishStageThree() Line 2323 + 0x7 bytes   C#
    mscorlib.dll!System.Threading.Tasks.Task.FinishStageTwo() Line 2294 + 0x7 bytes C#
    mscorlib.dll!System.Threading.Tasks.Task.Finish(bool bUserDelegateExecuted) Line 2233   C#
    mscorlib.dll!System.Threading.Tasks.Task.ExecuteWithThreadLocal(ref System.Threading.Tasks.Task currentTaskSlot) Line 2785 + 0xc bytes  C#
    mscorlib.dll!System.Threading.Tasks.Task.ExecuteEntry(bool bPreventDoubleExecution) Line 2728   C#
    mscorlib.dll!System.Threading.Tasks.Task.System.Threading.IThreadPoolWorkItem.ExecuteWorkItem() Line 2664 + 0x7 bytes   C#
    mscorlib.dll!System.Threading.ThreadPoolWorkQueue.Dispatch() Line 829   C#
    mscorlib.dll!System.Threading._ThreadPoolWaitCallback.PerformWaitCallback() Line 1170 + 0x5 bytes   C#
Run Code Online (Sandbox Code Playgroud)

它注意到OperationCanceledException并调用TrySetCanceled将任务置于已取消状态.

旁边:

另外需要注意的是,当您开始使用async方法时,实际上没有办法使用方法注册取消令牌async.因此,在异步方法中遇到的任何 OperationCancelledException都被视为取消.请参阅 将CancellationToken与异步方法的任务相关联


pro*_*man 5

马特史密斯 - 谢谢你,你的解释非常有帮助.

阅读并测试一段时间后,我注意到原始问题并不完全正确.这不是问题Task.Wait.我可以得到这个错误的行为Task.ContinueWith,检查第一个任务Status- 它是Canceled.所以我相信最终的答案是:

如果使用带有或作为第一个参数的Task.Run重载创建任务,并且您的委托抛出,并且如果您使用或返回任务,那么由于.NET中的错误,您将丢失原始异常及其所有数据(正如Matt Smith解释的那样)并且无论匹配的文档逻辑如何,都将任务置于不正确的状态而不是.Func<Task>Func<Task<TResult>>OperationCanceledExceptionTask.WaitTask.ContinueWithCanceledFaulted

所有这些条件都很重要.如果你使用await创建的任务 - 它工作正常.如果你使用带有或作为第一个参数的Task.Run重载- 它在所有情况下都可以正常工作(Wait,ContinueWith,await).ActionFunc<TResult>

我还注意到重载方法选择逻辑的奇怪行为.当我写作

Task.Run(() => { throw new OperationCanceledException("123", cts0.Token); }, cts1.Token);
Run Code Online (Sandbox Code Playgroud)

我希望使用Task.Run(Action, CancellationToken)重载,这不会被打破.但不知何故,似乎使用了破碎Task.Run(Func<Task>, CancellationToken).所以我被迫做这样的事情

Task.Run((Action)(() => { throw new OperationCanceledException("123", cts0.Token); }), cts1.Token);
Run Code Online (Sandbox Code Playgroud)

或使用TaskFactory.StartNew.