.NET 中让 Task 支持带超时的异步等待

Task 自带有很多等待任务完成的方法,有的是实例方法,有的是静态方法。有的阻塞,有的不阻塞。不过带超时的方法只有一个,但它是阻塞的。

本文将介绍一个非阻塞的带超时的等待方法。


Task 已有的等待方法

Task 实例已经有的等待方法有这些:

Task 实例的等待方法
▲ Task 实例的等待方法

一个支持取消,一个支持超时,再剩下的就是这两个的排列组合了。

但是 Task 实例的等待方法都有一个弊端,就是 阻塞。如果你真的试图去等待这个 Task,势必会占用一个宝贵的线程资源。所以通常不建议这么做。

另外,Task 还提供了静态的等待方法:

Task 静态的等待方法
▲ Task 静态的等待方法

Task.Wait 提供的功能几乎与 Task 实例的 Wait 方法是一样的,只是可以等待多个 Task 的实例。而 Task.When 则是真正的异步等待,不阻塞线程的,可以节省一个线程资源。

可是,依然只有 Task.Wait 这种阻塞的方法才有超时,Task.When 系列是没有的。

我们补充一个带超时的一步等待方法

Task 有一个 Delay 静态方法,我们是否可以利用这个方法来间接实现异步非阻塞的等待呢?

答案是可以的,我们有 Task.WhenAny 可以在多个任务的任何一个完成时结束。我们的思路是要么任务先完成,要么超时先完成。

于是我们可以先建一个新的 Task,即 Task.Delay(timeout),再比较这两个 Task 的执行先后:

public static async Task<TResult> WaitAsync<TResult>(Task<TResult> task, TimeSpan timeout)
{
    if (await Task.WhenAny(task, Task.Delay(timeout)) == task)
    {
        return await task;
    }
    throw new TimeoutException("The operation has timed out.");
}

考虑延时任务可以取消,于是我们可以使用 CancellationTokenSource

将这个方法封装成 Task 的扩展方法:

namespace Walterlv
{
    public static class TaskWaitingExtensions
    {
        public static async Task<TResult> WaitAsync<TResult>(this Task<TResult> task, TimeSpan timeout)
        {
            using (var timeoutCancellationTokenSource = new CancellationTokenSource())
            {
                var delayTask = Task.Delay(timeout, timeoutCancellationTokenSource.Token);
                if (await Task.WhenAny(task, delayTask) == task)
                {
                    timeoutCancellationTokenSource.Cancel();
                    return await task;
                }
                throw new TimeoutException("The operation has timed out.");
            }
        }
    }
}

于是我们就可以在任意的 Task 实例上调用 Task.WaitAsync 来获取带超时的等待了。


参考资料

本文会经常更新,请阅读原文: https://walterlv.com/post/task-wait-async-with-timeout.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

知识共享许可协议 本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但务必保留文章署名 吕毅 (包含链接: https://walterlv.com ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请 与我联系 (walter.lv@qq.com)