如何在 TPL 中处理任务取消

Question

再会！我正在为 WinForms UI 编写一个帮助程序库。开始使用 TPL async/await 机制并遇到这种代码示例的问题：

    private SynchronizationContext _context;

    public void UpdateUI(Action action)
    {
        _context.Post(delegate { action(); }, null);
    }


    private async void button2_Click(object sender, EventArgs e)
    {

        var taskAwait = 4000;
        var progressRefresh = 200;
        var cancellationSource = new System.Threading.CancellationTokenSource();

        await Task.Run(() => { UpdateUI(() => { button2.Text = "Processing..."; }); });

        Action usefulWork = () =>
        {
            try
            {
                Thread.Sleep(taskAwait);
                cancellationSource.Cancel();
            }
            catch { }
        };
        Action progressUpdate = () =>
        {
            int i = 0;
            while (i < 10)
            {
                UpdateUI(() => { button2.Text = "Processing " + i.ToString(); });
                Thread.Sleep(progressRefresh);
                i++;
            }
            cancellationSource.Cancel();
        };

        var usefulWorkTask = new Task(usefulWork, cancellationSource.Token);
        var progressUpdateTask = new Task(progressUpdate, cancellationSource.Token);

        try
        {
            cancellationSource.Token.ThrowIfCancellationRequested();
            Task tWork = Task.Factory.StartNew(usefulWork, cancellationSource.Token);
            Task tProgress = Task.Factory.StartNew(progressUpdate, cancellationSource.Token);
            await Task.Run(() =>
            {
                try
                {
                    var res = Task.WaitAny(new[] { tWork, tProgress }, cancellationSource.Token);                        
                }
                catch { }
            }).ConfigureAwait(false);
        }
        catch (Exception ex)
        {
        }
        await Task.Run(() => { UpdateUI(() => { button2.Text = "button2"; }); });
    }

基本上，这个想法是运行两个并行任务 - 例如，进度条或任何更新和一种超时控制器，另一个是长时间运行的任务本身。无论哪个任务先完成都会取消另一个任务。因此，取消“进度”任务应该没有问题，因为它有一个循环，我可以在其中检查任务是否标记为已取消。问题在于长期运行的。它可以是 Thread.Sleep() 或 SqlConnection.Open()。当我运行 CancellationSource.Cancel() 时，长时间运行的任务会继续工作并且不会取消。超时后，我对长时间运行的任务或任何可能导致的结果不感兴趣。
正如杂乱的代码示例所暗示的那样，我尝试了很多变体，但没有一个给我想要的效果。像 Task.WaitAny() 之类的东西会冻结 UI... 有没有办法使取消工作，或者甚至可能是对这些东西进行编码的不同方法？

更新：

public static class Taskhelpers
{
    public static async Task<T> WithCancellation<T>(this Task<T> task, CancellationToken cancellationToken)
    {
        var tcs = new TaskCompletionSource<bool>();
        using (cancellationToken.Register(s => ((TaskCompletionSource<bool>)s).TrySetResult(true), tcs))
        {
            if (task != await Task.WhenAny(task, tcs.Task))
                throw new OperationCanceledException(cancellationToken);
        }
        return await task;
    }
    public static async Task WithCancellation(this Task task, CancellationToken cancellationToken)
    {
        var tcs = new TaskCompletionSource<bool>();
        using (cancellationToken.Register(s => ((TaskCompletionSource<bool>)s).TrySetResult(true), tcs))
        {
            if (task != await Task.WhenAny(task, tcs.Task))
                throw new OperationCanceledException(cancellationToken);
        }
        await task;
    }
}

.....

        var taskAwait = 4000;
        var progressRefresh = 200;
        var cancellationSource = new System.Threading.CancellationTokenSource();
        var cancellationToken = cancellationSource.Token;

        var usefulWorkTask = Task.Run(async () =>
        {
            try
            {
                System.Diagnostics.Trace.WriteLine("WORK : started");

                await Task.Delay(taskAwait).WithCancellation(cancellationToken);

                System.Diagnostics.Trace.WriteLine("WORK : finished");
            }
            catch (OperationCanceledException) { }  // just drop out if got cancelled
            catch (Exception ex)
            {
                System.Diagnostics.Trace.WriteLine("WORK : unexpected error : " + ex.Message);
            }
        }, cancellationToken);

        var progressUpdatetask = Task.Run(async () =>
        {
            for (var i = 0; i < 25; i++)
            {
                if (!cancellationToken.IsCancellationRequested)
                {
                    System.Diagnostics.Trace.WriteLine("==== : " + i.ToString());
                    await Task.Delay(progressRefresh);
                }
            }
        },cancellationToken);

        await Task.WhenAny(usefulWorkTask, progressUpdatetask);

        cancellationSource.Cancel();

通过修改for (var i = 0; i < 25; i++)限制iI 模拟长时间运行的任务是否在进度任务之前完成或以其他方式完成。根据需要工作。该WithCancellation助手方法做这项工作，虽然两种类型的“嵌套”Task.WhenAny的样子可疑了。

Answer 1

我同意 Paulo 回答中的所有要点 - 即，使用现代解决方案（Task.Run而不是Task.Factory.StartNew,Progress<T>用于进度更新，而不是手动发布到SynchronizationContext,Task.WhenAny而不是Task.WaitAny异步代码）。

但要回答实际问题：

当我运行 CancellationSource.Cancel() 时，长时间运行的任务会继续工作并且不会取消。超时后，我对长时间运行的任务或任何可能导致的结果不感兴趣。

这有两个部分：

• 如何编写响应取消请求的代码？
• 如何编写在取消后忽略任何响应的代码？

请注意，第一部分处理取消操作，第二部分实际上处理取消等待操作完成。

第一件事：支持操作本身的取消。对于受 CPU 限制的代码（即运行循环），请定期调用token.ThrowIfCancellationRequested(). 对于 I/O 绑定代码，最好的选择是token向下传递到下一个 API 层 - 大多数（但不是全部）I/O API 可以（应该）获取取消令牌。如果这不是一个选项，那么您可以选择忽略取消，或者您可以使用 注册取消回调token.Register。有时您可以从Register回调中调用一个单独的取消方法，有时您可以通过从回调中处理对象来使其工作（这种方法通常有效，因为长期存在的 Win32 API 传统是取消句柄的所有 I/O当该手柄关闭时）。不过，我不确定这是否适用于SqlConnection.Open。

接下来，取消等待。如果您只是想因超时而取消等待，则此方法相对简单：

await Task.WhenAny(tWork, tProgress, Task.Delay(5000));