如何为 Task 添加超时功能（3）：Task.WaitAsync

前言

在前面的文章中，我们实现了《为 Task 添加超时功能》。

而在 .NET 6 中，提供了一个新方法——Task.WaitAsync，可用于等待任务完成或超时：

var data = await GetFromCache().WaitAsync(TimeSpan.FromMilliseconds(milliseconds));

Task.WaitAsync方法提供了多个重载：

方法	说明
WaitAsync(TimeSpan, CancellationToken)	获取一个， Task 它将在此 Task 完成时、指定的超时过期时或当指定的 CancellationToken 取消请求时完成。
WaitAsync(TimeSpan)	获取在 Task 此 Task 完成或指定的超时过期时将完成的。
WaitAsync(CancellationToken)	获取一个 Task ，它将在此 Task 完成或指定的 CancellationToken 取消请求取消时完成。

那让我们来看看，官方实现和我们的实现方式到底有何区别。

原理

找到 WaitAsync方法的源代码：

public Task WaitAsync(TimeSpan timeout) => WaitAsync(ValidateTimeout(timeout, ExceptionArgument.timeout), default);

private Task WaitAsync(uint millisecondsTimeout, CancellationToken cancellationToken)
{
    ...

    return new CancellationPromise<VoidTaskResult>(this, millisecondsTimeout, cancellationToken);
}

WaitAsync方法实际创建了一个CancellationPromise<VoidTaskResult>对象:

/// <summary>Task that's completed when another task, timeout, or cancellation token triggers.</summary>
private protected sealed class CancellationPromise<TResult> : Task<TResult>, ITaskCompletionAction
{
   ...

   internal CancellationPromise(Task source, uint millisecondsDelay, CancellationToken token)
   {
       ...

       // Register with a timer if it's needed.
       if (millisecondsDelay != Timeout.UnsignedInfinite)
       {
           _timer = new TimerQueueTimer(static state =>
           {
               var thisRef = (CancellationPromise<TResult>)state!;
               if (thisRef.TrySetException(new TimeoutException()))
               {
                   thisRef.Cleanup();
               }
           }, this, millisecondsDelay, Timeout.UnsignedInfinite, flowExecutionContext: false);
       }

       ...
   }
   
   ...
}

如果设置了超时时间，它会创建一个Timer，在超时时间截止时触发，抛出TimeoutException。

运行验证一下，确实如此：

结论

官方实现的超时功能会抛出异常，而我们自己的实现是返回默认值，无需try-catch。

你更喜欢使用哪种形式，欢迎留言讨论！

技术群：添加小编微信并备注进群

小编微信：mm1552923   

公众号：dotNet编程大全